Skip to main content
POST
/
t
/
v1
/
list-work-orders
{
  "results": [
    {
      "work_order_id": "12345",
      "train_id": "Train 123",
      "status": "ACTIVE",
      "equipment_ids": [
        "uuid_car1",
        "uuid_car2"
      ],
      "crew_ids": [
        "crew1",
        "crew2"
      ],
      "designated_date": "2024-01-15T00:00:00.000Z"
    },
    {
      "work_order_id": "6789",
      "train_id": "Train 456",
      "status": "PENDING",
      "equipment_ids": [
        "uuid_car3"
      ],
      "crew_ids": [
        "crew3"
      ],
      "designated_date": "2024-01-16T00:00:00.000Z"
    }
  ],
  "next_token": "eyJwYWdlIjogMiwgImxhc3RfaWQiOiAiMTIzNDYifQ==",
  "prev_token": ""
}

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

Request message for listing work orders with optional filtering and pagination. Used to search and retrieve work orders based on various criteria such as status, equipment, locations, and dates.

​
statuses
enum<string>[]
​
workOrderIds
string[]

Optional list of work order ids to fetch. When provided these are the only work orders returned.

​
equipmentName
string
​
name
string
​
attributes
object
​
includeTasks
boolean

Whether to include task details in the response.

​
designatedDateRange
object
​
originLocationIds
string[]
​
destinationLocationIds
string[]
​
customerLocationIds
string[]
​
servingLocationIds
string[]
​
pageSize
integer
​
pagePreviousToken
string
​
pageNextToken
string

Response

A successful response.

​
results
object[]
​
nextToken
string
​
prevToken
string
⌘I