Skip to main content
POST
/
t
/
v1
/
resequence-train
{}

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 resequencing a train's consist order. Used when the actual train consist order differs from the planned order, such as after an EDI scanner detects changes.

workOrderId
string
required
trainConsistEquipmentUuids
string[]
required

Ordered list of equipment UUIDs representing the new consist sequence of the train.

autoSetoutPickup
boolean
required

Whether to automatically pickup new cars being added to consist and setout cars being removed from consist.

exception
string

Optional exception message that will be set on any Pickup requests that come from the resequence.

lostTrackId
string<int64>

Track ID where lost equipment should be placed if detected during resequencing.

ignoreCarsWithCompletedSetout
boolean

Whether to ignore cars that have a completed setout task when resequencing.These cars will be removed from the consist.

Response

A successful response.

The response is of type object.

I