Update a Work Order - Cedar.AI Documentation

curl --request POST \ --url https://api-lg-k-h1.arms.cedarai.com/t/v1/update-work-order \ --header 'Carrier: <carrier>' \ --header 'Content-Type: application/json' \ --header 'x-arms-api-key: <api-key>' \ --header 'x-arms-assume-user: <api-key>' \ --data ' { "crew_ids": [ "crew1", "crew2" ], "equipment_ids": [ "uuid_car1", "uuid_car2" ], "status": "ACTIVE", "train_id": "Train 123", "update_mask": { "paths": [ "train_id", "crew_ids", "equipment_ids", "status" ] }, "work_order_id": "12345" } '

{ "attributes": {}, "autoCompleteTasks": true, "blueprint": { "attributesDefault": {}, "destinationCustomerLocationId": "<string>", "destinationServingLocationId": "<string>", "enableLocalTrainMode": true, "job": { "attributesDefault": {}, "autoCompleteTasks": true, "isAvailableToAdvance": true, "isAvailableToClassify": true, "isAvailableToDeliver": true, "isAvailableToInterchange": true, "isAvailableToMove": true, "jobId": "<string>", "minNumOfEots": 123, "minNumOfLocos": 123, "name": "<string>", "requireLocoSetoutBeforeComplete": true, "templatizedName": "<string>", "trainSetDisabled": true, "type": "<string>" }, "jobId": "<string>", "name": "<string>", "originCustomerLocationId": "<string>", "originServingLocationId": "<string>", "schedule": "<string>", "useTrainFunction": true, "workDefinitionIds": [ "<string>" ], "workDefinitions": [ { "activityCode": "<string>", "arrivalTime": "2023-11-07T05:31:56Z", "customerLocationId": "<string>", "departureTime": "2023-11-07T05:31:56Z", "futureCustomerLocationId": "<string>", "futureServingLocationId": "<string>", "isPickupAndSetout": true, "name": "<string>", "pickupFilter": { "departureTrainId": "<string>", "intersectedGroupFilters": [ { "groupingIdFilter": { "groupingIds": [ "<string>" ], "groupingType": "<string>", "leafGroupingType": "<string>" }, "groupingNameFilter": { "groupingType": "<string>", "leafGroupingType": "<string>", "names": [ "<string>" ] } } ], "priority": 123, "timeFilter": { "isAnd": true, "timeFilters": [ { "absoluteTimeFilter": { "cutoffTime": "<string>", "derivedTimeAttribute": "<string>", "historyMoveType": "UNSPECIFIED", "isAfter": true, "moveType": "UNSPECIFIED" }, "dwellFilter": { "derivedTimeAttribute": "<string>", "dwellTime": "<string>", "historyMoveType": "UNSPECIFIED", "isGreaterThan": true }, "nestedTimeFilter": "<unknown>", "relativeTimeFilter": { "derivedTimeAttribute": "<string>", "historyMoveType": "UNSPECIFIED", "moveType": "UNSPECIFIED", "offset": "<string>", "timeAttribute": "<string>" } } ] }, "wantDateDaysFromNow": 123, "wantDateOffsetEnd": 123, "wantDateOffsetStart": 123 }, "servingLocationId": "<string>", "setoutFilter": { "departureTrainId": "<string>", "intersectedGroupFilters": [ { "groupingIdFilter": { "groupingIds": [ "<string>" ], "groupingType": "<string>", "leafGroupingType": "<string>" }, "groupingNameFilter": { "groupingType": "<string>", "leafGroupingType": "<string>", "names": [ "<string>" ] } } ], "priority": 123, "timeFilter": { "isAnd": true, "timeFilters": [ { "absoluteTimeFilter": { "cutoffTime": "<string>", "derivedTimeAttribute": "<string>", "historyMoveType": "UNSPECIFIED", "isAfter": true, "moveType": "UNSPECIFIED" }, "dwellFilter": { "derivedTimeAttribute": "<string>", "dwellTime": "<string>", "historyMoveType": "UNSPECIFIED", "isGreaterThan": true }, "nestedTimeFilter": "<unknown>", "relativeTimeFilter": { "derivedTimeAttribute": "<string>", "historyMoveType": "UNSPECIFIED", "moveType": "UNSPECIFIED", "offset": "<string>", "timeAttribute": "<string>" } } ] }, "wantDateDaysFromNow": 123, "wantDateOffsetEnd": 123, "wantDateOffsetStart": 123 }, "workDefinitionId": "<string>" } ], "workOrderBlueprintId": "<string>" }, "createdAt": "<string>", "crews": [ { "createdAt": "2023-11-07T05:31:56Z", "crewId": "<string>", "deletedAt": "2023-11-07T05:31:56Z", "firstName": "<string>", "lastName": "<string>", "middleName": "<string>", "picture": "aSDinaTvuI8gbWludGxpZnk=", "role": "<string>", "touchedByUser": { "displayName": "<string>", "email": "<string>", "userId": 123, "userUuid": "<string>" }, "updatedAt": "2023-11-07T05:31:56Z", "user": { "displayName": "<string>", "email": "<string>", "userId": 123, "userUuid": "<string>" } } ], "customerLocationId": "<string>", "designatedDate": "2023-11-07T05:31:56Z", "destinationCustomerLocationId": "<string>", "destinationServingLocationId": "<string>", "inTransit": true, "initialTrainConsistId": "<string>", "job": { "attributesDefault": {}, "autoCompleteTasks": true, "isAvailableToAdvance": true, "isAvailableToClassify": true, "isAvailableToDeliver": true, "isAvailableToInterchange": true, "isAvailableToMove": true, "jobId": "<string>", "minNumOfEots": 123, "minNumOfLocos": 123, "name": "<string>", "requireLocoSetoutBeforeComplete": true, "templatizedName": "<string>", "trainSetDisabled": true, "type": "<string>" }, "jobId": "<string>", "lastEventId": "<string>", "lostTrainConsistId": "<string>", "originCustomerLocationId": "<string>", "originServingLocationId": "<string>", "readyToDepart": true, "servingLocationId": "<string>", "status": "PENDING", "tasks": [ { "assignedLocation": { "spotName": "<string>", "trackId": "<string>", "trackName": "<string>" }, "createdAt": "2023-11-07T05:31:56Z", "customerLocationId": "<string>", "equipmentId": "<string>", "exception": "<string>", "isForInitialConsist": true, "pairedTaskId": "<string>", "servingLocationId": "<string>", "sortBy": "<string>", "status": "NOT_STARTED", "switchRequest": { "batchId": "<string>", "completedAt": "2023-11-07T05:31:56Z", "createdAt": "2023-11-07T05:31:56Z", "customerId": "<string>", "deletedBy": {}, "equipment": { "arrivalState": "AS_INBOUND", "equipmentId": 123, "equipmentInitial": "<string>", "equipmentNumber": "<string>", "equipmentUuid": "<string>", "groupings": [ { "attributes": {}, "customerLocation": { "abbreviatedName": "<string>", "address": { "addressId": "<string>", "addressType": "AT_UNKNOWN", "city": "<string>", "country": "<string>", "name": "<string>", "state": "<string>", "streetLine1": "<string>", "streetLine2": "<string>", "streetLine3": "<string>", "streetLine4": "<string>", "zipCode": "<string>" }, "addressName": "<string>", "blockCode": "<string>", "currencyCode": "<string>", "customer": { "customerId": "<string>", "customerUuid": "<string>", "locations": "<array>", "name": "<string>" }, "customerIdentificationNumbers": [ "<string>" ], "customerLocationId": "<string>", "customerLocationUuid": "<string>", "email": "<string>", "freightBillEdiReceiver": "<string>", "generalLedgerNumber": "<string>", "isDefault": true, "isReportingLocation": true, "name": "<string>", "phoneNumber": "<string>", "usedForBilling": true }, "equipmentIndexEnabled": true, "frozen": true, "groupingId": "<string>", "groupingType": "<string>", "name": "<string>", "sortOrder": 123, "status": "ACTIVE" } ], "loadStatus": "<string>", "location": { "index": 123, "track": { "name": "<string>", "trackId": "<string>" } }, "parentGroupings": [ { "attributes": {}, "grouping": { "attributes": {}, "customerLocation": { "abbreviatedName": "<string>", "address": { "addressId": "<string>", "addressType": "AT_UNKNOWN", "city": "<string>", "country": "<string>", "name": "<string>", "state": "<string>", "streetLine1": "<string>", "streetLine2": "<string>", "streetLine3": "<string>", "streetLine4": "<string>", "zipCode": "<string>" }, "addressName": "<string>", "blockCode": "<string>", "currencyCode": "<string>", "customer": { "customerId": "<string>", "customerUuid": "<string>", "locations": "<array>", "name": "<string>" }, "customerIdentificationNumbers": [ "<string>" ], "customerLocationId": "<string>", "customerLocationUuid": "<string>", "email": "<string>", "freightBillEdiReceiver": "<string>", "generalLedgerNumber": "<string>", "isDefault": true, "isReportingLocation": true, "name": "<string>", "phoneNumber": "<string>", "usedForBilling": true }, "equipmentIndexEnabled": true, "frozen": true, "groupingId": "<string>", "groupingType": "<string>", "name": "<string>", "sortOrder": 123, "status": "ACTIVE" }, "groupingIndex": 123 } ], "umler": { "abt57YrDueDate": "<string>", "abtDueDate": "<string>", "articulated": "<string>", "attributes": {}, "axleCount": 123, "bodyMaterial": "<string>", "boxSideDoorOrientation": "<string>", "brakeShoeType": "<string>", "brakeWeightLb": 123, "brakeWeightUnit": "UOM_UNSPECIFIED", "carGrade": "<string>", "couplerStyle": "<string>", "createdAt": "2023-11-07T05:31:56Z", "cubicFeetCapacity": 123, "doorLubeDueDate": "<string>", "elementEquipmentGroup": "<string>", "endOfTrainOnly": "<string>", "equipmentInitial": "<string>", "equipmentNumber": "<string>", "floorStrengthClassification": "<string>", "gallonageCapacity": 123, "grossRailWeight": 123, "grossRailWeightLb": 123, "grossRailWeightUnit": "UOM_UNSPECIFIED", "insideHeight": 123, "insideHeightFt": 123, "insideHeightUnit": "UOM_UNSPECIFIED", "insideLength": 123, "insideLengthFt": 123, "insideLengthUnit": "UOM_UNSPECIFIED", "inspectionDueDate": "<string>", "lengthFt": 123, "lessee": "<string>", "loadLimit": 123, "loadLimitLb": 123, "loadLimitUnit": "UOM_UNSPECIFIED", "markOwnerCategory": "<string>", "mechanicalDesignation": "<string>", "netWeightLb": 123, "netWeightUnit": "UOM_UNSPECIFIED", "operatingBrakes": 123, "outerExtremeHeight": 123, "outerExtremeHeightFt": 123, "outerExtremeHeightUnit": "UOM_UNSPECIFIED", "outsideExtremeWidth": 123, "outsideExtremeWidthFt": 123, "outsideExtremeWidthUnit": "UOM_UNSPECIFIED", "outsideHeightExtremeWidth": 123, "outsideHeightExtremeWidthFt": 123, "outsideHeightExtremeWidthUnit": "UOM_UNSPECIFIED", "outsideLength": 123, "outsideLengthFt": 123, "outsideLengthUnit": "UOM_UNSPECIFIED", "owner": "<string>", "plateCode": "<string>", "poolNumber": "<string>", "residualSideBearings": "<string>", "shoveAdjCarToRest": "<string>", "shoveCarToRest": "<string>", "sideDoorHeight": 123, "sideDoorHeightFt": 123, "sideDoorHeightUnit": "UOM_UNSPECIFIED", "sideDoorType": "<string>", "sideDoorWidth": 123, "sideDoorWidthFt": 123, "sideDoorWidthUnit": "UOM_UNSPECIFIED", "tareWeight": 123, "tareWeightLb": 123, "tareWeightUnit": "UOM_UNSPECIFIED", "trainPositionSensitive": "<string>", "umet": "<string>", "umlerUpdatedAt": "2023-11-07T05:31:56Z", "unitEquipmentGroup": "<string>", "updatedAt": "2023-11-07T05:31:56Z" }, "verificationKey": "<string>", "verificationKeys": [ { "compartment": 123, "key": "<string>" } ], "waybill": { "armsTrackingId": "<string>", "billOfLadingNumber": "<string>", "capacityLoadCode": "CAPACITY_LOAD_CODE_UNSPECIFIED", "crossReferenceEquipment": [ { "checkDigit": 123, "crossReferenceTypeCode": "CROSS_REFERENCE_TYPE_CODE_UNSPECIFIED", "equipmentInitial": "<string>", "equipmentIsDamaged": true, "equipmentLength": "<string>", "equipmentNumber": "<string>", "equipmentOperatorScac": "<string>", "equipmentOwnerScac": "<string>", "referenceId": "<string>", "referenceIdQualifier": "<string>" } ], "defaultReceiver": "<string>", "destinationJunction": { "cityName": "<string>", "countryCode": "<string>", "fsac": "<string>", "postalCode": "<string>", "splc": "<string>", "stateOrProvince": "<string>" }, "destinationStation": { "cityName": "<string>", "countryCode": "<string>", "fsac": "<string>", "postalCode": "<string>", "splc": "<string>", "stateOrProvince": "<string>" }, "equipmentDetails": [ { "dunnageMeasure": { "unit": "<string>", "value": 123 }, "equipmentInitial": "<string>", "equipmentNumber": "<string>", "grossWeightLbs": 123, "grossWeightMeasure": { "unit": "<string>", "value": 123 }, "heightMeasure": { "unit": "<string>", "value": 123 }, "lengthMeasure": { "unit": "<string>", "value": 123 }, "netWeightLbs": 123, "netWeightMeasure": { "unit": "<string>", "value": 123 }, "sealNumbers": [ "<string>" ], "tareWeightLbs": 123, "tareWeightMeasure": { "unit": "<string>", "value": 123 }, "weightAllowanceMeasure": { "unit": "<string>", "value": 123 }, "weightType": "WT_ESTIMATED", "widthMeasure": { "unit": "<string>", "value": 123 } } ], "extendedReferenceInfo": [ { "description": "<string>", "referenceId": "<string>", "referenceIdQualifier": "<string>", "referenceTimestamp": "2023-11-07T05:31:56Z" } ], "lineItems": [ { "descriptions": [ { "commodityCode": "<string>", "commodityCodeQualifier": "CCQ_UNKNOWN", "ladingDescription": "<string>" } ], "number": 123, "quantity": { "weight": 123, "weightQualifier": "WQ_UNKNOWN" } } ], "originCarrierCode": "<string>", "originJunction": { "cityName": "<string>", "countryCode": "<string>", "fsac": "<string>", "postalCode": "<string>", "splc": "<string>", "stateOrProvince": "<string>" }, "originStation": { "cityName": "<string>", "countryCode": "<string>", "fsac": "<string>", "postalCode": "<string>", "splc": "<string>", "stateOrProvince": "<string>" }, "originSystem": "WAYBILL_ORIGIN_SYSTEM_UNSPECIFIED", "parties": [ { "additionalNames": [ "<string>" ], "address": [ "<string>" ], "administrativeContacts": [ { "communicationNumbers": [ { "number": "<string>", "qualifier": "<string>" } ], "contactFunctionCode": "<string>", "contactInquiryReference": "<string>", "name": "<string>" } ], "billingInfo": [ { "carrierCodes": [ "<string>" ], "destination": { "cityName": "<string>", "countryCode": "<string>", "fsac": "<string>", "postalCode": "<string>", "splc": "<string>", "stateOrProvince": "<string>" }, "origin": { "cityName": "<string>", "countryCode": "<string>", "fsac": "<string>", "postalCode": "<string>", "splc": "<string>", "stateOrProvince": "<string>" }, "rebillReasonCode": "REBILL_REASON_CODE_UNSPECIFIED" } ], "cityName": "<string>", "countryCode": "<string>", "countrySubdivisionCode": "<string>", "entitySubIdentifierCode": "<string>", "entitySubIdentifierRelationshipCode": "<string>", "idCode": "<string>", "idCodeQualifier": "PARTY_IDENTIFICATION_CODE_QUALIFIER_UNSPECIFIED", "locationIdentifier": "<string>", "locationQualifier": "<string>", "name": "<string>", "partyType": "PARTY_ENTITY_IDENTIFIER_CODE_UNSPECIFIED", "postalCode": "<string>", "referenceInfo": [ { "description": "<string>", "referenceId": "<string>", "referenceIdQualifier": "<string>" } ], "stateOrProvince": "<string>" } ], "revisionNumber": 123, "revisionSourceType": "WAYBILL_REVISION_SOURCE_TYPE_UNSPECIFIED", "revisionTime": "2023-11-07T05:31:56Z", "route": [ { "carrierCode": "<string>", "intermodalServiceCode": "<string>", "junctionCode": "<string>", "routingSequenceCode": "ROUTING_SEQUENCE_CODE_UNSPECIFIED", "splc": "<string>" } ], "shipmentId": "<string>", "shipmentPaymentMethod": "SHIPMENT_PAYMENT_METHOD_UNSPECIFIED", "shipmentQualifier": "SHIPMENT_QUALIFIER_UNSPECIFIED", "specialHandlingCodes": [ "<string>" ], "transportationMethod": "TRANSPORTATION_METHOD_UNSPECIFIED", "waybillDate": "2023-11-07T05:31:56Z", "waybillId": 123, "waybillNumber": 123, "waybillStatus": "WAYBILL_STATUS_UNSPECIFIED", "weightUnitCode": "WEIGHT_UNIT_CODE_UNSPECIFIED" } }, "equipmentId": "<string>", "etaTime": "2023-11-07T05:31:56Z", "externalFulfillingParty": "<string>", "externalStatus": "<string>", "notes": "<string>", "requestType": "SWITCH_REQUEST_TYPE_UNSPECIFIED", "requestTypeV2": "<string>", "spotId": "<string>", "spotName": "<string>", "status": "<string>", "switchRequestId": "<string>", "touchedAt": "2023-11-07T05:31:56Z", "touchedBy": {}, "track": { "attributes": {}, "customerLocation": { "abbreviatedName": "<string>", "address": { "addressId": "<string>", "addressType": "AT_UNKNOWN", "city": "<string>", "country": "<string>", "name": "<string>", "state": "<string>", "streetLine1": "<string>", "streetLine2": "<string>", "streetLine3": "<string>", "streetLine4": "<string>", "zipCode": "<string>" }, "addressName": "<string>", "blockCode": "<string>", "currencyCode": "<string>", "customer": { "customerId": "<string>", "customerUuid": "<string>", "locations": "<array>", "name": "<string>" }, "customerIdentificationNumbers": [ "<string>" ], "customerLocationId": "<string>", "customerLocationUuid": "<string>", "email": "<string>", "freightBillEdiReceiver": "<string>", "generalLedgerNumber": "<string>", "isDefault": true, "isReportingLocation": true, "name": "<string>", "phoneNumber": "<string>", "usedForBilling": true }, "equipmentIndexEnabled": true, "frozen": true, "groupingId": "<string>", "groupingType": "<string>", "name": "<string>", "sortOrder": 123, "status": "ACTIVE" }, "trackId": "<string>", "wantDate": "<string>" }, "taskId": "<string>", "taskIndex": 123, "taskType": "PICKUP", "touchedBy": {}, "updatedAt": "2023-11-07T05:31:56Z", "workDefinitionId": "<string>", "workOrderId": "<string>" } ], "touchedBy": {}, "trainConsistId": "<string>", "trainId": "<string>", "workOrderBlueprintId": "<string>", "workOrderId": "<string>" }

Authorizations

x-arms-api-key

string

header

required

x-arms-assume-user

string

header

required

Headers

Carrier

string

required

Carrier ID

Body

application/json

attributes

object

crewIds

string[]

List of crew member IDs to assign to the work order.

customerLocationId

string<int64>

Customer location ID for the work order.

designatedDate

string<date-time>

Designated date for the work order.

equipmentIds

string[]

List of equipment UUIDs used to update consist.

forceClose

boolean

Whether to force close the work order.

initialEquipmentIds

string[]

List of equipment UUIDs used tp update initial consist.

readyToDepart

boolean

Whether the work order is ready to depart.

servingLocationId

string<int64>

Serving location ID for the work order.

status

enum<string>

default:PENDING

Available options:

PENDING,

ACTIVE,

CLOSED,

CANCELLED

taskExceptionUpdates

object[]

Updates to task exceptions.

Show child attributes

taskUpdateLocationMasks

object[]

Location masks for updating task locations.

Show child attributes

taskUpdates

object[]

List of task updates to apply to the work order.

Show child attributes

trainId

string

Train identifier to assign to the work order.

updateMask

string

Field mask specifying which fields to update.

workOrderId

string

Response

A successful response.

attributes

object

autoCompleteTasks

boolean

blueprint

object

Show child attributes

createdAt

string

crews

object[]

Show child attributes

customerLocationId

string<int64>

designatedDate

string<date-time>

destinationCustomerLocationId

string<int64>

destinationServingLocationId

string<int64>

inTransit

boolean

initialTrainConsistId

string

job

object

Show child attributes

jobId

string

lastEventId

string<int64>

lostTrainConsistId

string

originCustomerLocationId

string<int64>

originServingLocationId

string<int64>

readyToDepart

boolean

servingLocationId

string<int64>

status

enum<string>

default:PENDING

Available options:

PENDING,

ACTIVE,

CLOSED,

CANCELLED

tasks

object[]

Show child attributes

touchedBy

object

trainConsistId

string

trainId

string

workOrderBlueprintId

string

workOrderId

string