Skip to main content
POST
/
ims
/
work-orders
/
class-lists
curl --request POST \
  --url https://api-lg.arms.cedarai.com/ims/work-orders/class-lists \
  --header 'Content-Type: application/json' \
  --header 'x-arms-api-key: <api-key>' \
  --header 'x-arms-assume-user: <api-key>' \
  --data '
{
  "carrierId": 1234,
  "pageSize": 20
}
'
{
  "classLists": [
    {
      "resourceId": 123,
      "uuid": "<string>",
      "jobId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "cuts": [
        123
      ],
      "isBack": true,
      "carrier": {
        "resourceId": 123,
        "uuid": "<string>",
        "carrierCode": "<string>",
        "name": "<string>"
      },
      "createdBy": {
        "resourceId": 123,
        "uuid": "<string>",
        "displayName": "<string>",
        "email": "jsmith@example.com"
      }
    }
  ],
  "statusCode": 123,
  "nextToken": "<string>",
  "prevToken": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.cedarai.com/llms.txt

Use this file to discover all available pages before exploring further.

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

Query Parameters

​
carrierId
integer
required

Carrier identifier; required for all endpoints

​
viewAsUserGroup
string

Optional user group context

Body

application/json
​
carrierId
integer
required

Carrier identifier. May also be supplied via query parameter.

​
pageSize
integer

Number of items per page. Use with pageNextToken/pagePrevToken for pagination.

Required range: x >= 1
​
pageNextToken
string

Token to fetch the next page of results returned from a previous call.

​
pagePrevToken
string

Token to fetch the previous page of results returned from a previous call.

​
jobId
string

Filter by job ID (user-specified label for the class list)

​
status
enum<string>[]

Filter by class list status

Available options:
ACTIVE,
ARCHIVED
​
workOrderIds
integer[]

Filter by specific class list resource IDs

​
customerName
string

Filter by customer name

​
carrierDateRange
object

Date range assumed to be in the carrier timezone

​
equipmentName
string

Filter by equipment initial and number (e.g., 'XYZ 123456')

​
originalTrackName
string

Filter by original track name

​
finalTrackName
string

Filter by final track name

​
assignedTrackName
string

Filter by assigned track name

​
parentStationName
string

Filter by parent station name

​
parentStationId
string<uuid>

Filter by parent station grouping ID (UUID from the network hierarchy API)

Response

OK

​
classLists
object[]
required

List of class lists matching the filter criteria

​
statusCode
integer
required
​
nextToken
string

Token to fetch the next page of results

​
prevToken
string

Token to fetch the previous page of results