API Reference
/
Tasks

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
schema.json
schema.yaml
Languages
Servers
Acceptance Environment

https://api.acc.adm.wearetransformers.nl/

Users

User management (authentication, current user details).

Operations

Locations

Managing locations and viewing their associated resources.

Operations

Resources

Managing resources (CRUD, listing).

Operations

Operations

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

Operations

Tasks

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

Operations

Bulk patch Tasks Operations

Request

Perform a bulk update of tasks for multiple operations. Can be used for updating tasks from e.g. some external forecasting mechanism.

Security
tokenAuth
Query
end_timestampinteger

End time for filtering operations (Unix timestamp).

start_timestampinteger

Start time for filtering operations (Unix timestamp).

versionstring

Version of tasks to return. Options: 'latest', 'first'.

Enum"first""latest"
Bodyapplication/jsonrequired
operationsArray of objects(Operations)required
operations[].​operationIdstring(Operationid)required
operations[].​inboundTaskTaskUpdate (object) or nullrequired
Any of:
operations[].​inboundTask.​plannedTimePlannedtime (string) or Plannedtime (null)(Plannedtime)required
Any of:
string(Plannedtime)
operations[].​inboundTask.​expectedTimeExpectedtime (string) or Expectedtime (null)(Expectedtime)required
Any of:
string(Expectedtime)
operations[].​inboundTask.​sigmaSigma (number) or Sigma (null)(Sigma)
Default null
Any of:
>= 0
number(Sigma)>= 0
Default null
operations[].​inboundTask.​skewFactorSkewfactor (number) or Skewfactor (null)(Skewfactor)required
Any of:
number(Skewfactor)
operations[].​inboundTask.​distributionMeanDistributionmean (string) or Distributionmean (null)(Distributionmean)required
Any of:
string(Distributionmean)
operations[].​inboundTask.​actualTimeActualtime (string) or Actualtime (null)(Actualtime)required
Any of:
string(Actualtime)
operations[].​outboundTaskTaskUpdate (object) or nullrequired
Any of:
operations[].​outboundTask.​plannedTimePlannedtime (string) or Plannedtime (null)(Plannedtime)required
Any of:
string(Plannedtime)
operations[].​outboundTask.​expectedTimeExpectedtime (string) or Expectedtime (null)(Expectedtime)required
Any of:
string(Expectedtime)
operations[].​outboundTask.​sigmaSigma (number) or Sigma (null)(Sigma)
Default null
Any of:
>= 0
number(Sigma)>= 0
Default null
operations[].​outboundTask.​skewFactorSkewfactor (number) or Skewfactor (null)(Skewfactor)required
Any of:
number(Skewfactor)
operations[].​outboundTask.​distributionMeanDistributionmean (string) or Distributionmean (null)(Distributionmean)required
Any of:
string(Distributionmean)
operations[].​outboundTask.​actualTimeActualtime (string) or Actualtime (null)(Actualtime)required
Any of:
string(Actualtime)
curl -i -X PATCH \
  'https://api.acc.adm.wearetransformers.nl/v1/operations/tasks/bulk/?end_timestamp=0&start_timestamp=0&version=first' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "operations": [
      {
        "operationId": "string",
        "inboundTask": {
          "plannedTime": "string",
          "expectedTime": "string",
          "sigma": null,
          "skewFactor": 0,
          "distributionMean": "string",
          "actualTime": "string"
        },
        "outboundTask": {
          "plannedTime": "string",
          "expectedTime": "string",
          "sigma": null,
          "skewFactor": 0,
          "distributionMean": "string",
          "actualTime": "string"
        }
      }
    ]
  }'

Responses

Bodyapplication/jsonArray [
idstring(uuid)
externalIdstring or null
inboundTaskobject(Task)required
inboundTask.​taskNamestringrequired
inboundTask.​plannedTimestring(date-time)required
inboundTask.​expectedTimestring(date-time)required
inboundTask.​sigmanumber(double)>= 0required
inboundTask.​skewFactornumber(double)required
inboundTask.​actualTimestring or null(date-time)required
inboundTask.​distributionMeanstring or null(date-time)required
inboundTask.​distributionEarlieststring(date-time)read-onlyrequired
inboundTask.​distributionLateststring(date-time)read-onlyrequired
inboundTask.​createdAtstring(date-time)read-onlyrequired
inboundTask.​updatedAtstring(date-time)read-onlyrequired
inboundTask.​validFromstring(date-time)read-onlyrequired
inboundTask.​validTostring(date-time)read-onlyrequired
inboundTask.​imposedDelayInSecondsinteger
inboundTask.​derivedExpectedTimestring(date-time)read-onlyrequired
inboundTask.​isMockboolean
Default false
outboundTaskobject(Task)required
outboundTask.​taskNamestringrequired
outboundTask.​plannedTimestring(date-time)required
outboundTask.​expectedTimestring(date-time)required
outboundTask.​sigmanumber(double)>= 0required
outboundTask.​skewFactornumber(double)required
outboundTask.​actualTimestring or null(date-time)required
outboundTask.​distributionMeanstring or null(date-time)required
outboundTask.​distributionEarlieststring(date-time)read-onlyrequired
outboundTask.​distributionLateststring(date-time)read-onlyrequired
outboundTask.​createdAtstring(date-time)read-onlyrequired
outboundTask.​updatedAtstring(date-time)read-onlyrequired
outboundTask.​validFromstring(date-time)read-onlyrequired
outboundTask.​validTostring(date-time)read-onlyrequired
outboundTask.​imposedDelayInSecondsinteger
outboundTask.​derivedExpectedTimestring(date-time)read-onlyrequired
outboundTask.​isMockboolean
Default false
metadataAviationStandMetadataSchema (object) or MaritimeBerthOperationMetadataSchema (object)
One of:
operationNamestringread-onlyrequired
isFixedToResourcebooleanrequired
tagsArray of strings(uuid)required
requiredTagsArray of stringsread-onlyrequired
planningstring(uuid)required
descriptionstring or null
operationDependenciesArray of objects(OperationDependency)read-onlyrequired
operationDependencies[].​idstring(uuid)read-onlyrequired
operationDependencies[].​fromOperationstring(uuid)required
operationDependencies[].​toOperationstring(uuid)required
operationDependencies[].​typestring(OperationDependencyTypeEnum)required
  • PRECEDENCE - Precedence
  • GAP - Gap
Enum"PRECEDENCE""GAP"
operationDependencies[].​minOffsetinteger or null
operationDependencies[].​maxOffsetinteger or null
operationDependencies[].​createdAtstring(date-time)read-onlyrequired
operationDependencies[].​updatedAtstring(date-time)read-onlyrequired
groupstring or null(uuid)

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

]
Response
application/json
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "externalId": "string",
    "inboundTask": { … },
    "outboundTask": { … },
    "metadata": { … },
    "operationName": "string",
    "isFixedToResource": true,
    "tags": [ … ],
    "requiredTags": [ … ],
    "planning": "2d429708-7857-4300-9552-6e473ce0d566",
    "description": "string",
    "operationDependencies": [ … ],
    "group": "fbd899a6-8a66-4f51-a95d-68668de198ae"
  }
]

Assignments

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

Operations

Conflict Resolution

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

Operations

Optimization

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

Operations

Organizations & Planning

Managing the plannings and organizations you have access to.

Operations

AI Agent

Interacting with the conversational AI assistant for planning and queries.

Operations

Utility

Utility endpoints, such as generating schedule visualizations.

Operations

Token

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

Operations

Tags

Our mechanism for indicating constraints, penalties or preferences.

Operations

Rules

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

Operations

Dependencies

Operations

Operation Groups

Operations
Copyright © Transformers Group