Skip to main content
POST
/
t
/
v1
/
list-work-orders
List Work Orders
curl --request POST \
  --url https://api-lg-k-h1.arms.cedarai.com/t/v1/list-work-orders \
  --header 'Carrier: <carrier>' \
  --header 'Content-Type: application/json' \
  --header 'x-arms-api-key: <api-key>' \
  --header 'x-arms-assume-user: <api-key>' \
  --data '
{
  "attributes": {
    "priority": "high",
    "shift": "day"
  },
  "customer_location_ids": [
    "33333"
  ],
  "designated_date_range": {
    "end": "2024-01-31T23:59:59Z",
    "start": "2024-01-01T00:00:00Z"
  },
  "destination_location_ids": [
    "22222"
  ],
  "equipment_name": "BNSF 123456",
  "include_tasks": true,
  "name": "Daily Switch Job",
  "origin_location_ids": [
    "11111"
  ],
  "page_next_token": "eyJwYWdlIjogMiwgImxhc3RfaWQiOiAiMTIzNDUifQ==",
  "page_size": 50,
  "serving_location_ids": [
    "44444"
  ],
  "statuses": [
    "ACTIVE",
    "PENDING"
  ],
  "work_order_ids": [
    "12345",
    "67890"
  ]
}
'
{
  "next_token": "eyJwYWdlIjogMiwgImxhc3RfaWQiOiAiMTIzNDYifQ==",
  "prev_token": "",
  "results": [
    {
      "crew_ids": [
        "crew1",
        "crew2"
      ],
      "designated_date": "2024-01-15T00:00:00Z",
      "equipment_ids": [
        "uuid_car1",
        "uuid_car2"
      ],
      "status": "ACTIVE",
      "train_id": "Train 123",
      "work_order_id": "12345"
    },
    {
      "crew_ids": [
        "crew3"
      ],
      "designated_date": "2024-01-16T00:00:00Z",
      "equipment_ids": [
        "uuid_car3"
      ],
      "status": "PENDING",
      "train_id": "Train 456",
      "work_order_id": "6789"
    }
  ]
}

Authorizations

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

Headers

​
Carrier
string
required

Carrier ID

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.

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.

​
attributes
object
​
customerLocationIds
string[]
​
designatedDateRange
object
​
destinationLocationIds
string[]
​
directionFilter
enum<string>
default:WORK_ORDER_DIRECTION_FILTER_UNSPECIFIED
Available options:
WORK_ORDER_DIRECTION_FILTER_UNSPECIFIED,
WORK_ORDER_DIRECTION_FILTER_INBOUND,
WORK_ORDER_DIRECTION_FILTER_OUTBOUND
​
equipmentName
string
​
inTransit
boolean
​
includeScheduledStops
boolean

Whether to include scheduled stop arrival/departure times, activity codes, and cancellation info in the response.

​
includeTasks
boolean

Whether to include task details in the response.

​
name
string
​
originLocationIds
string[]
​
pageNextToken
string
​
pagePreviousToken
string
​
pageSize
integer<int64>
​
servingLocationIds
string[]
​
statuses
enum<string>[]
Available options:
PENDING,
ACTIVE,
CLOSED,
CANCELLED
​
taskLocationIds
string[]
​
workOrderIds
string[]

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

Response

A successful response.

​
nextToken
string
​
prevToken
string
​
results
object[]