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 WorkOrderService API

The WorkOrderService API from Cedarai — 10 operation(s) for workorderservice.

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

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

This API exposes 10 operations across 10 paths, and defines 109 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.

10 operations 10 paths 109 schemas 10 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 WorkOrderService 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 10

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

WorkOrderService 10
POST
/t/v1/list-train-reason-codes
List Train Reason Codes
ListTrainReasonCodes 1 param body → 200default
POST
/t/v1/resequence-train
Resequence a train
ReSequenceTrain 1 param body → 200default
POST
/t/v1/setout-cars
Setout Cars
SetoutCars 1 param body → 200default
POST
/t/v1/pickup-cars
Pickup cars
PickupCars 1 param body → 200default
POST
/t/v1/list-work-orders
List Work Orders
ListWorkOrders 1 param body → 200default
POST
/t/v1/depart-train
Depart train
DepartTrain 1 param body → 200default
POST
/t/v1/update-work-order
Update a Work Order
UpdateWorkOrder 1 param body → 200default
POST
/t/v1/list-work-order-tasks
List Work Order Tasks
ListWorkOrderTasks 1 param body → 200default
POST
/t/v1/arrive-train
Arrive train
ArriveTrain 1 param body → 200default
POST
/t/v1/record-train-event
Record Train Event
RecordTrainEvent 1 param body → 200default

Schemas 109

The contract defines 109 schemas that model the data the API accepts and returns. The most detailed are armsUmler (74 properties), armsEquipmentDetails (36 properties), armsWorkOrder (30 properties), armsWaybill (29 properties). Each schema is shown below with its type and property counts.

cedaraiarmsTimeRange
object
2 properties
armsSetoutCarsRequest
object
Request message for completing setout tasks.
5 properties 3 required
armsWaybillRevisionSourceType
string
armsEquipmentFilter
object
7 properties
armsPartyIdentificationCodeQualifier
string
armsWorkOrderScheduledStop
object
7 properties
GroupingGroupingStatus
string
armsWeightType
string
armsEquipmentDetails
object
36 properties
armsReferenceInfo
object
3 properties
armsTrack
object
2 properties
armsWaybill
object
29 properties
armsDepartTrainRequest
object
Request message for recording a train departure from a station or location. Used when a train leaves to begin its journey or move to the next location.
5 properties 1 required
cedaraiarmsParty
object
19 properties
armsWaybillStatus
string
armsRebillReasonCode
string
armsTerminal
object
4 properties
armsInterchangeMoveAuthority
object
5 properties
armsListWorkOrdersRequest
object
Request message for listing work orders with optional filtering and pagination. Used to search and retrieve work orders based on various criteria such as statu…
18 properties
armsWorkOrderTaskType
string
cedaraiarmsRouteEntry
object
9 properties
cedaraiIntLengthMeasurement
object
2 properties
armsAddressType
string
RecordTrainEventRequestSafetyCheckEventDetailsStatus
string
cedaraiRoutingSequenceCode
string
armsArrivalState
string
EquipmentFilterTimeFilter
object
4 properties
armsCustomer
object
4 properties
armsWaybillOriginSystem
string
armsGrouping
object
9 properties
armsArriveTrainRequest
object
Request message for recording a train arrival at a specific track. Used when a train arrives at a station or location to begin operations.
7 properties 3 required
armsGroupingIdFilter
object
3 properties
armsEquipmentShipmentInformation
object
5 properties
armsWeightQualifier
string
armsListTrainReasonCodesResponse
object
1 property
armsWorkOrderStatus
string
armsReSequenceTrainRequest
object
Request message for resequencing a train's consist order. Used when the actual train consist order differs from the planned order, such as after an EDI scanner…
6 properties 3 required
armsAdministrativeContact
object
4 properties
armsPickupCarsRequest
object
Request message for completing Pickup tasks.
6 properties 3 required
armsShipmentQualifier
string
armsCrew
object
11 properties
armsMeasurement
object
12 properties
armsUmler
object
74 properties
cedaraiarmsAddress
object
11 properties
ExternalSystemEventExternalUser
object
Information about the user who originated the event in the external system.
2 properties
armsWaybillStation
object
6 properties
armsVerificationKey
object
2 properties
armsListWorkOrderTasksResponse
object
1 property
armsWorkDefinition
object
13 properties
armsEquipmentOrdered
object
5 properties
armsCrossReferenceEquipment
object
10 properties
armsShipmentPaymentMethod
string
armsWorkOrder
object
30 properties
EquipmentFilterAbsoluteTimeFilter
object
5 properties
armsListWorkOrdersResponse
object
3 properties
armsCommunicationNumber
object
2 properties
UpdateWorkOrderRequestWorkOrderTaskExceptionUpdateInstance
object
2 properties
RecordTrainEventRequestEventLocation
object
Information about where the event occurred.
2 properties
armsExtendedReferenceInformation
object
4 properties
armsSwitchRequest
object
22 properties
armsPriceAuthority
object
13 properties
protobufAny
object
1 property
armsEquipmentLineItem
object
13 properties
armsCapacityLoadCode
string
armsLineItem
object
5 properties
armsWeightUnitCode
string
cedaraiIntWeightMeasurement
object
2 properties
armsPickupCarsRequestException
object
4 properties
armsExternalSystemEvent
object
Event that originated from an external system.
5 properties
UpdateWorkOrderRequestWorkOrderTaskUpdateInstance
object
7 properties
armsWorkOrderTaskStatus
string
armsRecordTrainEventRequest
object
Request message for recording a train event.
8 properties
armsPartyEntityIdentifierCode
string
UpdateWorkOrderRequestTaskUpdateLocationMask
object
3 properties
armsWorkOrderDirectionFilter
string
armsInventoryLocation
object
2 properties
armsSwitchRequestType
string
EquipmentFilterRelativeTimeFilter
object
5 properties
armsRRJob
object
15 properties
armsGroupingNameFilter
object
3 properties
armsWorkOrderBlueprint
object
15 properties
armsLineItemDescription
object
9 properties
armsUmlerUnitOfMeasurement
string
HistoryMoveTypeMessageHistoryMoveType
string
armsGroupFilter
object
2 properties
armsTrainReasonCode
object
2 properties
armsUser
object
4 properties
armsBillingInformation
object
4 properties
armsCrossReferenceTypeCode
string
RecordTrainEventRequestSafetyCheckEventDetails
object
Details for a safety check event.
3 properties
armsSetoutCarsRequestItem
object
5 properties
armsCommodityCodeQualifier
string
EquipmentFilterNestedTimeFilter
object
2 properties
RecordTrainEventRequestFinalApprovalEventDetails
object
Details for a final approval event.
1 property
armsPickupCarsRequestItem
object
2 properties
armsAssignedLocation
object
3 properties
armsEquipmentParentGrouping
object
3 properties
armsListWorkOrderTasksRequest
object
9 properties
RecordTrainEventRequestOtherEventDetails
object
Empty message - just serves as a discriminator
armsListTrainReasonCodesRequest
object
1 property
armsCustomerLocation
object
18 properties
armsWorkOrderTask
object
20 properties
armsUpdateWorkOrderRequest
object
16 properties
cedaraiarmsEquipment
object
13 properties
armsTransportationMethod
string
EquipmentFilterDwellFilter
object
4 properties
armsSetoutCarsRequestException
object
4 properties
armsLineItemQuantity
object
11 properties
rpcStatus
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cedarai-workorderservice-api-openapi.yml Raw ↑

Other APIs Cedarai publishes across the network.

Cedarai ChargeService API
Cedarai Equipment History API
Cedarai Ims API
Cedarai InvoicesService API
Cedarai LindaService API
Cedarai NetworkStructureService API
Cedarai QuotesService API
Cedarai TruckLoadTenderService API