The ARMS external API supports HTTP/2 and HTTP/1.1. All endpoints use HTTP POST.
Authentication
Include the following headers on every request:
| Header | Description |
|---|
x-arms-api-key | Your API key |
x-arms-assume-user | Email assigned to the appropriate user group |
Content-Type | application/json |
Need an API key? API key management is coming soon to the Admin Portal. Contact your account
representative for access. REST endpoints
Base URL for REST endpoints
https://api-lg.arms.cedarai.com
Railcar API Endpoints
A high-level list of available endpoints:
| Endpoint | Description | Docs |
|---|
/ims/equipment/inventory | List railcar inventory | List railcar inventory API |
/ims/groupings/list | List groupings for a specific carrier | List groupings API |
/ims/groupings/station-tracks | List station tracks for a specific carrier | List groupings API |
/ims/equipment/move | Update railcar inventory | Update railcar inventory API |
/ims/equipment/switch-request | Submit railcar switch request | Submit railcar switch request API |
/ims/equipment/charged-history | List railcar charge history | List railcar charge history API |
/ims/equipment/bulk-edit-charged-history | Bulk edit charge history | Bulk edit railcar charge history API |
/ims/equipment/load-toolswork | Toolswork: load equipment | Toolswork load equipment API |
Waybill API Endpoints
A high-level list of available endpoints:
| Endpoint | Description | Docs |
|---|
/ims/waybills/bill-of-lading | Create bill of lading | Create 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
https://api-lg-k-h1.arms.cedarai.com
Work Order API
A high-level list of available endpoints:
| Endpoint | Description | Docs |
|---|
/t/v1/arrive-train | Arrive train | Arrive Train API |
/t/v1/depart-train | Depart train | Depart Train API |
/t/v1/list-work-orders | List Work Orders | List Work Orders API |
/t/v1/resequence-train | Resequence a train | Resequence Train API |
/t/v1/update-work-order | Update a Work Order | Update Work Order API |
/t/v1/record-train-event | Record Train Event | Record Train Event API |
/t/v1/setout-cars | Setout Cars | Setout Cars API |
/t/v1/pickup-cars | Pickup Cars | Pickup Cars API |
Network Structure API
A high-level list of available endpoints:
| Endpoint | Description | Docs |
|---|
/t/v1/network-hierarchy | Fetch the Network Hierarchy | Network Structure API |
View OpenAPI Specs
Use the links to view and save the OpenAPI specs in JSON format.
