Skip to main content
POST
/
t
/
v1
/
update-work-order
{
  "workOrderId": "<string>",
  "createdAt": "<string>",
  "workOrderBlueprintId": "<string>",
  "jobId": "<string>",
  "trainId": "<string>",
  "trainConsistId": "<string>",
  "initialTrainConsistId": "<string>",
  "lostTrainConsistId": "<string>",
  "status": "PENDING",
  "attributes": {},
  "inTransit": true,
  "readyToDepart": true,
  "customerLocationId": "<string>",
  "servingLocationId": "<string>",
  "lastEventId": "<string>",
  "originCustomerLocationId": "<string>",
  "originServingLocationId": "<string>",
  "destinationCustomerLocationId": "<string>",
  "destinationServingLocationId": "<string>",
  "designatedDate": "2023-11-07T05:31:56Z",
  "touchedBy": {},
  "job": {
    "jobId": "<string>",
    "name": "<string>",
    "type": "<string>",
    "attributesDefault": {},
    "templatizedName": "<string>",
    "trainSetDisabled": true,
    "minNumOfLocos": 123,
    "minNumOfEots": 123,
    "requireLocoSetoutBeforeComplete": true,
    "isAvailableToAdvance": true,
    "isAvailableToDeliver": true,
    "isAvailableToInterchange": true,
    "isAvailableToMove": true,
    "isAvailableToClassify": true
  },
  "blueprint": {
    "workOrderBlueprintId": "<string>",
    "jobId": "<string>",
    "name": "<string>",
    "workDefinitionIds": [
      "<string>"
    ],
    "schedule": "<string>",
    "originCustomerLocationId": "<string>",
    "originServingLocationId": "<string>",
    "destinationCustomerLocationId": "<string>",
    "destinationServingLocationId": "<string>",
    "useTrainFunction": true,
    "enableLocalTrainMode": true,
    "attributesDefault": {},
    "job": {
      "jobId": "<string>",
      "name": "<string>",
      "type": "<string>",
      "attributesDefault": {},
      "templatizedName": "<string>",
      "trainSetDisabled": true,
      "minNumOfLocos": 123,
      "minNumOfEots": 123,
      "requireLocoSetoutBeforeComplete": true,
      "isAvailableToAdvance": true,
      "isAvailableToDeliver": true,
      "isAvailableToInterchange": true,
      "isAvailableToMove": true,
      "isAvailableToClassify": true
    },
    "workDefinitions": [
      {
        "workDefinitionId": "<string>",
        "name": "<string>",
        "setoutFilter": {
          "intersectedGroupFilters": [
            {
              "groupingIdFilter": {
                "groupingIds": "<any>",
                "groupingType": "<any>",
                "leafGroupingType": "<any>"
              },
              "groupingNameFilter": {
                "names": "<any>",
                "groupingType": "<any>",
                "leafGroupingType": "<any>"
              }
            }
          ],
          "wantDateDaysFromNow": 123,
          "timeFilter": {
            "isAnd": true,
            "timeFilters": [
              {
                "relativeTimeFilter": "<any>",
                "absoluteTimeFilter": "<any>",
                "nestedTimeFilter": "<any>",
                "dwellFilter": "<any>"
              }
            ]
          },
          "wantDateOffsetStart": 123,
          "wantDateOffsetEnd": 123,
          "priority": 123,
          "departureTrainId": "<string>"
        },
        "pickupFilter": {
          "intersectedGroupFilters": [
            {
              "groupingIdFilter": {
                "groupingIds": "<any>",
                "groupingType": "<any>",
                "leafGroupingType": "<any>"
              },
              "groupingNameFilter": {
                "names": "<any>",
                "groupingType": "<any>",
                "leafGroupingType": "<any>"
              }
            }
          ],
          "wantDateDaysFromNow": 123,
          "timeFilter": {
            "isAnd": true,
            "timeFilters": [
              {
                "relativeTimeFilter": "<any>",
                "absoluteTimeFilter": "<any>",
                "nestedTimeFilter": "<any>",
                "dwellFilter": "<any>"
              }
            ]
          },
          "wantDateOffsetStart": 123,
          "wantDateOffsetEnd": 123,
          "priority": 123,
          "departureTrainId": "<string>"
        },
        "customerLocationId": "<string>",
        "servingLocationId": "<string>",
        "isPickupAndSetout": true,
        "futureCustomerLocationId": "<string>",
        "futureServingLocationId": "<string>"
      }
    ]
  },
  "crews": [
    {
      "crewId": "<string>",
      "firstName": "<string>",
      "middleName": "<string>",
      "lastName": "<string>",
      "role": "<string>",
      "picture": "aSDinaTvuI8gbWludGxpZnk=",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z",
      "touchedByUser": {
        "userId": 123,
        "userUuid": "<string>",
        "displayName": "<string>",
        "email": "<string>"
      },
      "user": {
        "userId": 123,
        "userUuid": "<string>",
        "displayName": "<string>",
        "email": "<string>"
      }
    }
  ],
  "tasks": [
    {
      "taskId": "<string>",
      "pairedTaskId": "<string>",
      "equipmentId": "<string>",
      "workOrderId": "<string>",
      "taskIndex": 123,
      "isForInitialConsist": true,
      "taskType": "PICKUP",
      "status": "NOT_STARTED",
      "customerLocationId": "<string>",
      "servingLocationId": "<string>",
      "switchRequest": {
        "switchRequestId": "<string>",
        "equipmentId": "<string>",
        "requestType": "SWITCH_REQUEST_TYPE_UNSPECIFIED",
        "requestTypeV2": "<string>",
        "trackId": "<string>",
        "spotId": "<string>",
        "wantDate": "<string>",
        "etaTime": "2023-11-07T05:31:56Z",
        "spotName": "<string>",
        "customerId": "<string>",
        "externalFulfillingParty": "<string>",
        "batchId": "<string>",
        "notes": "<string>",
        "status": "<string>",
        "externalStatus": "<string>",
        "equipment": {
          "equipmentId": 123,
          "equipmentInitial": "<string>",
          "equipmentNumber": "<string>",
          "location": {
            "track": {
              "trackId": "<string>",
              "name": "<string>"
            },
            "index": 123
          },
          "waybill": {
            "waybillId": 123,
            "parties": [
              {
                "partyType": "PARTY_ENTITY_IDENTIFIER_CODE_UNSPECIFIED",
                "name": "<string>"
              }
            ],
            "equipmentDetails": [
              {
                "equipmentInitial": "<string>",
                "equipmentNumber": "<string>",
                "tareWeightLbs": 123,
                "netWeightLbs": 123,
                "grossWeightLbs": 123,
                "weightType": "WT_ESTIMATED",
                "sealNumbers": [
                  "<string>"
                ]
              }
            ],
            "lineItems": [
              {
                "number": 123,
                "descriptions": [
                  {
                    "ladingDescription": "<string>",
                    "commodityCode": "<string>",
                    "commodityCodeQualifier": "CCQ_UNKNOWN"
                  }
                ],
                "quantity": {
                  "weight": 123,
                  "weightQualifier": "WQ_UNKNOWN"
                }
              }
            ],
            "referenceIds": [
              {
                "referenceIdQualifier": "<string>",
                "referenceId": "<string>",
                "description": "<string>",
                "referenceTimestamp": "2023-11-07T05:31:56Z"
              }
            ],
            "waybillDate": "2023-11-07T05:31:56Z"
          },
          "arrivalState": "AS_INBOUND",
          "loadStatus": "<string>",
          "verificationKey": "<string>",
          "groupings": [
            {
              "groupingId": "<string>",
              "groupingType": "<string>",
              "name": "<string>",
              "sortOrder": 123,
              "equipmentIndexEnabled": true,
              "customerLocation": {
                "customerLocationId": "<string>",
                "customerLocationUuid": "<string>",
                "name": "<string>",
                "blockCode": "<string>",
                "customerIdentificationNumbers": [
                  "<any>"
                ],
                "generalLedgerNumber": "<string>",
                "address": {},
                "email": "<string>",
                "phoneNumber": "<string>",
                "abbreviatedName": "<string>",
                "usedForBilling": true,
                "isDefault": true,
                "isReportingLocation": true,
                "currencyCode": "<string>",
                "customer": {}
              },
              "attributes": {},
              "frozen": true,
              "status": "ACTIVE"
            }
          ],
          "verificationKeys": [
            {
              "key": "<string>",
              "compartment": 123
            }
          ],
          "equipmentUuid": "<string>",
          "parentGroupings": [
            {
              "grouping": {
                "groupingId": "<string>",
                "groupingType": "<string>",
                "name": "<string>",
                "sortOrder": 123,
                "equipmentIndexEnabled": true,
                "customerLocation": {
                  "customerLocationId": "<string>",
                  "customerLocationUuid": "<string>",
                  "name": "<string>",
                  "blockCode": "<string>",
                  "customerIdentificationNumbers": [
                    "<any>"
                  ],
                  "generalLedgerNumber": "<string>",
                  "address": {},
                  "email": "<string>",
                  "phoneNumber": "<string>",
                  "abbreviatedName": "<string>",
                  "usedForBilling": true,
                  "isDefault": true,
                  "isReportingLocation": true,
                  "currencyCode": "<string>",
                  "customer": {}
                },
                "attributes": {},
                "frozen": true,
                "status": "ACTIVE"
              },
              "groupingIndex": 123,
              "attributes": {}
            }
          ]
        },
        "track": {
          "groupingId": "<string>",
          "groupingType": "<string>",
          "name": "<string>",
          "sortOrder": 123,
          "equipmentIndexEnabled": true,
          "customerLocation": {
            "customerLocationId": "<string>",
            "customerLocationUuid": "<string>",
            "name": "<string>",
            "blockCode": "<string>",
            "customerIdentificationNumbers": [
              "<any>"
            ],
            "generalLedgerNumber": "<string>",
            "address": {},
            "email": "<string>",
            "phoneNumber": "<string>",
            "abbreviatedName": "<string>",
            "usedForBilling": true,
            "isDefault": true,
            "isReportingLocation": true,
            "currencyCode": "<string>",
            "customer": {}
          },
          "attributes": {},
          "frozen": true,
          "status": "ACTIVE"
        },
        "touchedBy": {},
        "deletedBy": {},
        "createdAt": "2023-11-07T05:31:56Z",
        "completedAt": "2023-11-07T05:31:56Z",
        "touchedAt": "2023-11-07T05:31:56Z"
      },
      "assignedLocation": {
        "trackId": "<string>",
        "trackName": "<string>",
        "spotName": "<string>"
      },
      "exception": "<string>",
      "touchedBy": {},
      "workDefinitionId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
x-arms-api-key
string
header
required

Your ARMS API key

​
x-arms-assume-user
string
header
required

Email of a user assigned to the appropriate user group

Headers

​
Carrier
integer
required

Carrier identifier; required for all endpoints

Body

application/json
​
workOrderId
string
​
equipmentIds
string[]

List of equipment UUIDs used to update consist.

​
initialEquipmentIds
string[]

List of equipment UUIDs used tp update initial consist.

​
trainId
string

Train identifier to assign to the work order.

​
crewIds
string[]

List of crew member IDs to assign to the work order.

​
taskUpdates
object[]

List of task updates to apply to the work order.

​
taskUpdateLocationMasks
object[]

Location masks for updating task locations.

​
attributes
object
​
status
enum<string>
default:PENDING
Available options:
PENDING,
ACTIVE,
CLOSED
​
forceClose
boolean

Whether to force close the work order.

​
readyToDepart
boolean

Whether the work order is ready to depart.

​
customerLocationId
string<int64>

Customer location ID for the work order.

​
servingLocationId
string<int64>

Serving location ID for the work order.

​
designatedDate
string<date-time>

Designated date for the work order.

​
taskExceptionUpdates
object[]

Updates to task exceptions.

​
updateMask
string

Field mask specifying which fields to update.

Response

A successful response.

​
workOrderId
string
​
createdAt
string
​
workOrderBlueprintId
string
​
jobId
string
​
trainId
string
​
trainConsistId
string
​
initialTrainConsistId
string
​
lostTrainConsistId
string
​
status
enum<string>
default:PENDING
Available options:
PENDING,
ACTIVE,
CLOSED
​
attributes
object
​
inTransit
boolean
​
readyToDepart
boolean
​
customerLocationId
string<int64>
​
servingLocationId
string<int64>
​
lastEventId
string<int64>
​
originCustomerLocationId
string<int64>
​
originServingLocationId
string<int64>
​
destinationCustomerLocationId
string<int64>
​
destinationServingLocationId
string<int64>
​
designatedDate
string<date-time>
​
touchedBy
object
​
job
object
​
blueprint
object
​
crews
object[]
​
tasks
object[]
⌘I