Skip to main content
POST
/
t
/
v1
/
resequence-train
Resequence a train
curl --request POST \
  --url https://api-lg-k-h1.arms.cedarai.com/t/v1/resequence-train \
  --header 'Carrier: <carrier>' \
  --header 'Content-Type: application/json' \
  --header 'x-arms-api-key: <api-key>' \
  --header 'x-arms-assume-user: <api-key>' \
  --data '
{
  "auto_setout_pickup": true,
  "exception": "Scanner detected different consist order",
  "ignore_cars_with_completed_setout": false,
  "train_consist_equipment_uuids": [
    "uuid_car1",
    "uuid_car2",
    "uuid_car3"
  ],
  "work_order_id": "12345"
}
'
{}

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 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.

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.

​
autoSetoutPickup
boolean
required

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

​
trainConsistEquipmentUuids
string[]
required

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

​
workOrderId
string
required
​
exception
string

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

​
ignoreCarsWithCompletedSetout
boolean

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

​
lostTrackId
string<int64>

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

Response

A successful response.

The response is of type object.