Skip to main content
The ARMS external API supports HTTP/2 and HTTP/1.1. All endpoints use HTTP POST.

​
Common Authentication Headers

Include the following headers on every request:
  • x-arms-api-key: your API key
  • x-arms-assume-user: an email assigned to the appropriate user group
  • Content-Type: application/json

​
REST endpoints

​
Base URL for REST endpoints

https://api-lg.arms.cedarai.com

​
Railcar API Endpoints

A high-level list of available endpoints:
EndpointDescriptionDocs
/ims/equipment/inventoryList railcar inventoryList railcar inventory API
/ims/groupings/listList groupings for a specific carrierList groupings API
/ims/groupings/station-tracksList station tracks for a specific carrierList groupings API
/ims/equipment/moveUpdate railcar inventoryUpdate railcar inventory API
/ims/equipment/switch-requestSubmit railcar switch requestSubmit railcar switch request API
/ims/equipment/charged-historyList railcar charge historyList railcar charge history API
/ims/equipment/bulk-edit-charged-historyBulk edit charge historyBulk edit railcar charge history API
/ims/equipment/load-toolsworkToolswork: load equipmentToolswork load equipment API

​
Waybill API Endpoints

A high-level list of available endpoints:
EndpointDescriptionDocs
/ims/waybills/bill-of-ladingCreate bill of ladingCreate bill of lading API

​
gRPC transcoded endpoints

These endpoints are sent to Envoy over HTTP and get proxied to a gRPC service.

​
Base URL for gRPC transcoded endpoints

If your service supports HTTP/2, use the following base URL: 
https://api-lg.arms.cedarai.com
If your service does not support HTTP/2, use the following base URL: 
https://api-lg-k-h1.arms.cedarai.com

​
Work Order API

A high-level list of available endpoints:
EndpointDescriptionDocs
/t/v1/arrive-trainArrive trainArrive Train API
/t/v1/depart-trainDepart trainDepart Train API
/t/v1/list-work-ordersList Work OrdersList Work Orders API
/t/v1/resequence-trainResequence a trainResequence Train API
/t/v1/update-work-orderUpdate a Work OrderUpdate Work Order API
/t/v1/record-train-eventRecord Train EventRecord Train Event API
/t/v1/setout-carsSetout CarsSetout Cars API
/t/v1/pickup-carsPickup CarsPickup Cars API

​
Network Structure API

A high-level list of available endpoints:
EndpointDescriptionDocs
/t/v1/network-hierarchyFetch the Network HierarchyNetwork Structure API

​
View OpenApi Specs

Use the links to view and save the OpenApi specs in JSON format.
  1. Work Order API (JSON)
  2. Network Structure API (JSON)
  3. REST API (JSON)