Skip to main content
POST
Update a Work Order

Authorizations

x-arms-api-key
string
header
required
x-arms-assume-user
string
header
required

Headers

Carrier
string
required

Carrier ID

Body

application/json
attributes
object
crewIds
string[]

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

customerLocationId
string<int64>

Customer location ID for the work order.

designatedDate
string<date-time>

Designated date for the work order.

equipmentIds
string[]

List of equipment UUIDs used to update consist.

forceClose
boolean

Whether to force close the work order.

initialEquipmentIds
string[]

List of equipment UUIDs used tp update initial consist.

readyToDepart
boolean

Whether the work order is ready to depart.

servingLocationId
string<int64>

Serving location ID for the work order.

status
enum<string>
default:PENDING
Available options:
PENDING,
ACTIVE,
CLOSED,
CANCELLED
taskExceptionUpdates
object[]

Updates to task exceptions.

taskUpdateLocationMasks
object[]

Location masks for updating task locations.

taskUpdates
object[]

List of task updates to apply to the work order.

trainId
string

Train identifier to assign to the work order.

updateMask
string

Field mask specifying which fields to update.

workOrderId
string

Response

A successful response.

attributes
object
autoCompleteTasks
boolean
blueprint
object
createdAt
string
crews
object[]
customerLocationId
string<int64>
departureHeading
number<double>
departureLocoConsistIndex
integer<int32>
designatedDate
string<date-time>
destinationCustomerLocationId
string<int64>
destinationServingLocationId
string<int64>
inTransit
boolean
initialTrainConsistId
string
job
object
jobId
string
lastEventId
string<int64>
latestTrainEventId
string<int64>
lostTrainConsistId
string
originCustomerLocationId
string<int64>
originServingLocationId
string<int64>
readyToDepart
boolean
scheduledStops
object[]
servingLocationId
string<int64>
status
enum<string>
default:PENDING
Available options:
PENDING,
ACTIVE,
CLOSED,
CANCELLED
tasks
object[]
touchedBy
object
trainConsistId
string
trainId
string
workOrderBlueprintId
string
workOrderId
string