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

Base URL and Authentication

Base URL

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

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

Third Party Endpoints

A high-level list of available endpoints:
EndpointDescriptionDocs
/ims/equipment/inventoryList railcar inventoryList railcar inventory 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

Request examples

  • cURL
  • JavaScript
  • Python
  • Java
curl -X POST "https://api-lg.arms.cedarai.com/ims/equipment/inventory?carrierId=1234" \
  -H "x-arms-api-key: YOUR_API_KEY" \
  -H "x-arms-assume-user: user@example.com" \
  -H "Content-Type: application/json" \
  -d '{
    "carrierId": 1234,
    "pageSize": 20,
    "loadStatus": "LOAD",
    "station": 1001
  }'

Transcoded Endpoints

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

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

Network Structure API

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

Request examples

  • cURL
  • JavaScript
  • Python
  • Java
curl -X POST "https://api-lg.arms.cedarai.com/t/v1/list-work-orders" \
  -H "x-arms-api-key: YOUR_API_KEY" \
  -H "x-arms-assume-user: user@example.com" \
  -H "Content-Type: application/json" \
  -H "Carrier: 1234"
  -d '{
    "carrierId": 1234,
    "pageSize": 20,
    "status": "ACTIVE",
  }'