Skip to content

Augmented Operations Management API (1.0.0)

Overview

This API provides backend services for the Augmented Decision Making application, focusing on the efficient scheduling and assignment of tasks Operations to a given Resources.

The system models the following key entities:

  • Locations: Representing physical areas
  • Resources: Specific assignable assets within a location.
  • Tasks: Represent individual events, jobs. Tasks include detailed time information (planned, expected, actual) and model uncertainty using statistical parameters (sigma, skew factor, distribution mean/earliest/latest). Tasks also support versioning to track updates.
  • Operations: Represent a complete operation, linking an inbound task to an outbound task. Operations contain relevant metadata.
  • Assignments: Link an Operation to a specific Resource for a given time period.
  • Tags: Can be used to restrict possible assignments as well as indicate preferences or penalties.
  • Rules: Can be used to specify preferences or penalties in conjunction with the tagging mechanism.

Core Functionality

The API enables users and automated systems to:

  1. Manage Data: Perform CRUD operations on Locations, Resources, Tasks, Operations, and Assignments.
  2. Track Operations Times: Handle various time representations and update task details, including imposing delays. Task updates create new versions, preserving history.
  3. Assignments: Assign or reassign operation to resources.
  4. Detect Conflicts: Identify situations where an assigned conflicting (overlapping) with another based on their expected time windows.
  5. Resolve Conflicts: Offer mechanisms to resolve individual scheduling conflicts through AI.
  6. Optimize Globally: Offer global optimization of the schedule using various solvers to minimize conflicts and reassignments while optimizing for rules.
  7. AI Assistance: Interact with an AI agent (via the /agent/ endpoint) using natural language to query the schedule, identify conflicts, request moves, or trigger conflict resolution processes. The agent utilizes specialized tools to interact with the system's state.
  8. Real-time Updates: Delivers real-time notifications about changes to Assignments and Operations via WebSockets to subscribed clients.
  9. Virtual State Management: Allows temporary modifications to the schedule (virtual assignments) for "what-if" scenarios or agent-driven planning before potentially persisting changes.
Download OpenAPI description
Languages
Servers
Acceptance Environment
https://api.acc.adm.wearetransformers.nl

User management (authentication, current user details).

Operations

Managing locations and viewing their associated resources.

Operations

Managing resources (CRUD, listing).

Operations

Managing operations. Includes CRUD and listing with time/version filters.

Operations

Request

Creates operation.

Security
tokenAuth
Bodyapplication/jsonrequired
idstring(uuid)
externalIdstring or null
planningstring(uuid)required
descriptionstring or null
metadataAviationStandOperationMetadataSchema (object) or AviationStandDemoOperationMetadataSchema (object) or MaritimeBerthOperationMetadataSchema (object)
One of:
isBlockerbooleanrequired
groupstring or null(uuid)

Group to which this operation belongs, e.g., a portcall.

inboundTaskobject(TaskState)required
inboundTask.​taskNamestringrequired
inboundTask.​scheduledTimestring(date-time)required
inboundTask.​expectedTimestring(date-time)required
inboundTask.​expectedTimeP05string(date-time)
inboundTask.​expectedTimeP10string(date-time)
inboundTask.​expectedTimeP90string(date-time)
inboundTask.​expectedTimeP95string(date-time)
inboundTask.​expectedTimesSourcestring(ExpectedTimesSourceEnum)required
Enum"schedule""actual""manual""predicted""external"
inboundTask.​actualTimestring or null(date-time)
inboundTask.​tagsArray of strings(uuid)write-only
inboundTask.​isMockboolean
Default false
inboundTask.​metadataAviationStandTaskMetadataSchema (object) or AviationStandDemoTaskMetadataSchema (object)
One of:

Input schema for flights (task) metadata.

outboundTaskobject(TaskState)required
outboundTask.​taskNamestringrequired
outboundTask.​scheduledTimestring(date-time)required
outboundTask.​expectedTimestring(date-time)required
outboundTask.​expectedTimeP05string(date-time)
outboundTask.​expectedTimeP10string(date-time)
outboundTask.​expectedTimeP90string(date-time)
outboundTask.​expectedTimeP95string(date-time)
outboundTask.​expectedTimesSourcestring(ExpectedTimesSourceEnum)required
Enum"schedule""actual""manual""predicted""external"
outboundTask.​actualTimestring or null(date-time)
outboundTask.​tagsArray of strings(uuid)write-only
outboundTask.​isMockboolean
Default false
outboundTask.​metadataAviationStandTaskMetadataSchema (object) or AviationStandDemoTaskMetadataSchema (object)
One of:

Input schema for flights (task) metadata.

tagsArray of strings(uuid)write-only
curl -i -X POST \
  https://api.acc.adm.wearetransformers.nl/v1/operations/ \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "externalId": "string",
    "planning": "2d429708-7857-4300-9552-6e473ce0d566",
    "description": "string",
    "metadata": {
      "kind": "aviation_stand",
      "airline": null,
      "airline_code": null,
      "aircraft_type": null,
      "location_code": null,
      "origin_code": null,
      "destination_code": null,
      "wingspan": null,
      "ground_handler": null,
      "ac_reg": "string",
      "etot": null,
      "eldt": null,
      "tobt": null,
      "pegt": null
    },
    "isBlocker": true,
    "group": "fbd899a6-8a66-4f51-a95d-68668de198ae",
    "inboundTask": {
      "taskName": "string",
      "scheduledTime": "2019-08-24T14:15:22Z",
      "expectedTime": "2019-08-24T14:15:22Z",
      "expectedTimeP05": "2019-08-24T14:15:22Z",
      "expectedTimeP10": "2019-08-24T14:15:22Z",
      "expectedTimeP90": "2019-08-24T14:15:22Z",
      "expectedTimeP95": "2019-08-24T14:15:22Z",
      "expectedTimesSource": "schedule",
      "actualTime": "2019-08-24T14:15:22Z",
      "tags": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ],
      "isMock": false,
      "metadata": {
        "kind": "aviation_stand",
        "airline": null,
        "airline_code": null,
        "od_code": null,
        "ac_reg": null,
        "aircraft_type": null,
        "cat": null,
        "ground_handler": null
      }
    },
    "outboundTask": {
      "taskName": "string",
      "scheduledTime": "2019-08-24T14:15:22Z",
      "expectedTime": "2019-08-24T14:15:22Z",
      "expectedTimeP05": "2019-08-24T14:15:22Z",
      "expectedTimeP10": "2019-08-24T14:15:22Z",
      "expectedTimeP90": "2019-08-24T14:15:22Z",
      "expectedTimeP95": "2019-08-24T14:15:22Z",
      "expectedTimesSource": "schedule",
      "actualTime": "2019-08-24T14:15:22Z",
      "tags": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ],
      "isMock": false,
      "metadata": {
        "kind": "aviation_stand",
        "airline": null,
        "airline_code": null,
        "od_code": null,
        "ac_reg": null,
        "aircraft_type": null,
        "cat": null,
        "ground_handler": null
      }
    },
    "tags": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
  }'

Responses

Bodyapplication/json
idstring(uuid)
externalIdstring or null
planningstring(uuid)read-onlyrequired
descriptionstring or null
metadataAviationStandOperationMetadataSchema (object) or AviationStandDemoOperationMetadataSchema (object) or MaritimeBerthOperationMetadataSchema (object)
One of:
isBlockerbooleanrequired
tagsDetailsArray of objects(SimpleTag)read-onlyrequired
tagsDetails[].​uuidstring(uuid)read-onlyrequired
tagsDetails[].​categorystringrequired
tagsDetails[].​valuestringrequired
tagsDetails[].​requiredboolean
Default false
tagsDetails[].​colorstring or null
operationNamestringread-onlyrequired
groupstring or null(uuid)

Group to which this operation belongs, e.g., a portcall.

inboundTaskTaskState (object) or nullread-onlyrequired
One of:
inboundTask.​idstring(uuid)read-onlyrequired
inboundTask.​versionIdstring(uuid)read-onlyrequired
inboundTask.​operationstring(uuid)read-onlyrequired
inboundTask.​rolestring(RoleEnum)read-onlyrequired
Enum"inbound""outbound"
inboundTask.​taskNamestringrequired
inboundTask.​scheduledTimestring(date-time)required
inboundTask.​expectedTimestring(date-time)required
inboundTask.​expectedTimeP05string(date-time)
inboundTask.​expectedTimeP10string(date-time)
inboundTask.​expectedTimeP90string(date-time)
inboundTask.​expectedTimeP95string(date-time)
inboundTask.​expectedTimesSourcestring(ExpectedTimesSourceEnum)required
Enum"schedule""actual""manual""predicted""external"
inboundTask.​actualTimestring or null(date-time)
inboundTask.​tagsDetailsArray of objects(SimpleTag)read-onlyrequired
inboundTask.​tagsDetails[].​uuidstring(uuid)read-onlyrequired
inboundTask.​tagsDetails[].​categorystringrequired
inboundTask.​tagsDetails[].​valuestringrequired
inboundTask.​tagsDetails[].​requiredboolean
Default false
inboundTask.​tagsDetails[].​colorstring or null
inboundTask.​workspacestring or null(uuid)read-onlyrequired
inboundTask.​isMockboolean
Default false
inboundTask.​metadataAviationStandTaskMetadataSchema (object) or AviationStandDemoTaskMetadataSchema (object)
One of:

Input schema for flights (task) metadata.

inboundTask.​createdAtstring(date-time)read-onlyrequired
inboundTask.​validFromstring(date-time)read-onlyrequired
inboundTask.​validTostring or null(date-time)read-onlyrequired
inboundTask.​planningstring(uuid)read-onlyrequired
inboundTask.​persistedbooleanread-onlyrequired
outboundTaskTaskState (object) or nullread-onlyrequired
One of:
outboundTask.​idstring(uuid)read-onlyrequired
outboundTask.​versionIdstring(uuid)read-onlyrequired
outboundTask.​operationstring(uuid)read-onlyrequired
outboundTask.​rolestring(RoleEnum)read-onlyrequired
Enum"inbound""outbound"
outboundTask.​taskNamestringrequired
outboundTask.​scheduledTimestring(date-time)required
outboundTask.​expectedTimestring(date-time)required
outboundTask.​expectedTimeP05string(date-time)
outboundTask.​expectedTimeP10string(date-time)
outboundTask.​expectedTimeP90string(date-time)
outboundTask.​expectedTimeP95string(date-time)
outboundTask.​expectedTimesSourcestring(ExpectedTimesSourceEnum)required
Enum"schedule""actual""manual""predicted""external"
outboundTask.​actualTimestring or null(date-time)
outboundTask.​tagsDetailsArray of objects(SimpleTag)read-onlyrequired
outboundTask.​tagsDetails[].​uuidstring(uuid)read-onlyrequired
outboundTask.​tagsDetails[].​categorystringrequired
outboundTask.​tagsDetails[].​valuestringrequired
outboundTask.​tagsDetails[].​requiredboolean
Default false
outboundTask.​tagsDetails[].​colorstring or null
outboundTask.​workspacestring or null(uuid)read-onlyrequired
outboundTask.​isMockboolean
Default false
outboundTask.​metadataAviationStandTaskMetadataSchema (object) or AviationStandDemoTaskMetadataSchema (object)
One of:

Input schema for flights (task) metadata.

outboundTask.​createdAtstring(date-time)read-onlyrequired
outboundTask.​validFromstring(date-time)read-onlyrequired
outboundTask.​validTostring or null(date-time)read-onlyrequired
outboundTask.​planningstring(uuid)read-onlyrequired
outboundTask.​persistedbooleanread-onlyrequired
workspacestring or null(uuid)read-onlyrequired
Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "externalId": "string", "planning": "2d429708-7857-4300-9552-6e473ce0d566", "description": "string", "metadata": { "kind": "aviation_stand", "airline": null, "airline_code": null, "aircraft_type": null, "location_code": null, "origin_code": null, "destination_code": null, "wingspan": null, "ground_handler": null, "ac_reg": "string", "etot": null, "eldt": null, "tobt": null, "pegt": null }, "isBlocker": true, "tagsDetails": [ {} ], "operationName": "string", "group": "fbd899a6-8a66-4f51-a95d-68668de198ae", "inboundTask": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "versionId": "14707576-2549-4848-82ed-f68f8a1b47c7", "operation": "fc63ceec-84f0-4df1-a7e8-77c5f8c0b283", "role": "inbound", "taskName": "string", "scheduledTime": "2019-08-24T14:15:22Z", "expectedTime": "2019-08-24T14:15:22Z", "expectedTimeP05": "2019-08-24T14:15:22Z", "expectedTimeP10": "2019-08-24T14:15:22Z", "expectedTimeP90": "2019-08-24T14:15:22Z", "expectedTimeP95": "2019-08-24T14:15:22Z", "expectedTimesSource": "schedule", "actualTime": "2019-08-24T14:15:22Z", "tagsDetails": [], "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89", "isMock": false, "metadata": {}, "createdAt": "2019-08-24T14:15:22Z", "validFrom": "2019-08-24T14:15:22Z", "validTo": "2019-08-24T14:15:22Z", "planning": "2d429708-7857-4300-9552-6e473ce0d566", "persisted": true }, "outboundTask": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "versionId": "14707576-2549-4848-82ed-f68f8a1b47c7", "operation": "fc63ceec-84f0-4df1-a7e8-77c5f8c0b283", "role": "inbound", "taskName": "string", "scheduledTime": "2019-08-24T14:15:22Z", "expectedTime": "2019-08-24T14:15:22Z", "expectedTimeP05": "2019-08-24T14:15:22Z", "expectedTimeP10": "2019-08-24T14:15:22Z", "expectedTimeP90": "2019-08-24T14:15:22Z", "expectedTimeP95": "2019-08-24T14:15:22Z", "expectedTimesSource": "schedule", "actualTime": "2019-08-24T14:15:22Z", "tagsDetails": [], "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89", "isMock": false, "metadata": {}, "createdAt": "2019-08-24T14:15:22Z", "validFrom": "2019-08-24T14:15:22Z", "validTo": "2019-08-24T14:15:22Z", "planning": "2d429708-7857-4300-9552-6e473ce0d566", "persisted": true }, "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89" }

Request

Retrieves details of a specific operation by its UUID.

Security
tokenAuth
Path
idstring(uuid)required
curl -i -X GET \
  'https://api.acc.adm.wearetransformers.nl/v1/operations/{id}/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
idstring(uuid)
externalIdstring or null
planningstring(uuid)read-onlyrequired
descriptionstring or null
metadataAviationStandOperationMetadataSchema (object) or AviationStandDemoOperationMetadataSchema (object) or MaritimeBerthOperationMetadataSchema (object)
One of:
isBlockerbooleanrequired
tagsDetailsArray of objects(SimpleTag)read-onlyrequired
tagsDetails[].​uuidstring(uuid)read-onlyrequired
tagsDetails[].​categorystringrequired
tagsDetails[].​valuestringrequired
tagsDetails[].​requiredboolean
Default false
tagsDetails[].​colorstring or null
operationNamestringread-onlyrequired
groupstring or null(uuid)

Group to which this operation belongs, e.g., a portcall.

inboundTaskTaskState (object) or nullread-onlyrequired
One of:
inboundTask.​idstring(uuid)read-onlyrequired
inboundTask.​versionIdstring(uuid)read-onlyrequired
inboundTask.​operationstring(uuid)read-onlyrequired
inboundTask.​rolestring(RoleEnum)read-onlyrequired
Enum"inbound""outbound"
inboundTask.​taskNamestringrequired
inboundTask.​scheduledTimestring(date-time)required
inboundTask.​expectedTimestring(date-time)required
inboundTask.​expectedTimeP05string(date-time)
inboundTask.​expectedTimeP10string(date-time)
inboundTask.​expectedTimeP90string(date-time)
inboundTask.​expectedTimeP95string(date-time)
inboundTask.​expectedTimesSourcestring(ExpectedTimesSourceEnum)required
Enum"schedule""actual""manual""predicted""external"
inboundTask.​actualTimestring or null(date-time)
inboundTask.​tagsDetailsArray of objects(SimpleTag)read-onlyrequired
inboundTask.​tagsDetails[].​uuidstring(uuid)read-onlyrequired
inboundTask.​tagsDetails[].​categorystringrequired
inboundTask.​tagsDetails[].​valuestringrequired
inboundTask.​tagsDetails[].​requiredboolean
Default false
inboundTask.​tagsDetails[].​colorstring or null
inboundTask.​workspacestring or null(uuid)read-onlyrequired
inboundTask.​isMockboolean
Default false
inboundTask.​metadataAviationStandTaskMetadataSchema (object) or AviationStandDemoTaskMetadataSchema (object)
One of:

Input schema for flights (task) metadata.

inboundTask.​createdAtstring(date-time)read-onlyrequired
inboundTask.​validFromstring(date-time)read-onlyrequired
inboundTask.​validTostring or null(date-time)read-onlyrequired
inboundTask.​planningstring(uuid)read-onlyrequired
inboundTask.​persistedbooleanread-onlyrequired
outboundTaskTaskState (object) or nullread-onlyrequired
One of:
outboundTask.​idstring(uuid)read-onlyrequired
outboundTask.​versionIdstring(uuid)read-onlyrequired
outboundTask.​operationstring(uuid)read-onlyrequired
outboundTask.​rolestring(RoleEnum)read-onlyrequired
Enum"inbound""outbound"
outboundTask.​taskNamestringrequired
outboundTask.​scheduledTimestring(date-time)required
outboundTask.​expectedTimestring(date-time)required
outboundTask.​expectedTimeP05string(date-time)
outboundTask.​expectedTimeP10string(date-time)
outboundTask.​expectedTimeP90string(date-time)
outboundTask.​expectedTimeP95string(date-time)
outboundTask.​expectedTimesSourcestring(ExpectedTimesSourceEnum)required
Enum"schedule""actual""manual""predicted""external"
outboundTask.​actualTimestring or null(date-time)
outboundTask.​tagsDetailsArray of objects(SimpleTag)read-onlyrequired
outboundTask.​tagsDetails[].​uuidstring(uuid)read-onlyrequired
outboundTask.​tagsDetails[].​categorystringrequired
outboundTask.​tagsDetails[].​valuestringrequired
outboundTask.​tagsDetails[].​requiredboolean
Default false
outboundTask.​tagsDetails[].​colorstring or null
outboundTask.​workspacestring or null(uuid)read-onlyrequired
outboundTask.​isMockboolean
Default false
outboundTask.​metadataAviationStandTaskMetadataSchema (object) or AviationStandDemoTaskMetadataSchema (object)
One of:

Input schema for flights (task) metadata.

outboundTask.​createdAtstring(date-time)read-onlyrequired
outboundTask.​validFromstring(date-time)read-onlyrequired
outboundTask.​validTostring or null(date-time)read-onlyrequired
outboundTask.​planningstring(uuid)read-onlyrequired
outboundTask.​persistedbooleanread-onlyrequired
workspacestring or null(uuid)read-onlyrequired
Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "externalId": "string", "planning": "2d429708-7857-4300-9552-6e473ce0d566", "description": "string", "metadata": { "kind": "aviation_stand", "airline": null, "airline_code": null, "aircraft_type": null, "location_code": null, "origin_code": null, "destination_code": null, "wingspan": null, "ground_handler": null, "ac_reg": "string", "etot": null, "eldt": null, "tobt": null, "pegt": null }, "isBlocker": true, "tagsDetails": [ {} ], "operationName": "string", "group": "fbd899a6-8a66-4f51-a95d-68668de198ae", "inboundTask": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "versionId": "14707576-2549-4848-82ed-f68f8a1b47c7", "operation": "fc63ceec-84f0-4df1-a7e8-77c5f8c0b283", "role": "inbound", "taskName": "string", "scheduledTime": "2019-08-24T14:15:22Z", "expectedTime": "2019-08-24T14:15:22Z", "expectedTimeP05": "2019-08-24T14:15:22Z", "expectedTimeP10": "2019-08-24T14:15:22Z", "expectedTimeP90": "2019-08-24T14:15:22Z", "expectedTimeP95": "2019-08-24T14:15:22Z", "expectedTimesSource": "schedule", "actualTime": "2019-08-24T14:15:22Z", "tagsDetails": [], "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89", "isMock": false, "metadata": {}, "createdAt": "2019-08-24T14:15:22Z", "validFrom": "2019-08-24T14:15:22Z", "validTo": "2019-08-24T14:15:22Z", "planning": "2d429708-7857-4300-9552-6e473ce0d566", "persisted": true }, "outboundTask": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "versionId": "14707576-2549-4848-82ed-f68f8a1b47c7", "operation": "fc63ceec-84f0-4df1-a7e8-77c5f8c0b283", "role": "inbound", "taskName": "string", "scheduledTime": "2019-08-24T14:15:22Z", "expectedTime": "2019-08-24T14:15:22Z", "expectedTimeP05": "2019-08-24T14:15:22Z", "expectedTimeP10": "2019-08-24T14:15:22Z", "expectedTimeP90": "2019-08-24T14:15:22Z", "expectedTimeP95": "2019-08-24T14:15:22Z", "expectedTimesSource": "schedule", "actualTime": "2019-08-24T14:15:22Z", "tagsDetails": [], "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89", "isMock": false, "metadata": {}, "createdAt": "2019-08-24T14:15:22Z", "validFrom": "2019-08-24T14:15:22Z", "validTo": "2019-08-24T14:15:22Z", "planning": "2d429708-7857-4300-9552-6e473ce0d566", "persisted": true }, "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89" }

Request

Updates specific fields of an operation, such as its metadata or task details (which creates new task versions).

Security
tokenAuth
Path
idstring(uuid)required
Bodyapplication/json
idstring(uuid)
externalIdstring or null
planningstring(uuid)
descriptionstring or null
metadataAviationStandOperationMetadataSchema (object) or AviationStandDemoOperationMetadataSchema (object) or MaritimeBerthOperationMetadataSchema (object)
One of:
isBlockerboolean
groupstring or null(uuid)

Group to which this operation belongs, e.g., a portcall.

inboundTaskobject(TaskState)
outboundTaskobject(TaskState)
tagsArray of strings(uuid)write-only
curl -i -X PATCH \
  'https://api.acc.adm.wearetransformers.nl/v1/operations/{id}/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "externalId": "string",
    "planning": "2d429708-7857-4300-9552-6e473ce0d566",
    "description": "string",
    "metadata": {
      "kind": "aviation_stand",
      "airline": null,
      "airline_code": null,
      "aircraft_type": null,
      "location_code": null,
      "origin_code": null,
      "destination_code": null,
      "wingspan": null,
      "ground_handler": null,
      "ac_reg": "string",
      "etot": null,
      "eldt": null,
      "tobt": null,
      "pegt": null
    },
    "isBlocker": true,
    "group": "fbd899a6-8a66-4f51-a95d-68668de198ae",
    "inboundTask": {
      "taskName": "string",
      "scheduledTime": "2019-08-24T14:15:22Z",
      "expectedTime": "2019-08-24T14:15:22Z",
      "expectedTimeP05": "2019-08-24T14:15:22Z",
      "expectedTimeP10": "2019-08-24T14:15:22Z",
      "expectedTimeP90": "2019-08-24T14:15:22Z",
      "expectedTimeP95": "2019-08-24T14:15:22Z",
      "expectedTimesSource": "schedule",
      "actualTime": "2019-08-24T14:15:22Z",
      "tags": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ],
      "isMock": false,
      "metadata": {
        "kind": "aviation_stand",
        "airline": null,
        "airline_code": null,
        "od_code": null,
        "ac_reg": null,
        "aircraft_type": null,
        "cat": null,
        "ground_handler": null
      }
    },
    "outboundTask": {
      "taskName": "string",
      "scheduledTime": "2019-08-24T14:15:22Z",
      "expectedTime": "2019-08-24T14:15:22Z",
      "expectedTimeP05": "2019-08-24T14:15:22Z",
      "expectedTimeP10": "2019-08-24T14:15:22Z",
      "expectedTimeP90": "2019-08-24T14:15:22Z",
      "expectedTimeP95": "2019-08-24T14:15:22Z",
      "expectedTimesSource": "schedule",
      "actualTime": "2019-08-24T14:15:22Z",
      "tags": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ],
      "isMock": false,
      "metadata": {
        "kind": "aviation_stand",
        "airline": null,
        "airline_code": null,
        "od_code": null,
        "ac_reg": null,
        "aircraft_type": null,
        "cat": null,
        "ground_handler": null
      }
    },
    "tags": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
  }'

Responses

Bodyapplication/json
idstring(uuid)
externalIdstring or null
planningstring(uuid)read-onlyrequired
descriptionstring or null
metadataAviationStandOperationMetadataSchema (object) or AviationStandDemoOperationMetadataSchema (object) or MaritimeBerthOperationMetadataSchema (object)
One of:
isBlockerbooleanrequired
tagsDetailsArray of objects(SimpleTag)read-onlyrequired
tagsDetails[].​uuidstring(uuid)read-onlyrequired
tagsDetails[].​categorystringrequired
tagsDetails[].​valuestringrequired
tagsDetails[].​requiredboolean
Default false
tagsDetails[].​colorstring or null
operationNamestringread-onlyrequired
groupstring or null(uuid)

Group to which this operation belongs, e.g., a portcall.

inboundTaskTaskState (object) or nullread-onlyrequired
One of:
inboundTask.​idstring(uuid)read-onlyrequired
inboundTask.​versionIdstring(uuid)read-onlyrequired
inboundTask.​operationstring(uuid)read-onlyrequired
inboundTask.​rolestring(RoleEnum)read-onlyrequired
Enum"inbound""outbound"
inboundTask.​taskNamestringrequired
inboundTask.​scheduledTimestring(date-time)required
inboundTask.​expectedTimestring(date-time)required
inboundTask.​expectedTimeP05string(date-time)
inboundTask.​expectedTimeP10string(date-time)
inboundTask.​expectedTimeP90string(date-time)
inboundTask.​expectedTimeP95string(date-time)
inboundTask.​expectedTimesSourcestring(ExpectedTimesSourceEnum)required
Enum"schedule""actual""manual""predicted""external"
inboundTask.​actualTimestring or null(date-time)
inboundTask.​tagsDetailsArray of objects(SimpleTag)read-onlyrequired
inboundTask.​tagsDetails[].​uuidstring(uuid)read-onlyrequired
inboundTask.​tagsDetails[].​categorystringrequired
inboundTask.​tagsDetails[].​valuestringrequired
inboundTask.​tagsDetails[].​requiredboolean
Default false
inboundTask.​tagsDetails[].​colorstring or null
inboundTask.​workspacestring or null(uuid)read-onlyrequired
inboundTask.​isMockboolean
Default false
inboundTask.​metadataAviationStandTaskMetadataSchema (object) or AviationStandDemoTaskMetadataSchema (object)
One of:

Input schema for flights (task) metadata.

inboundTask.​createdAtstring(date-time)read-onlyrequired
inboundTask.​validFromstring(date-time)read-onlyrequired
inboundTask.​validTostring or null(date-time)read-onlyrequired
inboundTask.​planningstring(uuid)read-onlyrequired
inboundTask.​persistedbooleanread-onlyrequired
outboundTaskTaskState (object) or nullread-onlyrequired
One of:
outboundTask.​idstring(uuid)read-onlyrequired
outboundTask.​versionIdstring(uuid)read-onlyrequired
outboundTask.​operationstring(uuid)read-onlyrequired
outboundTask.​rolestring(RoleEnum)read-onlyrequired
Enum"inbound""outbound"
outboundTask.​taskNamestringrequired
outboundTask.​scheduledTimestring(date-time)required
outboundTask.​expectedTimestring(date-time)required
outboundTask.​expectedTimeP05string(date-time)
outboundTask.​expectedTimeP10string(date-time)
outboundTask.​expectedTimeP90string(date-time)
outboundTask.​expectedTimeP95string(date-time)
outboundTask.​expectedTimesSourcestring(ExpectedTimesSourceEnum)required
Enum"schedule""actual""manual""predicted""external"
outboundTask.​actualTimestring or null(date-time)
outboundTask.​tagsDetailsArray of objects(SimpleTag)read-onlyrequired
outboundTask.​tagsDetails[].​uuidstring(uuid)read-onlyrequired
outboundTask.​tagsDetails[].​categorystringrequired
outboundTask.​tagsDetails[].​valuestringrequired
outboundTask.​tagsDetails[].​requiredboolean
Default false
outboundTask.​tagsDetails[].​colorstring or null
outboundTask.​workspacestring or null(uuid)read-onlyrequired
outboundTask.​isMockboolean
Default false
outboundTask.​metadataAviationStandTaskMetadataSchema (object) or AviationStandDemoTaskMetadataSchema (object)
One of:

Input schema for flights (task) metadata.

outboundTask.​createdAtstring(date-time)read-onlyrequired
outboundTask.​validFromstring(date-time)read-onlyrequired
outboundTask.​validTostring or null(date-time)read-onlyrequired
outboundTask.​planningstring(uuid)read-onlyrequired
outboundTask.​persistedbooleanread-onlyrequired
workspacestring or null(uuid)read-onlyrequired
Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "externalId": "string", "planning": "2d429708-7857-4300-9552-6e473ce0d566", "description": "string", "metadata": { "kind": "aviation_stand", "airline": null, "airline_code": null, "aircraft_type": null, "location_code": null, "origin_code": null, "destination_code": null, "wingspan": null, "ground_handler": null, "ac_reg": "string", "etot": null, "eldt": null, "tobt": null, "pegt": null }, "isBlocker": true, "tagsDetails": [ {} ], "operationName": "string", "group": "fbd899a6-8a66-4f51-a95d-68668de198ae", "inboundTask": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "versionId": "14707576-2549-4848-82ed-f68f8a1b47c7", "operation": "fc63ceec-84f0-4df1-a7e8-77c5f8c0b283", "role": "inbound", "taskName": "string", "scheduledTime": "2019-08-24T14:15:22Z", "expectedTime": "2019-08-24T14:15:22Z", "expectedTimeP05": "2019-08-24T14:15:22Z", "expectedTimeP10": "2019-08-24T14:15:22Z", "expectedTimeP90": "2019-08-24T14:15:22Z", "expectedTimeP95": "2019-08-24T14:15:22Z", "expectedTimesSource": "schedule", "actualTime": "2019-08-24T14:15:22Z", "tagsDetails": [], "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89", "isMock": false, "metadata": {}, "createdAt": "2019-08-24T14:15:22Z", "validFrom": "2019-08-24T14:15:22Z", "validTo": "2019-08-24T14:15:22Z", "planning": "2d429708-7857-4300-9552-6e473ce0d566", "persisted": true }, "outboundTask": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "versionId": "14707576-2549-4848-82ed-f68f8a1b47c7", "operation": "fc63ceec-84f0-4df1-a7e8-77c5f8c0b283", "role": "inbound", "taskName": "string", "scheduledTime": "2019-08-24T14:15:22Z", "expectedTime": "2019-08-24T14:15:22Z", "expectedTimeP05": "2019-08-24T14:15:22Z", "expectedTimeP10": "2019-08-24T14:15:22Z", "expectedTimeP90": "2019-08-24T14:15:22Z", "expectedTimeP95": "2019-08-24T14:15:22Z", "expectedTimesSource": "schedule", "actualTime": "2019-08-24T14:15:22Z", "tagsDetails": [], "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89", "isMock": false, "metadata": {}, "createdAt": "2019-08-24T14:15:22Z", "validFrom": "2019-08-24T14:15:22Z", "validTo": "2019-08-24T14:15:22Z", "planning": "2d429708-7857-4300-9552-6e473ce0d566", "persisted": true }, "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89" }

Request

Soft-deletes an operation by marking its active state as deleted.

Security
tokenAuth
Path
idstring(uuid)required
curl -i -X DELETE \
  'https://api.acc.adm.wearetransformers.nl/v1/operations/{id}/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

No Content

Response
No content

Request

Returns the active assignment for the operation identified by pk. 404 if the operation is currently unassigned.

Security
tokenAuth
Path
idstring(uuid)required
curl -i -X GET \
  'https://api.acc.adm.wearetransformers.nl/v1/operations/{id}/assignment/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
idstring(uuid)
operationstring(uuid)required
planningstring(uuid)required
partsArray of objects(AssignmentPart)required
parts[].​idstring(uuid)read-onlyrequired
parts[].​startAtstring or null(date-time)
parts[].​endAtstring or null(date-time)
parts[].​resourcestring or null(uuid)
parts[].​isFixedboolean
parts[].​metadataMaritimeBerthAssignmentMetadataSchema (object)
One of:

Input schema for maritime berth assignment metadata.

assignedAtstring or null(date-time)read-onlyrequired
validTostring or null(date-time)read-onlyrequired
assignedBystring or nullread-onlyrequired
workspacestring or null(uuid)read-onlyrequired
tombstonebooleanread-onlyrequired
Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "operation": "fc63ceec-84f0-4df1-a7e8-77c5f8c0b283", "planning": "2d429708-7857-4300-9552-6e473ce0d566", "parts": [ {} ], "assignedAt": "2019-08-24T14:15:22Z", "validTo": "2019-08-24T14:15:22Z", "assignedBy": "string", "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89", "tombstone": true }

Get task history for this operation

Request

Extends WorkspaceMixin with serializer context for workspace-aware CRUD.

Security
tokenAuth
Path
idstring(uuid)required
curl -i -X GET \
  'https://api.acc.adm.wearetransformers.nl/v1/operations/{id}/tasks/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [
idstring(uuid)read-onlyrequired
versionIdstring(uuid)read-onlyrequired
operationstring(uuid)read-onlyrequired
rolestring(RoleEnum)read-onlyrequired
Enum"inbound""outbound"
taskNamestringrequired
scheduledTimestring(date-time)required
expectedTimestring(date-time)required
expectedTimeP05string(date-time)
expectedTimeP10string(date-time)
expectedTimeP90string(date-time)
expectedTimeP95string(date-time)
expectedTimesSourcestring(ExpectedTimesSourceEnum)required
Enum"schedule""actual""manual""predicted""external"
actualTimestring or null(date-time)
tagsDetailsArray of objects(SimpleTag)read-onlyrequired
tagsDetails[].​uuidstring(uuid)read-onlyrequired
tagsDetails[].​categorystringrequired
tagsDetails[].​valuestringrequired
tagsDetails[].​requiredboolean
Default false
tagsDetails[].​colorstring or null
workspacestring or null(uuid)read-onlyrequired
isMockboolean
Default false
metadataAviationStandTaskMetadataSchema (object) or AviationStandDemoTaskMetadataSchema (object)
One of:

Input schema for flights (task) metadata.

createdAtstring(date-time)read-onlyrequired
validFromstring(date-time)read-onlyrequired
validTostring or null(date-time)read-onlyrequired
planningstring(uuid)read-onlyrequired
persistedbooleanread-onlyrequired
]
Response
application/json
[ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "versionId": "14707576-2549-4848-82ed-f68f8a1b47c7", "operation": "fc63ceec-84f0-4df1-a7e8-77c5f8c0b283", "role": "inbound", "taskName": "string", "scheduledTime": "2019-08-24T14:15:22Z", "expectedTime": "2019-08-24T14:15:22Z", "expectedTimeP05": "2019-08-24T14:15:22Z", "expectedTimeP10": "2019-08-24T14:15:22Z", "expectedTimeP90": "2019-08-24T14:15:22Z", "expectedTimeP95": "2019-08-24T14:15:22Z", "expectedTimesSource": "schedule", "actualTime": "2019-08-24T14:15:22Z", "tagsDetails": [], "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89", "isMock": false, "metadata": {}, "createdAt": "2019-08-24T14:15:22Z", "validFrom": "2019-08-24T14:15:22Z", "validTo": "2019-08-24T14:15:22Z", "planning": "2d429708-7857-4300-9552-6e473ce0d566", "persisted": true } ]

Request

Creates operations in bulk.

Security
tokenAuth
Bodyapplication/jsonrequiredArray [
idstring(uuid)
externalIdstring or null
planningstring(uuid)required
descriptionstring or null
metadataAviationStandOperationMetadataSchema (object) or AviationStandDemoOperationMetadataSchema (object) or MaritimeBerthOperationMetadataSchema (object)
One of:
isBlockerbooleanrequired
groupstring or null(uuid)

Group to which this operation belongs, e.g., a portcall.

inboundTaskobject(TaskState)required
inboundTask.​taskNamestringrequired
inboundTask.​scheduledTimestring(date-time)required
inboundTask.​expectedTimestring(date-time)required
inboundTask.​expectedTimeP05string(date-time)
inboundTask.​expectedTimeP10string(date-time)
inboundTask.​expectedTimeP90string(date-time)
inboundTask.​expectedTimeP95string(date-time)
inboundTask.​expectedTimesSourcestring(ExpectedTimesSourceEnum)required
Enum"schedule""actual""manual""predicted""external"
inboundTask.​actualTimestring or null(date-time)
inboundTask.​tagsArray of strings(uuid)write-only
inboundTask.​isMockboolean
Default false
inboundTask.​metadataAviationStandTaskMetadataSchema (object) or AviationStandDemoTaskMetadataSchema (object)
One of:

Input schema for flights (task) metadata.

outboundTaskobject(TaskState)required
outboundTask.​taskNamestringrequired
outboundTask.​scheduledTimestring(date-time)required
outboundTask.​expectedTimestring(date-time)required
outboundTask.​expectedTimeP05string(date-time)
outboundTask.​expectedTimeP10string(date-time)
outboundTask.​expectedTimeP90string(date-time)
outboundTask.​expectedTimeP95string(date-time)
outboundTask.​expectedTimesSourcestring(ExpectedTimesSourceEnum)required
Enum"schedule""actual""manual""predicted""external"
outboundTask.​actualTimestring or null(date-time)
outboundTask.​tagsArray of strings(uuid)write-only
outboundTask.​isMockboolean
Default false
outboundTask.​metadataAviationStandTaskMetadataSchema (object) or AviationStandDemoTaskMetadataSchema (object)
One of:

Input schema for flights (task) metadata.

tagsArray of strings(uuid)write-only
]
curl -i -X POST \
  https://api.acc.adm.wearetransformers.nl/v1/operations/bulk/ \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "externalId": "string",
      "planning": "2d429708-7857-4300-9552-6e473ce0d566",
      "description": "string",
      "metadata": {
        "kind": "aviation_stand",
        "airline": null,
        "airline_code": null,
        "aircraft_type": null,
        "location_code": null,
        "origin_code": null,
        "destination_code": null,
        "wingspan": null,
        "ground_handler": null,
        "ac_reg": "string",
        "etot": null,
        "eldt": null,
        "tobt": null,
        "pegt": null
      },
      "isBlocker": true,
      "group": "fbd899a6-8a66-4f51-a95d-68668de198ae",
      "inboundTask": {
        "taskName": "string",
        "scheduledTime": "2019-08-24T14:15:22Z",
        "expectedTime": "2019-08-24T14:15:22Z",
        "expectedTimeP05": "2019-08-24T14:15:22Z",
        "expectedTimeP10": "2019-08-24T14:15:22Z",
        "expectedTimeP90": "2019-08-24T14:15:22Z",
        "expectedTimeP95": "2019-08-24T14:15:22Z",
        "expectedTimesSource": "schedule",
        "actualTime": "2019-08-24T14:15:22Z",
        "tags": [
          "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        ],
        "isMock": false,
        "metadata": {
          "kind": "aviation_stand",
          "airline": null,
          "airline_code": null,
          "od_code": null,
          "ac_reg": null,
          "aircraft_type": null,
          "cat": null,
          "ground_handler": null
        }
      },
      "outboundTask": {
        "taskName": "string",
        "scheduledTime": "2019-08-24T14:15:22Z",
        "expectedTime": "2019-08-24T14:15:22Z",
        "expectedTimeP05": "2019-08-24T14:15:22Z",
        "expectedTimeP10": "2019-08-24T14:15:22Z",
        "expectedTimeP90": "2019-08-24T14:15:22Z",
        "expectedTimeP95": "2019-08-24T14:15:22Z",
        "expectedTimesSource": "schedule",
        "actualTime": "2019-08-24T14:15:22Z",
        "tags": [
          "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        ],
        "isMock": false,
        "metadata": {
          "kind": "aviation_stand",
          "airline": null,
          "airline_code": null,
          "od_code": null,
          "ac_reg": null,
          "aircraft_type": null,
          "cat": null,
          "ground_handler": null
        }
      },
      "tags": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ]
    }
  ]'

Responses

Bodyapplication/json
idstring(uuid)
externalIdstring or null
planningstring(uuid)read-onlyrequired
descriptionstring or null
metadataAviationStandOperationMetadataSchema (object) or AviationStandDemoOperationMetadataSchema (object) or MaritimeBerthOperationMetadataSchema (object)
One of:
isBlockerbooleanrequired
tagsDetailsArray of objects(SimpleTag)read-onlyrequired
tagsDetails[].​uuidstring(uuid)read-onlyrequired
tagsDetails[].​categorystringrequired
tagsDetails[].​valuestringrequired
tagsDetails[].​requiredboolean
Default false
tagsDetails[].​colorstring or null
operationNamestringread-onlyrequired
groupstring or null(uuid)

Group to which this operation belongs, e.g., a portcall.

inboundTaskTaskState (object) or nullread-onlyrequired
One of:
inboundTask.​idstring(uuid)read-onlyrequired
inboundTask.​versionIdstring(uuid)read-onlyrequired
inboundTask.​operationstring(uuid)read-onlyrequired
inboundTask.​rolestring(RoleEnum)read-onlyrequired
Enum"inbound""outbound"
inboundTask.​taskNamestringrequired
inboundTask.​scheduledTimestring(date-time)required
inboundTask.​expectedTimestring(date-time)required
inboundTask.​expectedTimeP05string(date-time)
inboundTask.​expectedTimeP10string(date-time)
inboundTask.​expectedTimeP90string(date-time)
inboundTask.​expectedTimeP95string(date-time)
inboundTask.​expectedTimesSourcestring(ExpectedTimesSourceEnum)required
Enum"schedule""actual""manual""predicted""external"
inboundTask.​actualTimestring or null(date-time)
inboundTask.​tagsDetailsArray of objects(SimpleTag)read-onlyrequired
inboundTask.​tagsDetails[].​uuidstring(uuid)read-onlyrequired
inboundTask.​tagsDetails[].​categorystringrequired
inboundTask.​tagsDetails[].​valuestringrequired
inboundTask.​tagsDetails[].​requiredboolean
Default false
inboundTask.​tagsDetails[].​colorstring or null
inboundTask.​workspacestring or null(uuid)read-onlyrequired
inboundTask.​isMockboolean
Default false
inboundTask.​metadataAviationStandTaskMetadataSchema (object) or AviationStandDemoTaskMetadataSchema (object)
One of:

Input schema for flights (task) metadata.

inboundTask.​createdAtstring(date-time)read-onlyrequired
inboundTask.​validFromstring(date-time)read-onlyrequired
inboundTask.​validTostring or null(date-time)read-onlyrequired
inboundTask.​planningstring(uuid)read-onlyrequired
inboundTask.​persistedbooleanread-onlyrequired
outboundTaskTaskState (object) or nullread-onlyrequired
One of:
outboundTask.​idstring(uuid)read-onlyrequired
outboundTask.​versionIdstring(uuid)read-onlyrequired
outboundTask.​operationstring(uuid)read-onlyrequired
outboundTask.​rolestring(RoleEnum)read-onlyrequired
Enum"inbound""outbound"
outboundTask.​taskNamestringrequired
outboundTask.​scheduledTimestring(date-time)required
outboundTask.​expectedTimestring(date-time)required
outboundTask.​expectedTimeP05string(date-time)
outboundTask.​expectedTimeP10string(date-time)
outboundTask.​expectedTimeP90string(date-time)
outboundTask.​expectedTimeP95string(date-time)
outboundTask.​expectedTimesSourcestring(ExpectedTimesSourceEnum)required
Enum"schedule""actual""manual""predicted""external"
outboundTask.​actualTimestring or null(date-time)
outboundTask.​tagsDetailsArray of objects(SimpleTag)read-onlyrequired
outboundTask.​tagsDetails[].​uuidstring(uuid)read-onlyrequired
outboundTask.​tagsDetails[].​categorystringrequired
outboundTask.​tagsDetails[].​valuestringrequired
outboundTask.​tagsDetails[].​requiredboolean
Default false
outboundTask.​tagsDetails[].​colorstring or null
outboundTask.​workspacestring or null(uuid)read-onlyrequired
outboundTask.​isMockboolean
Default false
outboundTask.​metadataAviationStandTaskMetadataSchema (object) or AviationStandDemoTaskMetadataSchema (object)
One of:

Input schema for flights (task) metadata.

outboundTask.​createdAtstring(date-time)read-onlyrequired
outboundTask.​validFromstring(date-time)read-onlyrequired
outboundTask.​validTostring or null(date-time)read-onlyrequired
outboundTask.​planningstring(uuid)read-onlyrequired
outboundTask.​persistedbooleanread-onlyrequired
workspacestring or null(uuid)read-onlyrequired
Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "externalId": "string", "planning": "2d429708-7857-4300-9552-6e473ce0d566", "description": "string", "metadata": { "kind": "aviation_stand", "airline": null, "airline_code": null, "aircraft_type": null, "location_code": null, "origin_code": null, "destination_code": null, "wingspan": null, "ground_handler": null, "ac_reg": "string", "etot": null, "eldt": null, "tobt": null, "pegt": null }, "isBlocker": true, "tagsDetails": [ {} ], "operationName": "string", "group": "fbd899a6-8a66-4f51-a95d-68668de198ae", "inboundTask": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "versionId": "14707576-2549-4848-82ed-f68f8a1b47c7", "operation": "fc63ceec-84f0-4df1-a7e8-77c5f8c0b283", "role": "inbound", "taskName": "string", "scheduledTime": "2019-08-24T14:15:22Z", "expectedTime": "2019-08-24T14:15:22Z", "expectedTimeP05": "2019-08-24T14:15:22Z", "expectedTimeP10": "2019-08-24T14:15:22Z", "expectedTimeP90": "2019-08-24T14:15:22Z", "expectedTimeP95": "2019-08-24T14:15:22Z", "expectedTimesSource": "schedule", "actualTime": "2019-08-24T14:15:22Z", "tagsDetails": [], "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89", "isMock": false, "metadata": {}, "createdAt": "2019-08-24T14:15:22Z", "validFrom": "2019-08-24T14:15:22Z", "validTo": "2019-08-24T14:15:22Z", "planning": "2d429708-7857-4300-9552-6e473ce0d566", "persisted": true }, "outboundTask": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "versionId": "14707576-2549-4848-82ed-f68f8a1b47c7", "operation": "fc63ceec-84f0-4df1-a7e8-77c5f8c0b283", "role": "inbound", "taskName": "string", "scheduledTime": "2019-08-24T14:15:22Z", "expectedTime": "2019-08-24T14:15:22Z", "expectedTimeP05": "2019-08-24T14:15:22Z", "expectedTimeP10": "2019-08-24T14:15:22Z", "expectedTimeP90": "2019-08-24T14:15:22Z", "expectedTimeP95": "2019-08-24T14:15:22Z", "expectedTimesSource": "schedule", "actualTime": "2019-08-24T14:15:22Z", "tagsDetails": [], "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89", "isMock": false, "metadata": {}, "createdAt": "2019-08-24T14:15:22Z", "validFrom": "2019-08-24T14:15:22Z", "validTo": "2019-08-24T14:15:22Z", "planning": "2d429708-7857-4300-9552-6e473ce0d566", "persisted": true }, "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89" }

Request

Perform a bulk update for multiple operations. This endpoint is atomic; either all updates succeed or none do.

Security
tokenAuth
Bodyapplication/jsonrequiredArray [
idstring(uuid)
externalIdstring or null
planningstring(uuid)
descriptionstring or null
metadataAviationStandOperationMetadataSchema (object) or AviationStandDemoOperationMetadataSchema (object) or MaritimeBerthOperationMetadataSchema (object)
One of:
isBlockerboolean
groupstring or null(uuid)

Group to which this operation belongs, e.g., a portcall.

inboundTaskobject(TaskState)
outboundTaskobject(TaskState)
tagsArray of strings(uuid)write-only
]
curl -i -X PATCH \
  https://api.acc.adm.wearetransformers.nl/v1/operations/bulk/ \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "externalId": "string",
      "planning": "2d429708-7857-4300-9552-6e473ce0d566",
      "description": "string",
      "metadata": {
        "kind": "aviation_stand",
        "airline": null,
        "airline_code": null,
        "aircraft_type": null,
        "location_code": null,
        "origin_code": null,
        "destination_code": null,
        "wingspan": null,
        "ground_handler": null,
        "ac_reg": "string",
        "etot": null,
        "eldt": null,
        "tobt": null,
        "pegt": null
      },
      "isBlocker": true,
      "group": "fbd899a6-8a66-4f51-a95d-68668de198ae",
      "inboundTask": {
        "taskName": "string",
        "scheduledTime": "2019-08-24T14:15:22Z",
        "expectedTime": "2019-08-24T14:15:22Z",
        "expectedTimeP05": "2019-08-24T14:15:22Z",
        "expectedTimeP10": "2019-08-24T14:15:22Z",
        "expectedTimeP90": "2019-08-24T14:15:22Z",
        "expectedTimeP95": "2019-08-24T14:15:22Z",
        "expectedTimesSource": "schedule",
        "actualTime": "2019-08-24T14:15:22Z",
        "tags": [
          "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        ],
        "isMock": false,
        "metadata": {
          "kind": "aviation_stand",
          "airline": null,
          "airline_code": null,
          "od_code": null,
          "ac_reg": null,
          "aircraft_type": null,
          "cat": null,
          "ground_handler": null
        }
      },
      "outboundTask": {
        "taskName": "string",
        "scheduledTime": "2019-08-24T14:15:22Z",
        "expectedTime": "2019-08-24T14:15:22Z",
        "expectedTimeP05": "2019-08-24T14:15:22Z",
        "expectedTimeP10": "2019-08-24T14:15:22Z",
        "expectedTimeP90": "2019-08-24T14:15:22Z",
        "expectedTimeP95": "2019-08-24T14:15:22Z",
        "expectedTimesSource": "schedule",
        "actualTime": "2019-08-24T14:15:22Z",
        "tags": [
          "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        ],
        "isMock": false,
        "metadata": {
          "kind": "aviation_stand",
          "airline": null,
          "airline_code": null,
          "od_code": null,
          "ac_reg": null,
          "aircraft_type": null,
          "cat": null,
          "ground_handler": null
        }
      },
      "tags": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ]
    }
  ]'

Responses

Bodyapplication/jsonArray [
idstring(uuid)
externalIdstring or null
planningstring(uuid)read-onlyrequired
descriptionstring or null
metadataAviationStandOperationMetadataSchema (object) or AviationStandDemoOperationMetadataSchema (object) or MaritimeBerthOperationMetadataSchema (object)
One of:
isBlockerbooleanrequired
tagsDetailsArray of objects(SimpleTag)read-onlyrequired
tagsDetails[].​uuidstring(uuid)read-onlyrequired
tagsDetails[].​categorystringrequired
tagsDetails[].​valuestringrequired
tagsDetails[].​requiredboolean
Default false
tagsDetails[].​colorstring or null
operationNamestringread-onlyrequired
groupstring or null(uuid)

Group to which this operation belongs, e.g., a portcall.

inboundTaskTaskState (object) or nullread-onlyrequired
One of:
inboundTask.​idstring(uuid)read-onlyrequired
inboundTask.​versionIdstring(uuid)read-onlyrequired
inboundTask.​operationstring(uuid)read-onlyrequired
inboundTask.​rolestring(RoleEnum)read-onlyrequired
Enum"inbound""outbound"
inboundTask.​taskNamestringrequired
inboundTask.​scheduledTimestring(date-time)required
inboundTask.​expectedTimestring(date-time)required
inboundTask.​expectedTimeP05string(date-time)
inboundTask.​expectedTimeP10string(date-time)
inboundTask.​expectedTimeP90string(date-time)
inboundTask.​expectedTimeP95string(date-time)
inboundTask.​expectedTimesSourcestring(ExpectedTimesSourceEnum)required
Enum"schedule""actual""manual""predicted""external"
inboundTask.​actualTimestring or null(date-time)
inboundTask.​tagsDetailsArray of objects(SimpleTag)read-onlyrequired
inboundTask.​tagsDetails[].​uuidstring(uuid)read-onlyrequired
inboundTask.​tagsDetails[].​categorystringrequired
inboundTask.​tagsDetails[].​valuestringrequired
inboundTask.​tagsDetails[].​requiredboolean
Default false
inboundTask.​tagsDetails[].​colorstring or null
inboundTask.​workspacestring or null(uuid)read-onlyrequired
inboundTask.​isMockboolean
Default false
inboundTask.​metadataAviationStandTaskMetadataSchema (object) or AviationStandDemoTaskMetadataSchema (object)
One of:

Input schema for flights (task) metadata.

inboundTask.​createdAtstring(date-time)read-onlyrequired
inboundTask.​validFromstring(date-time)read-onlyrequired
inboundTask.​validTostring or null(date-time)read-onlyrequired
inboundTask.​planningstring(uuid)read-onlyrequired
inboundTask.​persistedbooleanread-onlyrequired
outboundTaskTaskState (object) or nullread-onlyrequired
One of:
outboundTask.​idstring(uuid)read-onlyrequired
outboundTask.​versionIdstring(uuid)read-onlyrequired
outboundTask.​operationstring(uuid)read-onlyrequired
outboundTask.​rolestring(RoleEnum)read-onlyrequired
Enum"inbound""outbound"
outboundTask.​taskNamestringrequired
outboundTask.​scheduledTimestring(date-time)required
outboundTask.​expectedTimestring(date-time)required
outboundTask.​expectedTimeP05string(date-time)
outboundTask.​expectedTimeP10string(date-time)
outboundTask.​expectedTimeP90string(date-time)
outboundTask.​expectedTimeP95string(date-time)
outboundTask.​expectedTimesSourcestring(ExpectedTimesSourceEnum)required
Enum"schedule""actual""manual""predicted""external"
outboundTask.​actualTimestring or null(date-time)
outboundTask.​tagsDetailsArray of objects(SimpleTag)read-onlyrequired
outboundTask.​tagsDetails[].​uuidstring(uuid)read-onlyrequired
outboundTask.​tagsDetails[].​categorystringrequired
outboundTask.​tagsDetails[].​valuestringrequired
outboundTask.​tagsDetails[].​requiredboolean
Default false
outboundTask.​tagsDetails[].​colorstring or null
outboundTask.​workspacestring or null(uuid)read-onlyrequired
outboundTask.​isMockboolean
Default false
outboundTask.​metadataAviationStandTaskMetadataSchema (object) or AviationStandDemoTaskMetadataSchema (object)
One of:

Input schema for flights (task) metadata.

outboundTask.​createdAtstring(date-time)read-onlyrequired
outboundTask.​validFromstring(date-time)read-onlyrequired
outboundTask.​validTostring or null(date-time)read-onlyrequired
outboundTask.​planningstring(uuid)read-onlyrequired
outboundTask.​persistedbooleanread-onlyrequired
workspacestring or null(uuid)read-onlyrequired
]
Response
application/json
[ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "externalId": "string", "planning": "2d429708-7857-4300-9552-6e473ce0d566", "description": "string", "metadata": {}, "isBlocker": true, "tagsDetails": [], "operationName": "string", "group": "fbd899a6-8a66-4f51-a95d-68668de198ae", "inboundTask": {}, "outboundTask": {}, "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89" } ]

Request

List operations, optionally filtering by a time window.

Query params:

  • start_timestamp / end_timestamp (Unix seconds, UTC). Both required to apply the window filter.
  • range_field (one of): expectedTime95Interval → inbound p05 ≤ end AND outbound p95 ≥ start expectedTime90Interval → inbound p10 ≤ end AND outbound p90 ≥ start expectedTime → inbound expected ≤ end AND outbound expected ≥ start scheduledTime → inbound scheduled ≤ end AND outbound scheduled ≥ start
Security
tokenAuth
Path
idstring(uuid)required
Query
end_timestampintegerrequired

End time for filtering operations (Unix timestamp, seconds).

range_fieldstringnon-empty

Which time reference to use for filtering operations.

  • expectedTime95Interval - expectedTime95Interval
  • expectedTime90Interval - expectedTime90Interval
  • expectedTime - expectedTime
  • scheduledTime - scheduledTime
Default "expectedTime95Interval"
Enum"expectedTime95Interval""expectedTime90Interval""expectedTime""scheduledTime"
start_timestampintegerrequired

Start time for filtering operations (Unix timestamp, seconds).

curl -i -X GET \
  'https://api.acc.adm.wearetransformers.nl/v1/plannings/{id}/operations/?end_timestamp=0&range_field=expectedTime95Interval&start_timestamp=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [
idstring(uuid)
externalIdstring or null
planningstring(uuid)read-onlyrequired
descriptionstring or null
metadataAviationStandOperationMetadataSchema (object) or AviationStandDemoOperationMetadataSchema (object) or MaritimeBerthOperationMetadataSchema (object)
One of:
isBlockerbooleanrequired
tagsDetailsArray of objects(SimpleTag)read-onlyrequired
tagsDetails[].​uuidstring(uuid)read-onlyrequired
tagsDetails[].​categorystringrequired
tagsDetails[].​valuestringrequired
tagsDetails[].​requiredboolean
Default false
tagsDetails[].​colorstring or null
operationNamestringread-onlyrequired
groupstring or null(uuid)

Group to which this operation belongs, e.g., a portcall.

inboundTaskTaskState (object) or nullread-onlyrequired
One of:
inboundTask.​idstring(uuid)read-onlyrequired
inboundTask.​versionIdstring(uuid)read-onlyrequired
inboundTask.​operationstring(uuid)read-onlyrequired
inboundTask.​rolestring(RoleEnum)read-onlyrequired
Enum"inbound""outbound"
inboundTask.​taskNamestringrequired
inboundTask.​scheduledTimestring(date-time)required
inboundTask.​expectedTimestring(date-time)required
inboundTask.​expectedTimeP05string(date-time)
inboundTask.​expectedTimeP10string(date-time)
inboundTask.​expectedTimeP90string(date-time)
inboundTask.​expectedTimeP95string(date-time)
inboundTask.​expectedTimesSourcestring(ExpectedTimesSourceEnum)required
Enum"schedule""actual""manual""predicted""external"
inboundTask.​actualTimestring or null(date-time)
inboundTask.​tagsDetailsArray of objects(SimpleTag)read-onlyrequired
inboundTask.​tagsDetails[].​uuidstring(uuid)read-onlyrequired
inboundTask.​tagsDetails[].​categorystringrequired
inboundTask.​tagsDetails[].​valuestringrequired
inboundTask.​tagsDetails[].​requiredboolean
Default false
inboundTask.​tagsDetails[].​colorstring or null
inboundTask.​workspacestring or null(uuid)read-onlyrequired
inboundTask.​isMockboolean
Default false
inboundTask.​metadataAviationStandTaskMetadataSchema (object) or AviationStandDemoTaskMetadataSchema (object)
One of:

Input schema for flights (task) metadata.

inboundTask.​createdAtstring(date-time)read-onlyrequired
inboundTask.​validFromstring(date-time)read-onlyrequired
inboundTask.​validTostring or null(date-time)read-onlyrequired
inboundTask.​planningstring(uuid)read-onlyrequired
inboundTask.​persistedbooleanread-onlyrequired
outboundTaskTaskState (object) or nullread-onlyrequired
One of:
outboundTask.​idstring(uuid)read-onlyrequired
outboundTask.​versionIdstring(uuid)read-onlyrequired
outboundTask.​operationstring(uuid)read-onlyrequired
outboundTask.​rolestring(RoleEnum)read-onlyrequired
Enum"inbound""outbound"
outboundTask.​taskNamestringrequired
outboundTask.​scheduledTimestring(date-time)required
outboundTask.​expectedTimestring(date-time)required
outboundTask.​expectedTimeP05string(date-time)
outboundTask.​expectedTimeP10string(date-time)
outboundTask.​expectedTimeP90string(date-time)
outboundTask.​expectedTimeP95string(date-time)
outboundTask.​expectedTimesSourcestring(ExpectedTimesSourceEnum)required
Enum"schedule""actual""manual""predicted""external"
outboundTask.​actualTimestring or null(date-time)
outboundTask.​tagsDetailsArray of objects(SimpleTag)read-onlyrequired
outboundTask.​tagsDetails[].​uuidstring(uuid)read-onlyrequired
outboundTask.​tagsDetails[].​categorystringrequired
outboundTask.​tagsDetails[].​valuestringrequired
outboundTask.​tagsDetails[].​requiredboolean
Default false
outboundTask.​tagsDetails[].​colorstring or null
outboundTask.​workspacestring or null(uuid)read-onlyrequired
outboundTask.​isMockboolean
Default false
outboundTask.​metadataAviationStandTaskMetadataSchema (object) or AviationStandDemoTaskMetadataSchema (object)
One of:

Input schema for flights (task) metadata.

outboundTask.​createdAtstring(date-time)read-onlyrequired
outboundTask.​validFromstring(date-time)read-onlyrequired
outboundTask.​validTostring or null(date-time)read-onlyrequired
outboundTask.​planningstring(uuid)read-onlyrequired
outboundTask.​persistedbooleanread-onlyrequired
workspacestring or null(uuid)read-onlyrequired
]
Response
application/json
[ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "externalId": "string", "planning": "2d429708-7857-4300-9552-6e473ce0d566", "description": "string", "metadata": {}, "isBlocker": true, "tagsDetails": [], "operationName": "string", "group": "fbd899a6-8a66-4f51-a95d-68668de198ae", "inboundTask": {}, "outboundTask": {}, "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89" } ]

Request

Search within a planning by external_id.

Security
tokenAuth
Path
idstring(uuid)required
Bodyapplication/jsonrequired
externalIdstringrequired

Exact value match.

curl -i -X POST \
  'https://api.acc.adm.wearetransformers.nl/v1/plannings/{id}/operations/search/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "externalId": "string"
  }'

Responses

Bodyapplication/jsonArray [
idstring(uuid)
externalIdstring or null
planningstring(uuid)read-onlyrequired
descriptionstring or null
metadataAviationStandOperationMetadataSchema (object) or AviationStandDemoOperationMetadataSchema (object) or MaritimeBerthOperationMetadataSchema (object)
One of:
isBlockerbooleanrequired
tagsDetailsArray of objects(SimpleTag)read-onlyrequired
tagsDetails[].​uuidstring(uuid)read-onlyrequired
tagsDetails[].​categorystringrequired
tagsDetails[].​valuestringrequired
tagsDetails[].​requiredboolean
Default false
tagsDetails[].​colorstring or null
operationNamestringread-onlyrequired
groupstring or null(uuid)

Group to which this operation belongs, e.g., a portcall.

inboundTaskTaskState (object) or nullread-onlyrequired
One of:
inboundTask.​idstring(uuid)read-onlyrequired
inboundTask.​versionIdstring(uuid)read-onlyrequired
inboundTask.​operationstring(uuid)read-onlyrequired
inboundTask.​rolestring(RoleEnum)read-onlyrequired
Enum"inbound""outbound"
inboundTask.​taskNamestringrequired
inboundTask.​scheduledTimestring(date-time)required
inboundTask.​expectedTimestring(date-time)required
inboundTask.​expectedTimeP05string(date-time)
inboundTask.​expectedTimeP10string(date-time)
inboundTask.​expectedTimeP90string(date-time)
inboundTask.​expectedTimeP95string(date-time)
inboundTask.​expectedTimesSourcestring(ExpectedTimesSourceEnum)required
Enum"schedule""actual""manual""predicted""external"
inboundTask.​actualTimestring or null(date-time)
inboundTask.​tagsDetailsArray of objects(SimpleTag)read-onlyrequired
inboundTask.​tagsDetails[].​uuidstring(uuid)read-onlyrequired
inboundTask.​tagsDetails[].​categorystringrequired
inboundTask.​tagsDetails[].​valuestringrequired
inboundTask.​tagsDetails[].​requiredboolean
Default false
inboundTask.​tagsDetails[].​colorstring or null
inboundTask.​workspacestring or null(uuid)read-onlyrequired
inboundTask.​isMockboolean
Default false
inboundTask.​metadataAviationStandTaskMetadataSchema (object) or AviationStandDemoTaskMetadataSchema (object)
One of:

Input schema for flights (task) metadata.

inboundTask.​createdAtstring(date-time)read-onlyrequired
inboundTask.​validFromstring(date-time)read-onlyrequired
inboundTask.​validTostring or null(date-time)read-onlyrequired
inboundTask.​planningstring(uuid)read-onlyrequired
inboundTask.​persistedbooleanread-onlyrequired
outboundTaskTaskState (object) or nullread-onlyrequired
One of:
outboundTask.​idstring(uuid)read-onlyrequired
outboundTask.​versionIdstring(uuid)read-onlyrequired
outboundTask.​operationstring(uuid)read-onlyrequired
outboundTask.​rolestring(RoleEnum)read-onlyrequired
Enum"inbound""outbound"
outboundTask.​taskNamestringrequired
outboundTask.​scheduledTimestring(date-time)required
outboundTask.​expectedTimestring(date-time)required
outboundTask.​expectedTimeP05string(date-time)
outboundTask.​expectedTimeP10string(date-time)
outboundTask.​expectedTimeP90string(date-time)
outboundTask.​expectedTimeP95string(date-time)
outboundTask.​expectedTimesSourcestring(ExpectedTimesSourceEnum)required
Enum"schedule""actual""manual""predicted""external"
outboundTask.​actualTimestring or null(date-time)
outboundTask.​tagsDetailsArray of objects(SimpleTag)read-onlyrequired
outboundTask.​tagsDetails[].​uuidstring(uuid)read-onlyrequired
outboundTask.​tagsDetails[].​categorystringrequired
outboundTask.​tagsDetails[].​valuestringrequired
outboundTask.​tagsDetails[].​requiredboolean
Default false
outboundTask.​tagsDetails[].​colorstring or null
outboundTask.​workspacestring or null(uuid)read-onlyrequired
outboundTask.​isMockboolean
Default false
outboundTask.​metadataAviationStandTaskMetadataSchema (object) or AviationStandDemoTaskMetadataSchema (object)
One of:

Input schema for flights (task) metadata.

outboundTask.​createdAtstring(date-time)read-onlyrequired
outboundTask.​validFromstring(date-time)read-onlyrequired
outboundTask.​validTostring or null(date-time)read-onlyrequired
outboundTask.​planningstring(uuid)read-onlyrequired
outboundTask.​persistedbooleanread-onlyrequired
workspacestring or null(uuid)read-onlyrequired
]
Response
application/json
[ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "externalId": "string", "planning": "2d429708-7857-4300-9552-6e473ce0d566", "description": "string", "metadata": {}, "isBlocker": true, "tagsDetails": [], "operationName": "string", "group": "fbd899a6-8a66-4f51-a95d-68668de198ae", "inboundTask": {}, "outboundTask": {}, "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89" } ]

Updating details (time, uncertainty) of individual tasks within operations.

Operations

Managing the assignment of operations to resources (CRUD, bulk operations, deactivation, listing per operation).

Operations

Resolving specific scheduling conflicts using heuristic search methods (streaming and non-streaming).

Operations

Globally optimizing the schedule using one of the solvers to minimize conflicts and reassignments while optimizing for rules.

Operations

Managing the plannings and organizations you have access to.

Operations

Interacting with the conversational AI assistant for planning and queries.

Operations

Utility endpoints, such as generating schedule visualizations.

Operations

API authentication token management (e.g., obtaining auth tokens).

Our mechanism for indicating constraints, penalties or preferences.

Operations

Can be used together with Tags to specify preferences or penalties.

Operations
Operations
Operations
Operations
Operations
Operations
Operations