Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cedarai Equipment History API

The Equipment History API from Cedarai — 1 operation(s) for equipment history.

Cedarai Equipment History API is one of 9 APIs that Cedarai publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Equipment History. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 1 operation across 1 path, and defines 51 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.

1 operations 1 paths 51 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
version not set
Base URL
https://api-lg.arms.cedarai.com
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Cedarai Equipment History 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 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Equipment History 1
POST
/equipment-history/
List railcar history
listEquipmentHistory 2 params body → 200400401500default

Schemas 51

The contract defines 51 schemas that model the data the API accepts and returns. The most detailed are Waybill (68 properties), UmlerCommon (67 properties), EquipmentDetails (26 properties), EquipmentHistoryItem (21 properties). Each schema is shown below with its type and property counts.

HistoryGroupingNameFilter
object
2 properties 2 required
LineItem
object
5 properties
HazmatReferenceNumber
object
3 properties
InterchangeMoveAuthority
object
Interchange move authority on equipment (X12 IMA).
5 properties
GroupingRule
object
Optional grouping rule configuration.
Station
object
6 properties
EmptyCarDisposition
object
9 properties
CommunicationNumber
object
2 properties
Umler
WorkOrderResource
object
8 properties
CanadianDangerousRequirements
object
15 properties
IntermodalUnitResource
object
3 properties
RouteEntry
object
6 properties
LineItemQuantity
object
11 properties
RelaxedEquipment
LineItemDescription
object
9 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…
5 properties
HazardousCertification
object
1 property
IntermodalStatusDetails
object
2 properties
WagonDamage
object
6 properties
ProtectiveService
object
13 properties
PriceAuthority
object
13 properties
HazardousInformation
object
21 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
HazardousClassificationInformation
object
13 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
Waybill
object
68 properties
Release
object
3 properties
EPARequiredData
object
4 properties
Error
object
1 property
ListEquipmentHistoryOutput
object
3 properties 1 required
Equipment
object
18 properties
EquipmentParentGrouping
object
8 properties
CrossReferenceEquipment
object
10 properties
AdministrativeContact
object
4 properties
Party
object
18 properties
BillingInformation
object
4 properties
HazmatShippingNameInformation
object
4 properties
TransborderHazardousRequirements
object
3 properties
Terminal
object
Port or terminal location on equipment (X12 R4).
4 properties
UmlerCommon
object
Shared UMLER attributes for equipment records.
67 properties
Measurement
object
12 properties
ListEquipmentHistoryInput
object
17 properties 1 required
Grouping
object
12 properties 7 required
HazmatFreeFormInformation
object
8 properties
EquipmentDetails
object
26 properties
HistoryMoveType
string
ReferenceInfo
object
3 properties
AttributesBase
object
Base attribute payload for grouping resources.
WaybillSearchFilterCore
object
8 properties
EquipmentHistoryItem
object
21 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cedarai-equipment-history-api-openapi.yml Raw ↑

Other APIs Cedarai publishes across the network.

Cedarai ChargeService API
Cedarai Ims API
Cedarai InvoicesService API
Cedarai LindaService API
Cedarai NetworkStructureService API
Cedarai QuotesService API
Cedarai TruckLoadTenderService API
Cedarai WorkOrderService API