API documentation
Railcar API
Waybill API
Work Order API
Network Structure API
Work Order API
List Work Orders
Returns list of Work Orders
POST
/
t
/
v1
/
list-work-orders
List Work Orders
Copy
curl --request POST \
--url https://api-lg-k-h1.arms.cedarai.com/t/v1/list-work-orders \
--header 'Carrier: <carrier>' \
--header 'Content-Type: application/json' \
--header 'x-arms-api-key: <api-key>' \
--header 'x-arms-assume-user: <api-key>' \
--data '
{
"statuses": [
"ACTIVE",
"PENDING"
],
"work_order_ids": [
"12345",
"67890"
],
"equipment_name": "BNSF 123456",
"name": "Daily Switch Job",
"include_tasks": true,
"designated_date_range": {
"start": "2024-01-01T00:00:00.000Z",
"end": "2024-01-31T23:59:59.000Z"
},
"origin_location_ids": [
"11111"
],
"destination_location_ids": [
"22222"
],
"customer_location_ids": [
"33333"
],
"serving_location_ids": [
"44444"
],
"attributes": {
"priority": "high",
"shift": "day"
},
"page_size": 50,
"page_next_token": "eyJwYWdlIjogMiwgImxhc3RfaWQiOiAiMTIzNDUifQ=="
}
'Copy
{
"results": [
{
"work_order_id": "12345",
"train_id": "Train 123",
"status": "ACTIVE",
"equipment_ids": [
"uuid_car1",
"uuid_car2"
],
"crew_ids": [
"crew1",
"crew2"
],
"designated_date": "2024-01-15T00:00:00.000Z"
},
{
"work_order_id": "6789",
"train_id": "Train 456",
"status": "PENDING",
"equipment_ids": [
"uuid_car3"
],
"crew_ids": [
"crew3"
],
"designated_date": "2024-01-16T00:00:00.000Z"
}
],
"next_token": "eyJwYWdlIjogMiwgImxhc3RfaWQiOiAiMTIzNDYifQ==",
"prev_token": ""
}Headers
Carrier ID
Body
application/json
Request message for listing work orders with optional filtering and pagination. Used to search and retrieve work orders based on various criteria such as status, equipment, locations, and dates.
Request message for listing work orders with optional filtering and pagination. Used to search and retrieve work orders based on various criteria such as status, equipment, locations, and dates.
Available options:
PENDING, ACTIVE, CLOSED Optional list of work order ids to fetch. When provided these are the only work orders returned.
Whether to include task details in the response.
Response
A successful response.
Show child attributes
Show child attributes
Available options:
PENDING, ACTIVE, CLOSED Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
results.blueprint.workDefinitions.setoutFilter.intersectedGroupFilters.groupingIdFilter.groupingIds
string<int64>[]
results.blueprint.workDefinitions.setoutFilter.intersectedGroupFilters.groupingIdFilter.groupingType
string
results.blueprint.workDefinitions.setoutFilter.intersectedGroupFilters.groupingIdFilter.leafGroupingType
string
Show child attributes
Show child attributes
results.blueprint.workDefinitions.setoutFilter.intersectedGroupFilters.groupingNameFilter.names
string[]
results.blueprint.workDefinitions.setoutFilter.intersectedGroupFilters.groupingNameFilter.groupingType
string
results.blueprint.workDefinitions.setoutFilter.intersectedGroupFilters.groupingNameFilter.leafGroupingType
string
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
results.blueprint.workDefinitions.setoutFilter.timeFilter.timeFilters.relativeTimeFilter.moveType
enum<string>
default:UNSPECIFIED
Available options:
UNSPECIFIED, ABNO, AEIE, AEIN, AEIS, AEIW, AETA, AETI, AINV, ARIL, ARRI, BADO, BFRM, BHVY, BLGT, BOHR, BXNG, CGIP, CGRD, CH80, CH81, CH82, CH83, CH84, CH85, CH86, CH89, CHARGED, CHERRYPICK, CPRL, DELIVERED, DFLC, DIGOUTS, DIVERT, DRMP, ECYC, EMPTIED, EQOR, FFBO, FLIP, FTBO, HADR, HAND, HANR, HEMB, HEATSTRT, HEATSTP, HHAR, HIGT, HMIS, HOGT, HUMP, ICHD, ICHR, IGTI, IGTR, INTERPLANT, INTRAPLANT, LCOM, LDCH, LOADED, LTFR, LTTO, MAWY, MOTR, MOVE, NOBL, NOTP, OFFERED, OGTI, OGTR, ORDER, OSTH, PACT, PASL, PCON, PFLT, PFPS, PKGD, PKGR, PLJI, PLLF, PLLT, PUJI, RAMP, RECEIVED, RECONSIGN, REBL, REJS, REMB, RFLT, RICD, RLOD, RMTY, RRFS, RTAA, RTOI, RTPO, SCYC, SETBACK, SPARGSTRT, SPARGSTP, SPECIALSWITCH, STEA, STEX, STOP, STPD, STPE, STPL, STRD, STRE, STRT, STSE, STSU, STUN, SWAP, TRIM, TSET, TURN, ULCH, UNKN, UNSC, WAYB, WEIGH, WEIGHE, WEIGHL results.blueprint.workDefinitions.setoutFilter.timeFilter.timeFilters.relativeTimeFilter.offset
string<int64>
results.blueprint.workDefinitions.setoutFilter.timeFilter.timeFilters.relativeTimeFilter.timeAttribute
string
results.blueprint.workDefinitions.setoutFilter.timeFilter.timeFilters.relativeTimeFilter.historyMoveType
enum<string>
default:UNSPECIFIED
Available options:
UNSPECIFIED, ABNO, AEIE, AEIN, AEIS, AEIW, AETA, AETI, AINV, ARIL, ARRI, BADO, BFRM, BHVY, BLGT, BOHR, BXNG, CGIP, CGRD, CH80, CH81, CH82, CH83, CH84, CH85, CH86, CH89, CHARGED, CHERRYPICK, CPRL, DELIVERED, DFLC, DIGOUTS, DIVERT, DRMP, ECYC, EMPTIED, EQOR, FFBO, FLIP, FTBO, HADR, HAND, HANR, HEMB, HEATSTRT, HEATSTP, HHAR, HIGT, HMIS, HOGT, HUMP, ICHD, ICHR, IGTI, IGTR, INTERPLANT, INTRAPLANT, LCOM, LDCH, LOADED, LTFR, LTTO, MAWY, MOTR, MOVE, NOBL, NOTP, OFFERED, OGTI, OGTR, ORDER, OSTH, PACT, PASL, PCON, PFLT, PFPS, PKGD, PKGR, PLJI, PLLF, PLLT, PUJI, RAMP, RECEIVED, RECONSIGN, REBL, REJS, REMB, RFLT, RICD, RLOD, RMTY, RRFS, RTAA, RTOI, RTPO, SCYC, SETBACK, SPARGSTRT, SPARGSTP, SPECIALSWITCH, STEA, STEX, STOP, STPD, STPE, STPL, STRD, STRE, STRT, STSE, STSU, STUN, SWAP, TRIM, TSET, TURN, ULCH, UNKN, UNSC, WAYB, WEIGH, WEIGHE, WEIGHL results.blueprint.workDefinitions.setoutFilter.timeFilter.timeFilters.relativeTimeFilter.derivedTimeAttribute
string
Show child attributes
Show child attributes
results.blueprint.workDefinitions.setoutFilter.timeFilter.timeFilters.absoluteTimeFilter.moveType
enum<string>
default:UNSPECIFIED
Available options:
UNSPECIFIED, ABNO, AEIE, AEIN, AEIS, AEIW, AETA, AETI, AINV, ARIL, ARRI, BADO, BFRM, BHVY, BLGT, BOHR, BXNG, CGIP, CGRD, CH80, CH81, CH82, CH83, CH84, CH85, CH86, CH89, CHARGED, CHERRYPICK, CPRL, DELIVERED, DFLC, DIGOUTS, DIVERT, DRMP, ECYC, EMPTIED, EQOR, FFBO, FLIP, FTBO, HADR, HAND, HANR, HEMB, HEATSTRT, HEATSTP, HHAR, HIGT, HMIS, HOGT, HUMP, ICHD, ICHR, IGTI, IGTR, INTERPLANT, INTRAPLANT, LCOM, LDCH, LOADED, LTFR, LTTO, MAWY, MOTR, MOVE, NOBL, NOTP, OFFERED, OGTI, OGTR, ORDER, OSTH, PACT, PASL, PCON, PFLT, PFPS, PKGD, PKGR, PLJI, PLLF, PLLT, PUJI, RAMP, RECEIVED, RECONSIGN, REBL, REJS, REMB, RFLT, RICD, RLOD, RMTY, RRFS, RTAA, RTOI, RTPO, SCYC, SETBACK, SPARGSTRT, SPARGSTP, SPECIALSWITCH, STEA, STEX, STOP, STPD, STPE, STPL, STRD, STRE, STRT, STSE, STSU, STUN, SWAP, TRIM, TSET, TURN, ULCH, UNKN, UNSC, WAYB, WEIGH, WEIGHE, WEIGHL results.blueprint.workDefinitions.setoutFilter.timeFilter.timeFilters.absoluteTimeFilter.cutoffTime
string
results.blueprint.workDefinitions.setoutFilter.timeFilter.timeFilters.absoluteTimeFilter.isAfter
boolean
results.blueprint.workDefinitions.setoutFilter.timeFilter.timeFilters.absoluteTimeFilter.historyMoveType
enum<string>
default:UNSPECIFIED
Available options:
UNSPECIFIED, ABNO, AEIE, AEIN, AEIS, AEIW, AETA, AETI, AINV, ARIL, ARRI, BADO, BFRM, BHVY, BLGT, BOHR, BXNG, CGIP, CGRD, CH80, CH81, CH82, CH83, CH84, CH85, CH86, CH89, CHARGED, CHERRYPICK, CPRL, DELIVERED, DFLC, DIGOUTS, DIVERT, DRMP, ECYC, EMPTIED, EQOR, FFBO, FLIP, FTBO, HADR, HAND, HANR, HEMB, HEATSTRT, HEATSTP, HHAR, HIGT, HMIS, HOGT, HUMP, ICHD, ICHR, IGTI, IGTR, INTERPLANT, INTRAPLANT, LCOM, LDCH, LOADED, LTFR, LTTO, MAWY, MOTR, MOVE, NOBL, NOTP, OFFERED, OGTI, OGTR, ORDER, OSTH, PACT, PASL, PCON, PFLT, PFPS, PKGD, PKGR, PLJI, PLLF, PLLT, PUJI, RAMP, RECEIVED, RECONSIGN, REBL, REJS, REMB, RFLT, RICD, RLOD, RMTY, RRFS, RTAA, RTOI, RTPO, SCYC, SETBACK, SPARGSTRT, SPARGSTP, SPECIALSWITCH, STEA, STEX, STOP, STPD, STPE, STPL, STRD, STRE, STRT, STSE, STSU, STUN, SWAP, TRIM, TSET, TURN, ULCH, UNKN, UNSC, WAYB, WEIGH, WEIGHE, WEIGHL results.blueprint.workDefinitions.setoutFilter.timeFilter.timeFilters.absoluteTimeFilter.derivedTimeAttribute
string
Show child attributes
Show child attributes
results.blueprint.workDefinitions.setoutFilter.timeFilter.timeFilters.dwellFilter.dwellTime
string<int64>
results.blueprint.workDefinitions.setoutFilter.timeFilter.timeFilters.dwellFilter.isGreaterThan
boolean
results.blueprint.workDefinitions.setoutFilter.timeFilter.timeFilters.dwellFilter.historyMoveType
enum<string>
default:UNSPECIFIED
Available options:
UNSPECIFIED, ABNO, AEIE, AEIN, AEIS, AEIW, AETA, AETI, AINV, ARIL, ARRI, BADO, BFRM, BHVY, BLGT, BOHR, BXNG, CGIP, CGRD, CH80, CH81, CH82, CH83, CH84, CH85, CH86, CH89, CHARGED, CHERRYPICK, CPRL, DELIVERED, DFLC, DIGOUTS, DIVERT, DRMP, ECYC, EMPTIED, EQOR, FFBO, FLIP, FTBO, HADR, HAND, HANR, HEMB, HEATSTRT, HEATSTP, HHAR, HIGT, HMIS, HOGT, HUMP, ICHD, ICHR, IGTI, IGTR, INTERPLANT, INTRAPLANT, LCOM, LDCH, LOADED, LTFR, LTTO, MAWY, MOTR, MOVE, NOBL, NOTP, OFFERED, OGTI, OGTR, ORDER, OSTH, PACT, PASL, PCON, PFLT, PFPS, PKGD, PKGR, PLJI, PLLF, PLLT, PUJI, RAMP, RECEIVED, RECONSIGN, REBL, REJS, REMB, RFLT, RICD, RLOD, RMTY, RRFS, RTAA, RTOI, RTPO, SCYC, SETBACK, SPARGSTRT, SPARGSTP, SPECIALSWITCH, STEA, STEX, STOP, STPD, STPE, STPL, STRD, STRE, STRT, STSE, STSU, STUN, SWAP, TRIM, TSET, TURN, ULCH, UNKN, UNSC, WAYB, WEIGH, WEIGHE, WEIGHL results.blueprint.workDefinitions.setoutFilter.timeFilter.timeFilters.dwellFilter.derivedTimeAttribute
string
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
results.blueprint.workDefinitions.pickupFilter.intersectedGroupFilters.groupingIdFilter.groupingIds
string<int64>[]
results.blueprint.workDefinitions.pickupFilter.intersectedGroupFilters.groupingIdFilter.groupingType
string
results.blueprint.workDefinitions.pickupFilter.intersectedGroupFilters.groupingIdFilter.leafGroupingType
string
Show child attributes
Show child attributes
results.blueprint.workDefinitions.pickupFilter.intersectedGroupFilters.groupingNameFilter.names
string[]
results.blueprint.workDefinitions.pickupFilter.intersectedGroupFilters.groupingNameFilter.groupingType
string
results.blueprint.workDefinitions.pickupFilter.intersectedGroupFilters.groupingNameFilter.leafGroupingType
string
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
results.blueprint.workDefinitions.pickupFilter.timeFilter.timeFilters.relativeTimeFilter.moveType
enum<string>
default:UNSPECIFIED
Available options:
UNSPECIFIED, ABNO, AEIE, AEIN, AEIS, AEIW, AETA, AETI, AINV, ARIL, ARRI, BADO, BFRM, BHVY, BLGT, BOHR, BXNG, CGIP, CGRD, CH80, CH81, CH82, CH83, CH84, CH85, CH86, CH89, CHARGED, CHERRYPICK, CPRL, DELIVERED, DFLC, DIGOUTS, DIVERT, DRMP, ECYC, EMPTIED, EQOR, FFBO, FLIP, FTBO, HADR, HAND, HANR, HEMB, HEATSTRT, HEATSTP, HHAR, HIGT, HMIS, HOGT, HUMP, ICHD, ICHR, IGTI, IGTR, INTERPLANT, INTRAPLANT, LCOM, LDCH, LOADED, LTFR, LTTO, MAWY, MOTR, MOVE, NOBL, NOTP, OFFERED, OGTI, OGTR, ORDER, OSTH, PACT, PASL, PCON, PFLT, PFPS, PKGD, PKGR, PLJI, PLLF, PLLT, PUJI, RAMP, RECEIVED, RECONSIGN, REBL, REJS, REMB, RFLT, RICD, RLOD, RMTY, RRFS, RTAA, RTOI, RTPO, SCYC, SETBACK, SPARGSTRT, SPARGSTP, SPECIALSWITCH, STEA, STEX, STOP, STPD, STPE, STPL, STRD, STRE, STRT, STSE, STSU, STUN, SWAP, TRIM, TSET, TURN, ULCH, UNKN, UNSC, WAYB, WEIGH, WEIGHE, WEIGHL results.blueprint.workDefinitions.pickupFilter.timeFilter.timeFilters.relativeTimeFilter.offset
string<int64>
results.blueprint.workDefinitions.pickupFilter.timeFilter.timeFilters.relativeTimeFilter.timeAttribute
string
results.blueprint.workDefinitions.pickupFilter.timeFilter.timeFilters.relativeTimeFilter.historyMoveType
enum<string>
default:UNSPECIFIED
Available options:
UNSPECIFIED, ABNO, AEIE, AEIN, AEIS, AEIW, AETA, AETI, AINV, ARIL, ARRI, BADO, BFRM, BHVY, BLGT, BOHR, BXNG, CGIP, CGRD, CH80, CH81, CH82, CH83, CH84, CH85, CH86, CH89, CHARGED, CHERRYPICK, CPRL, DELIVERED, DFLC, DIGOUTS, DIVERT, DRMP, ECYC, EMPTIED, EQOR, FFBO, FLIP, FTBO, HADR, HAND, HANR, HEMB, HEATSTRT, HEATSTP, HHAR, HIGT, HMIS, HOGT, HUMP, ICHD, ICHR, IGTI, IGTR, INTERPLANT, INTRAPLANT, LCOM, LDCH, LOADED, LTFR, LTTO, MAWY, MOTR, MOVE, NOBL, NOTP, OFFERED, OGTI, OGTR, ORDER, OSTH, PACT, PASL, PCON, PFLT, PFPS, PKGD, PKGR, PLJI, PLLF, PLLT, PUJI, RAMP, RECEIVED, RECONSIGN, REBL, REJS, REMB, RFLT, RICD, RLOD, RMTY, RRFS, RTAA, RTOI, RTPO, SCYC, SETBACK, SPARGSTRT, SPARGSTP, SPECIALSWITCH, STEA, STEX, STOP, STPD, STPE, STPL, STRD, STRE, STRT, STSE, STSU, STUN, SWAP, TRIM, TSET, TURN, ULCH, UNKN, UNSC, WAYB, WEIGH, WEIGHE, WEIGHL results.blueprint.workDefinitions.pickupFilter.timeFilter.timeFilters.relativeTimeFilter.derivedTimeAttribute
string
Show child attributes
Show child attributes
results.blueprint.workDefinitions.pickupFilter.timeFilter.timeFilters.absoluteTimeFilter.moveType
enum<string>
default:UNSPECIFIED
Available options:
UNSPECIFIED, ABNO, AEIE, AEIN, AEIS, AEIW, AETA, AETI, AINV, ARIL, ARRI, BADO, BFRM, BHVY, BLGT, BOHR, BXNG, CGIP, CGRD, CH80, CH81, CH82, CH83, CH84, CH85, CH86, CH89, CHARGED, CHERRYPICK, CPRL, DELIVERED, DFLC, DIGOUTS, DIVERT, DRMP, ECYC, EMPTIED, EQOR, FFBO, FLIP, FTBO, HADR, HAND, HANR, HEMB, HEATSTRT, HEATSTP, HHAR, HIGT, HMIS, HOGT, HUMP, ICHD, ICHR, IGTI, IGTR, INTERPLANT, INTRAPLANT, LCOM, LDCH, LOADED, LTFR, LTTO, MAWY, MOTR, MOVE, NOBL, NOTP, OFFERED, OGTI, OGTR, ORDER, OSTH, PACT, PASL, PCON, PFLT, PFPS, PKGD, PKGR, PLJI, PLLF, PLLT, PUJI, RAMP, RECEIVED, RECONSIGN, REBL, REJS, REMB, RFLT, RICD, RLOD, RMTY, RRFS, RTAA, RTOI, RTPO, SCYC, SETBACK, SPARGSTRT, SPARGSTP, SPECIALSWITCH, STEA, STEX, STOP, STPD, STPE, STPL, STRD, STRE, STRT, STSE, STSU, STUN, SWAP, TRIM, TSET, TURN, ULCH, UNKN, UNSC, WAYB, WEIGH, WEIGHE, WEIGHL results.blueprint.workDefinitions.pickupFilter.timeFilter.timeFilters.absoluteTimeFilter.cutoffTime
string
results.blueprint.workDefinitions.pickupFilter.timeFilter.timeFilters.absoluteTimeFilter.isAfter
boolean
results.blueprint.workDefinitions.pickupFilter.timeFilter.timeFilters.absoluteTimeFilter.historyMoveType
enum<string>
default:UNSPECIFIED
Available options:
UNSPECIFIED, ABNO, AEIE, AEIN, AEIS, AEIW, AETA, AETI, AINV, ARIL, ARRI, BADO, BFRM, BHVY, BLGT, BOHR, BXNG, CGIP, CGRD, CH80, CH81, CH82, CH83, CH84, CH85, CH86, CH89, CHARGED, CHERRYPICK, CPRL, DELIVERED, DFLC, DIGOUTS, DIVERT, DRMP, ECYC, EMPTIED, EQOR, FFBO, FLIP, FTBO, HADR, HAND, HANR, HEMB, HEATSTRT, HEATSTP, HHAR, HIGT, HMIS, HOGT, HUMP, ICHD, ICHR, IGTI, IGTR, INTERPLANT, INTRAPLANT, LCOM, LDCH, LOADED, LTFR, LTTO, MAWY, MOTR, MOVE, NOBL, NOTP, OFFERED, OGTI, OGTR, ORDER, OSTH, PACT, PASL, PCON, PFLT, PFPS, PKGD, PKGR, PLJI, PLLF, PLLT, PUJI, RAMP, RECEIVED, RECONSIGN, REBL, REJS, REMB, RFLT, RICD, RLOD, RMTY, RRFS, RTAA, RTOI, RTPO, SCYC, SETBACK, SPARGSTRT, SPARGSTP, SPECIALSWITCH, STEA, STEX, STOP, STPD, STPE, STPL, STRD, STRE, STRT, STSE, STSU, STUN, SWAP, TRIM, TSET, TURN, ULCH, UNKN, UNSC, WAYB, WEIGH, WEIGHE, WEIGHL results.blueprint.workDefinitions.pickupFilter.timeFilter.timeFilters.absoluteTimeFilter.derivedTimeAttribute
string
Show child attributes
Show child attributes
results.blueprint.workDefinitions.pickupFilter.timeFilter.timeFilters.dwellFilter.dwellTime
string<int64>
results.blueprint.workDefinitions.pickupFilter.timeFilter.timeFilters.dwellFilter.isGreaterThan
boolean
results.blueprint.workDefinitions.pickupFilter.timeFilter.timeFilters.dwellFilter.historyMoveType
enum<string>
default:UNSPECIFIED
Available options:
UNSPECIFIED, ABNO, AEIE, AEIN, AEIS, AEIW, AETA, AETI, AINV, ARIL, ARRI, BADO, BFRM, BHVY, BLGT, BOHR, BXNG, CGIP, CGRD, CH80, CH81, CH82, CH83, CH84, CH85, CH86, CH89, CHARGED, CHERRYPICK, CPRL, DELIVERED, DFLC, DIGOUTS, DIVERT, DRMP, ECYC, EMPTIED, EQOR, FFBO, FLIP, FTBO, HADR, HAND, HANR, HEMB, HEATSTRT, HEATSTP, HHAR, HIGT, HMIS, HOGT, HUMP, ICHD, ICHR, IGTI, IGTR, INTERPLANT, INTRAPLANT, LCOM, LDCH, LOADED, LTFR, LTTO, MAWY, MOTR, MOVE, NOBL, NOTP, OFFERED, OGTI, OGTR, ORDER, OSTH, PACT, PASL, PCON, PFLT, PFPS, PKGD, PKGR, PLJI, PLLF, PLLT, PUJI, RAMP, RECEIVED, RECONSIGN, REBL, REJS, REMB, RFLT, RICD, RLOD, RMTY, RRFS, RTAA, RTOI, RTPO, SCYC, SETBACK, SPARGSTRT, SPARGSTP, SPECIALSWITCH, STEA, STEX, STOP, STPD, STPE, STPL, STRD, STRE, STRT, STSE, STSU, STUN, SWAP, TRIM, TSET, TURN, ULCH, UNKN, UNSC, WAYB, WEIGH, WEIGHE, WEIGHL results.blueprint.workDefinitions.pickupFilter.timeFilter.timeFilters.dwellFilter.derivedTimeAttribute
string
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
PICKUP, SETOUT Available options:
NOT_STARTED, COMPLETED, DID_NOT_COMPLETE Show child attributes
Show child attributes
Available options:
SWITCH_REQUEST_TYPE_UNSPECIFIED, SPOT, INTRA_PLANT, TURN, RELEASE, LEAVE Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
results.tasks.switchRequest.equipment.waybill.parties.partyType
enum<string>
default:PARTY_ENTITY_IDENTIFIER_CODE_UNSPECIFIED
Available options:
PARTY_ENTITY_IDENTIFIER_CODE_UNSPECIFIED, PARTY_TO_BE_BILLED, ORIGIN_PARTY, DESTINATION_PARTY, BENEFICIAL_OWNER, BILL_TO, IN_CARE_OF_1, CUSTOMS_BROKER, CHASSIS_PROVIDER, CONSIGNEE, CONVERTER, DESTINATION_MAIL_FACILITY, FORWARDER, IMPORTER, MOTOR_CARRIER, NOTIFY_PARTY_1, ORIGIN_MAIL_FACILITY, FREIGHT_BILL_PARTY, PICK_UP_PARTY, CERTIFICATION_PARTY, SHIP_FROM, SHIPPER, STEAMSHIP_COMPANY, SHIP_TO, ULTIMATE_CONSIGNEE, INLAND_MEXICAN_BROKER, CANADIAN_CUSTOMS_BROKER, MEXICAN_CUSTOMS_BROKER, US_CUSTOMS_BROKER, MONITORING_PARTY Show child attributes
Show child attributes
results.tasks.switchRequest.equipment.waybill.equipmentDetails.weightType
enum<string>
default:WT_ESTIMATED
Available options:
WT_ESTIMATED, WT_ACTUAL Show child attributes
Show child attributes
Show child attributes
Show child attributes
results.tasks.switchRequest.equipment.waybill.lineItems.descriptions.commodityCodeQualifier
enum<string>
default:CCQ_UNKNOWN
Available options:
CCQ_UNKNOWN, CCQ_EMPTY_NON_HAZARDOUS, CCQ_HARMONIZED_CODE_SYSTEM, CCQ_LAST_CONTAINED, CCQ_STCC Show child attributes
Show child attributes
Available options:
AS_INBOUND, AS_ONLINE, AS_OUTBOUND Show child attributes
Show child attributes
Show child attributes
Show child attributes
results.tasks.switchRequest.equipment.groupings.customerLocation.customerIdentificationNumbers
string[]
Show child attributes
Show child attributes
results.tasks.switchRequest.equipment.groupings.customerLocation.address.addressType
enum<string>
default:AT_UNKNOWN
Available options:
AT_UNKNOWN, AT_CARRIER, AT_CUSTOMER, AT_PORT, AT_CONTRACTUAL_PORT, AT_PARTIAL Show child attributes
Show child attributes
Available options:
ACTIVE, ARCHIVED Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
results.tasks.switchRequest.equipment.parentGroupings.grouping.customerLocation.customerLocationId
string<int64>
results.tasks.switchRequest.equipment.parentGroupings.grouping.customerLocation.customerLocationUuid
string
results.tasks.switchRequest.equipment.parentGroupings.grouping.customerLocation.customerIdentificationNumbers
string[]
results.tasks.switchRequest.equipment.parentGroupings.grouping.customerLocation.generalLedgerNumber
string
Show child attributes
Show child attributes
results.tasks.switchRequest.equipment.parentGroupings.grouping.customerLocation.address.addressId
string<int64>
results.tasks.switchRequest.equipment.parentGroupings.grouping.customerLocation.address.streetLine1
string
results.tasks.switchRequest.equipment.parentGroupings.grouping.customerLocation.address.streetLine2
string
results.tasks.switchRequest.equipment.parentGroupings.grouping.customerLocation.address.streetLine3
string
results.tasks.switchRequest.equipment.parentGroupings.grouping.customerLocation.address.streetLine4
string
results.tasks.switchRequest.equipment.parentGroupings.grouping.customerLocation.address.state
string
results.tasks.switchRequest.equipment.parentGroupings.grouping.customerLocation.address.country
string
results.tasks.switchRequest.equipment.parentGroupings.grouping.customerLocation.address.zipCode
string
results.tasks.switchRequest.equipment.parentGroupings.grouping.customerLocation.address.addressType
enum<string>
default:AT_UNKNOWN
Available options:
AT_UNKNOWN, AT_CARRIER, AT_CUSTOMER, AT_PORT, AT_CONTRACTUAL_PORT, AT_PARTIAL results.tasks.switchRequest.equipment.parentGroupings.grouping.customerLocation.abbreviatedName
string
results.tasks.switchRequest.equipment.parentGroupings.grouping.customerLocation.usedForBilling
boolean
results.tasks.switchRequest.equipment.parentGroupings.grouping.customerLocation.isReportingLocation
boolean
Show child attributes
Show child attributes
results.tasks.switchRequest.equipment.parentGroupings.grouping.customerLocation.customer.customerId
string<int64>
results.tasks.switchRequest.equipment.parentGroupings.grouping.customerLocation.customer.name
string
results.tasks.switchRequest.equipment.parentGroupings.grouping.customerLocation.customer.locations
array
results.tasks.switchRequest.equipment.parentGroupings.grouping.customerLocation.customer.customerUuid
string
Available options:
ACTIVE, ARCHIVED Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
results.tasks.switchRequest.track.customerLocation.address.addressType
enum<string>
default:AT_UNKNOWN
Available options:
AT_UNKNOWN, AT_CARRIER, AT_CUSTOMER, AT_PORT, AT_CONTRACTUAL_PORT, AT_PARTIAL Show child attributes
Show child attributes
Available options:
ACTIVE, ARCHIVED Was this page helpful?
⌘I
List Work Orders
Copy
curl --request POST \
--url https://api-lg-k-h1.arms.cedarai.com/t/v1/list-work-orders \
--header 'Carrier: <carrier>' \
--header 'Content-Type: application/json' \
--header 'x-arms-api-key: <api-key>' \
--header 'x-arms-assume-user: <api-key>' \
--data '
{
"statuses": [
"ACTIVE",
"PENDING"
],
"work_order_ids": [
"12345",
"67890"
],
"equipment_name": "BNSF 123456",
"name": "Daily Switch Job",
"include_tasks": true,
"designated_date_range": {
"start": "2024-01-01T00:00:00.000Z",
"end": "2024-01-31T23:59:59.000Z"
},
"origin_location_ids": [
"11111"
],
"destination_location_ids": [
"22222"
],
"customer_location_ids": [
"33333"
],
"serving_location_ids": [
"44444"
],
"attributes": {
"priority": "high",
"shift": "day"
},
"page_size": 50,
"page_next_token": "eyJwYWdlIjogMiwgImxhc3RfaWQiOiAiMTIzNDUifQ=="
}
'Copy
{
"results": [
{
"work_order_id": "12345",
"train_id": "Train 123",
"status": "ACTIVE",
"equipment_ids": [
"uuid_car1",
"uuid_car2"
],
"crew_ids": [
"crew1",
"crew2"
],
"designated_date": "2024-01-15T00:00:00.000Z"
},
{
"work_order_id": "6789",
"train_id": "Train 456",
"status": "PENDING",
"equipment_ids": [
"uuid_car3"
],
"crew_ids": [
"crew3"
],
"designated_date": "2024-01-16T00:00:00.000Z"
}
],
"next_token": "eyJwYWdlIjogMiwgImxhc3RfaWQiOiAiMTIzNDYifQ==",
"prev_token": ""
}