Get a specific Action by its UUID

Request

Security

BearerToken

Path

UUIDstring, (uuid)required

The unique UUID of this Action

curl -i -X GET \
  'https://otm-api-spec.redocly.app/_mock/api/5.9/otm/api/v5/actions/{UUID}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Returned the entity with the provided UUID

Bodyapplication/json

actionTypestringrequired

Value:"load"

Example:"load"

Discriminator

idstring

Uniquely identifies this entity. A URI can be assigned by the client to indicate where more information can be retrieved. Note that every entity always has a unique EntityId. However since, OTM5.2 it is not required to send it in the request. One can be generated for you by the server.

Example:"e81a7aa3-23a6-4089-b916-52b854c7b6f1"

namestring

Name of the entity. For display purposes and search only.

creationDatestring, (date-time)

The creation date of this entity.

lastModifiedstring, (date-time)

The last modified date of this entity. If none is given the creation date is used instead.

contextEventsArray of any(event)

The context events provides some optional information about the events that can provide additional information on the current state of this entity.

For example: your system might send ETA information for the arrival of a vehicle on a location. To make it clear what caused this ETA to be updated, we can include some information about what caused this ETA update by including an event as context. If your ETA update was caused by a location update, this event can be included as context. If the ETA was caused by a traffic accident on the route of the vehicle, you can include that event in the context.

externalAttributesobject

externalIdentifiersArray of objects(externalIdentifiers)

Standardized identifiers of this entity as known in external systems. Use this to exchange repeatable partner or system specific identifiers without overloading externalAttributes.

Example:

[
  {
    "id": "AAA",
    "scheme": "CAS"
  }
]

lifecyclestring(lifecycle)

A lifecycle models when the data in the action is taking place. You can provide the same action in multiple lifecycles to model how it changes over time. For example the planned and realized time of an action taking place can differ because of unforseen circumstances (such as traffic jams).

Enum:"requested""planned""projected""actual""realized"

Example:"planned"

resultobject(action-result)

The result of the action, can only be present in the actual or realized lifecycles. The result has a required status and optional additional info, like a remark and reason (in the case of failure).

remarkstring

Free text field for adding an on remark on this action.

Example:"loading a consignment"

sequenceNrinteger, (int64)

The sequence number of this action within the entity it is taking place. Can be used to indicate order when no times are present

stopany

consignmentany

Example:

{
  "uuid": "047cfa4d-fd8b-47ba-b8e9-87067294d2fa",
  "entityType": "consignment",
  "associationType": "reference"
}

transportEquipmentany

documentsArray of any

Documents that are relevant for this action. Such as a proof-of-delivery photo, or scanned CMR.

locationany

timeFormatstring

Default:"dateTime"

Enum:"dateTime""recurringDateTime""duration"

startTimestring, (date-time)

The time at which the actions starts in ISO format.

Example:"2021-06-23T14:00:00Z"

endTimestring, (date-time)

The time at which the action is completed in ISO format.

Example:"2021-06-23T14:15:00Z"

recurrencestring, (recurrence)

The recurrence of the date time, should only be set when timeFormat is set to recurringDateTime. The recurrence follows the Recurrence Rule specification

durationstring, (duration)

The duration of this action/event, should only be set when timeFormat is set to duration. The duration follows the ISO 8601 specification

Example:"PT168H"

constraintany

Example:

{
  "entity": {
    "id": "89a7bb4d-8720-4db9-aef7-4c3309186c3e",
    "name": "Example combined constraint",
    "value": { … }
  },
  "associationType": "inline"
}

Response

{
  "id": "e81a7aa3-23a6-4089-b916-52b854c7b6f1",
  "lifecycle": "planned",
  "remark": "loading a consignment",
  "consignment": {
    "uuid": "047cfa4d-fd8b-47ba-b8e9-87067294d2fa",
    "entityType": "consignment",
    "associationType": "reference"
  },
  "startTime": "2021-06-23T14:00:00Z",
  "endTime": "2021-06-23T14:15:00Z",
  "constraint": {
    "entity": { … },
    "associationType": "inline"
  },
  "actionType": "load"
}