Skip to main content
POST
/
t
/
v1
/
record-train-event
Record Train Event
curl --request POST \
  --url https://api-lg-k-h1.arms.cedarai.com/t/v1/record-train-event \
  --header 'Carrier: <carrier>' \
  --header 'Content-Type: application/json' \
  --header 'x-arms-api-key: <api-key>' \
  --header 'x-arms-assume-user: <api-key>' \
  --data '
{
  "safetyCheckEventDetails": {
    "status": "PASSED",
    "passedEquipmentUuids": [
      "<string>"
    ],
    "failedEquipmentUuids": [
      "<string>"
    ]
  },
  "finalApprovalEventDetails": {
    "consistEquipmentUuids": [
      "<string>"
    ]
  },
  "otherEventDetails": {},
  "workOrderId": "<string>",
  "externalSystemEvent": {
    "systemName": "<string>",
    "user": {
      "email": "<string>",
      "displayName": "<string>"
    },
    "eventTypeKey": "<string>",
    "eventId": "<string>",
    "eventTimestamp": "2023-11-07T05:31:56Z"
  },
  "notes": "<string>",
  "eventMessage": "<string>",
  "eventLocation": {
    "groupingId": "<string>",
    "fsac": "<string>"
  }
}
'
{}

Authorizations

​
x-arms-api-key
string
header
required
​
x-arms-assume-user
string
header
required

Headers

​
Carrier
string
required

Carrier ID

Body

application/json

Request message for recording a train event.

Request message for recording a train event.

​
safetyCheckEventDetails
Safety Check Event Details · object

Details for a safety check event.

​
finalApprovalEventDetails
Final Approval Event Details · object

Details for a final approval event.

​
otherEventDetails
Other Event Details · object

Empty message - just serves as a discriminator

​
workOrderId
string

The work order ID associated with this event.

​
externalSystemEvent
External System Event · object

Event that originated from an external system.

​
notes
string

Free-form notes about the event.

​
eventMessage
string

A human-readable message for the event. This will override the default event message.

​
eventLocation
Event Location · object

Information about where the event occurred.

Response

A successful response.

The response is of type object.