Skip to main content
POST
/
ims
/
work-orders
/
class-lists
/
tasks
curl --request POST \
  --url https://api-lg.arms.cedarai.com/ims/work-orders/class-lists/tasks \
  --header 'Content-Type: application/json' \
  --header 'x-arms-api-key: <api-key>' \
  --header 'x-arms-assume-user: <api-key>' \
  --data '
{
  "carrierId": 1234,
  "pageSize": 20
}
'
{
  "tasks": [
    {
      "resourceType": "Task",
      "resourceId": 123,
      "uuid": "<string>",
      "carrier": {
        "resourceType": "Carrier",
        "resourceId": 123,
        "uuid": "<string>",
        "carrierCode": "<string>",
        "name": "<string>"
      },
      "equipment": {
        "resourceType": "Equipment",
        "resourceId": 123,
        "uuid": "<string>",
        "equipmentInitial": "<string>",
        "equipmentNumber": 123
      },
      "equipmentId": 123,
      "taskType": "SWITCH",
      "status": "NOT_STARTED",
      "currentTrack": {
        "resourceType": "Grouping",
        "resourceId": 123,
        "uuid": "<string>",
        "name": "<string>",
        "groupingType": "<string>",
        "sortOrder": 123,
        "colorToken": "<string>"
      },
      "assignedTrack": {
        "resourceType": "Grouping",
        "resourceId": 123,
        "uuid": "<string>",
        "name": "<string>",
        "groupingType": "<string>",
        "sortOrder": 123,
        "colorToken": "<string>"
      },
      "assignedSpot": {
        "resourceType": "Spot",
        "resourceId": 123,
        "uuid": "<string>",
        "name": "<string>"
      },
      "finalTrack": {
        "resourceType": "Grouping",
        "resourceId": 123,
        "uuid": "<string>",
        "name": "<string>",
        "groupingType": "<string>",
        "sortOrder": 123,
        "colorToken": "<string>"
      },
      "finalSpot": {
        "resourceType": "Spot",
        "resourceId": 123,
        "uuid": "<string>",
        "name": "<string>"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "completedAt": "2023-11-07T05:31:56Z",
      "customer": {
        "resourceType": "Customer",
        "resourceId": 123,
        "uuid": "<string>",
        "name": "<string>"
      }
    }
  ],
  "statusCode": 123,
  "nextToken": "<string>",
  "prevToken": "<string>"
}

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.

​
workOrderId
integer

Class list (work order) ID to filter tasks by

​
customerName
string

Filter by customer name

​
equipmentName
string

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

​
equipmentIds
integer[]

Filter by specific equipment resource IDs

​
taskIds
integer[]

Filter by specific task resource IDs

​
status
enum<string>[]

Filter by task status

Available options:
NOT_STARTED,
COMPLETED,
CANCELED
​
assignedTrackName
string

Filter by assigned track name

​
finalTrackName
string

Filter by final track name

​
currentTrackName
string

Filter by current track name

​
carrierDateRange
object

Date range assumed to be in the carrier timezone

Response

OK

​
tasks
object[]
required

List of tasks 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