Cedarai Ims API
The Ims API from Cedarai — 16 operation(s) for ims.
Cedarai Ims API is one of 9 APIs that Cedarai publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Ims. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 17 operations across 16 paths, and defines 105 schemas. It is described by OpenAPI 3.0.1, at version version not set.
Requests are made against 2 base URLs: https://api-lg-k-h1.arms.cedarai.com, https://api-lg-k-h1.arms.cedarai.se.
17 operations
16 paths
105 schemas
1 GET15 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
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 (AssumeUserAuth).
By default, every request must be authenticated.
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.
Ims 17
POST
/ims/waybills/bill-of-lading
Create bill of lading
PUT
/ims/waybills/bill-of-lading
Update bill of lading
POST
/ims/work-orders/class-lists/classify
Classify a class list
POST
/ims/groupings/list
List groupings
POST
/ims/work-orders/class-lists/tasks
List class list tasks
POST
/ims/equipment/bulk-edit-charged-history
Bulk edit railcar charge history
POST
/ims/equipment/load-toolswork
Toolswork load equipment
POST
/ims/equipment/move
Update railcar inventory (move equipment)
POST
/ims/customers
List customers
POST
/ims/work-orders/class-lists/create
Create a class list
POST
/ims/equipment/notes/update
Update equipment notes
GET
/ims/groupings/station-tracks
List station tracks
POST
/ims/equipment/switch-request
Submit railcar switch request
POST
/ims/equipment/charged-history
List railcar charge history
POST
/ims/work-orders/class-lists
List class lists
POST
/ims/work-orders/tasks/complete
Complete class list tasks
POST
/ims/equipment/inventory
List railcar inventory
Schemas 105
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.
LineItem
object
5 properties
GroupingRule
object
Optional grouping rule configuration.
ListClassListsOutput
object
4 properties
2 required
ClassList
object
A class list (switch list) represents a work order for switching operations.
9 properties
ListClassListTasksOutput
object
4 properties
2 required
RelaxedEquipment
WhiteListedAttributes
object
2 properties
WagonDamage
object
6 properties
HazardousInformation
object
21 properties
ListGroupingsOutput
object
1 property
ListChargedHistoryInput
object
6 properties
2 required
Waybill
object
68 properties
CustomerResource
object
4 properties
GroupingResource
object
7 properties
UserResource
object
5 properties
MoveEquipmentExternalInput
object
4 properties
CustomerOutput
object
9 properties
AdministrativeContact
object
4 properties
HazmatShippingNameInformation
object
4 properties
ToolsWorkLoadEquipmentDetails
object
7 properties
3 required
Grouping
object
12 properties
7 required
HistoryMoveType
string
CarrierResource
object
5 properties
ListClassListsInput
object
15 properties
1 required
UpdateBillOfLadingInput
object
3 properties
3 required
ExpandedEquipment
object
18 properties
ListStationTracksOutput
object
1 property
MoveEquipmentExternalOutput
object
1 property
IntermodalUnitResource
object
3 properties
ListClassListTasksInput
object
14 properties
1 required
HazardousCertification
object
1 property
InitialAndNumber
array
SwitchRequestEquipmentOutput
object
1 property
UpdateEquipmentNotesOutput
object
Response after updating equipment notes.
1 property
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
SpotResource
object
4 properties
ClassifyClassListInput
object
Input for classifying a class list (switch list) from a list of car numbers.
5 properties
2 required
ExpandedIntermodalUnit
object
7 properties
ClassListTask
object
A task within a class list representing a switching operation for a single piece of equipment.
15 properties
SwitchRequestEquipmentInput
object
2 properties
2 required
DateRange
object
2 properties
EquipmentParentGrouping
object
8 properties
CrossReferenceEquipment
object
10 properties
Party
object
18 properties
UmlerCommon
object
Shared UMLER attributes for equipment records.
67 properties
Measurement
object
12 properties
CompleteSingleTaskInput
object
Completion details for a single task.
4 properties
1 required
SingleSwitchRequest
object
5 properties
1 required
CompleteClassListTasksOutput
object
Response after completing class list tasks.
1 property
EquipmentResource
object
5 properties
AttributesBase
object
Base attribute payload for grouping resources.
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
ToolsWorkLoadGroupingDetails
object
2 properties
2 required
EquipmentHistoryItem
object
21 properties
WorkOrderResource
object
8 properties
CanadianDangerousRequirements
object
15 properties
CreateClassListInput
object
Input for creating a class list (switch list).
3 properties
3 required
LineItemQuantity
object
11 properties
SimplifiedListGroupingInput
object
3 properties
1 required
EquipmentCount
object
1 property
ListChargedHistoryOutput
object
1 property
EquipmentShipmentInformation
object
Per-equipment customs and tariff block (Carta Porte). Required on cross-border US–Mexico waybills; attach under waybill.equipmentDetails[], not waybill.lineIte…
5 properties
IntermodalStatusDetails
object
2 properties
ExtendedReferenceInformation
object
Extended reference information from the waybill. Production notes are entries where referenceIdQualifier is "ZZ" and description is "TrpNotes"; the note text i…
5 properties
CompleteClassListTasksInput
object
Request body for completing class list tasks.
4 properties
2 required
HazardousClassificationInformation
object
13 properties
BulkEditChargedHistoryInput
object
3 properties
3 required
Error
object
1 property
InventoryLocation
object
Loose location envelope. Common keys: grouping { resourceId }, groupingIndex (0 front, -1 back), spot.
GroupingNameFilter
object
3 properties
2 required
Equipment
object
18 properties
BillingInformation
object
4 properties
Terminal
object
Port or terminal location on equipment (X12 R4).
4 properties
ListInventoryOutput
object
4 properties
HazmatFreeFormInformation
object
8 properties
EquipmentDetails
object
26 properties
ReferenceInfo
object
3 properties
ToolsWorkLoadEquipmentOutput
object
UpdateEquipmentNoteInstance
object
A single equipment note update.
2 properties
1 required
HazmatReferenceNumber
object
3 properties
InterchangeMoveAuthority
object
Interchange move authority on equipment (X12 IMA).
5 properties
Station
object
6 properties
EmptyCarDisposition
object
9 properties
CommunicationNumber
object
2 properties
Umler
RouteEntry
object
6 properties
LineItemDescription
object
9 properties
PriceAuthority
object
13 properties
ProtectiveService
object
13 properties
SingleGroupingOutput
EquipmentTrackUpdate
object
2 properties
GroupingIdFilter
object
3 properties
2 required
ListInventoryInput
object
24 properties
CreateChargedHistoryInstance
object
3 properties
3 required
CustomerLocationResource
object
10 properties
DeleteChargedHistoryInstance
object
1 property
1 required
CreateBillOfLadingInput
object
2 properties
Release
object
3 properties
EPARequiredData
object
4 properties
ListStationTracksInput
object
1 property
BulkEditChargedHistoryOutput
object
1 property
TransborderHazardousRequirements
object
3 properties
ListCustomersInput
object
4 properties
1 required
ToolsWorkLoadEquipmentInput
object
5 properties
4 required
ListCustomersOutput
object
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Cedarai 8
Other APIs Cedarai publishes across the network.
Cedarai ChargeService API
Cedarai Equipment History API
Cedarai InvoicesService API
Cedarai LindaService API
Cedarai NetworkStructureService API
Cedarai QuotesService API
Cedarai TruckLoadTenderService API
Cedarai WorkOrderService API
#Ims