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
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:
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:
Network Structure API
A high-level list of available endpoints:
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",
}'