Cedarai Ims API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as x-arms-api-key (ApiKeyAuth).
An API key is passed in the header as x-arms-assume-user (AssumeUser).
By default, every request must be authenticated.
ApiKeyAuth — Your ARMS API key
AssumeUser — Email of a user assigned to the appropriate user group
Paths & Operations 17
Across 16 paths, the API surfaces 17 operations — 1 GET, 15 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
The contract defines 105 schemas that model the data the API accepts and returns. The most detailed are Waybill (68 properties), UmlerCommon (67 properties), EquipmentDetails (26 properties), ListInventoryInput (24 properties). Each schema is shown below with its type and property counts.
EquipmentDetails
object
26 properties
ListGroupingsOutput
object
1 property
EquipmentTrackUpdate
object
2 properties
ListStationTracksInput
object
1 property
ListChargedHistoryInput
object
6 properties2 required
GroupingNameFilter
object
3 properties2 required
HistoryMoveType
string
WagonDamage
object
6 properties
LineItemDescription
object
9 properties
ExpandedIntermodalUnit
object
7 properties
HazardousCertification
object
1 property
IntermodalUnitResource
object
3 properties
UpdateBillOfLadingInput
object
3 properties3 required
EquipmentCount
object
1 property
SwitchRequestEquipmentInput
object
2 properties2 required
CreateBillOfLadingInput
object
2 properties
ListClassListsInput
object
15 properties1 required
Party
object
18 properties
ListStationTracksOutput
object
1 property
GroupingRule
object
Optional grouping rule configuration.
PriceAuthority
object
13 properties
ListInventoryOutput
object
4 properties
EquipmentShipmentInformation
object
Per-equipment customs and tariff block (Carta Porte). Required on cross-border US–Mexico waybills; attach under waybill.equipmentDetails[], not waybill.lineIte…
Extended reference information from the waybill. Production notes are entries where referenceIdQualifier is "ZZ" and description is "TrpNotes"; the note text i…
5 properties
EquipmentHistoryItem
object
21 properties
ListCustomersOutput
object
2 properties
Measurement
object
12 properties
ClassList
object
A class list (switch list) represents a work order for switching operations.
9 properties
Release
object
3 properties
GroupingResource
object
7 properties
GroupingIdFilter
object
3 properties2 required
ExpandedEquipment
object
18 properties
CreateChargedHistoryInstance
object
3 properties3 required
UpdateEquipmentNoteInstance
object
A single equipment note update.
2 properties1 required
HazardousClassificationInformation
object
13 properties
BulkEditChargedHistoryOutput
object
1 property
ToolsWorkLoadEquipmentDetails
object
7 properties3 required
WhiteListedAttributes
object
2 properties
AttributesBase
object
Base attribute payload for grouping resources.
ClassifyClassListInput
object
Input for classifying a class list (switch list) from a list of car numbers.
5 properties2 required
CustomerOutput
object
9 properties
EquipmentParentGrouping
object
8 properties
RelaxedEquipment
Station
object
6 properties
Waybill
object
68 properties
ClassListTask
object
A task within a class list representing a switching operation for a single piece of equipment.
15 properties
UmlerCommon
object
Shared UMLER attributes for equipment records.
67 properties
Equipment
object
18 properties
SwitchRequestEquipmentOutput
object
1 property
CreateClassListInput
object
Input for creating a class list (switch list).
3 properties3 required
DeleteChargedHistoryInstance
object
1 property1 required
ToolsWorkLoadEquipmentInput
object
5 properties4 required
ListClassListsOutput
object
4 properties2 required
MoveEquipmentExternalOutput
object
1 property
UpdateEquipmentNotesOutput
object
Response after updating equipment notes.
1 property
BulkEditChargedHistoryInput
object
3 properties3 required
ToolsWorkLoadEquipmentOutput
object
ListCustomersInput
object
4 properties1 required
AdministrativeContact
object
4 properties
CanadianDangerousRequirements
object
15 properties
EquipmentResource
object
5 properties
ListInventoryInput
object
24 properties
ToolsWorkLoadGroupingDetails
object
2 properties2 required
WorkOrderResource
object
8 properties
UpdateEquipmentNotesInput
object
Request body for updating equipment notes. Provide either (equipmentIds + notes) for bulk updates, or an updates array for per-equipment notes.
4 properties
CustomerResource
object
4 properties
HazardousInformation
object
21 properties
Grouping
object
12 properties7 required
ListClassListTasksInput
object
14 properties1 required
Terminal
object
Port or terminal location on equipment (X12 R4).
4 properties
HazmatReferenceNumber
object
3 properties
CompleteClassListTasksOutput
object
Response after completing class list tasks.
1 property
CarrierResource
object
5 properties
SimplifiedListGroupingInput
object
3 properties1 required
SpotResource
object
4 properties
CompleteSingleTaskInput
object
Completion details for a single task.
4 properties1 required
SingleSwitchRequest
object
5 properties1 required
CustomerLocationResource
object
10 properties
CompleteClassListTasksInput
object
Request body for completing class list tasks.
4 properties2 required
Error
object
1 property
LineItem
object
5 properties
CommunicationNumber
object
2 properties
EquipmentLineItem
object
Per-commodity line on equipment shipment information (X12 417 N1 loop). Used for Carta Porte on cross-border waybills; quantity is a flat number, not the neste…
13 properties
LineItemQuantity
object
11 properties
MoveEquipmentExternalInput
object
4 properties
InterchangeMoveAuthority
object
Interchange move authority on equipment (X12 IMA).
5 properties
InitialAndNumber
array
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Cedarai Ims API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.
