Skip to main content
POST
Create a class list

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

Input for creating a class list (switch list).

carrierId
integer
required

Carrier identifier

jobId
string
required

The job ID for the class list

items
object[]
required

The list of equipment moves to include in the class list

Response

OK

A class list (switch list) represents a work order for switching operations.

resourceId
integer
uuid
string

UUID that complements the legacy numeric resourceId.

jobId
string

User-specified label for the class list

status
enum<string>

Status of the class list

Available options:
ACTIVE,
ARCHIVED
createdAt
string<date-time>

When the class list was created

cuts
integer[]

Cut positions in the class list

isBack
boolean

True if switching from the back of the track

carrier
object
createdBy
object