API Reference
/
Locations

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

Creates a new location

Request

Creates a new location.

Security
tokenAuth
Bodyapplication/jsonrequired
externalIdstring or null
namestring<= 100 charactersrequired
planningstring(uuid)required
metadataobject
curl -i -X POST \
  https://api.acc.adm.wearetransformers.nl/v1/locations/ \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "externalId": "string",
    "name": "string",
    "planning": "2d429708-7857-4300-9552-6e473ce0d566",
    "metadata": {}
  }'

Responses

Bodyapplication/json
idstring(uuid)read-onlyrequired
externalIdstring or null
namestring<= 100 charactersrequired
resourcesArray of objects(Resource)read-onlyrequired
resources[].​idstring(uuid)read-onlyrequired
resources[].​externalIdstring or null
resources[].​namestring<= 100 charactersrequired
resources[].​orderingnumber(double)
resources[].​tagsArray of strings(uuid)required
resources[].​locationstring(uuid)required
resources[].​requiredTagsArray of stringsread-onlyrequired
resources[].​metadataMaritimeBerthResourceMetadataSchema (object)
One of:

Input schema for maritime berth resource metadata.

planningstring(uuid)required
metadataobject
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "externalId": "string",
  "name": "string",
  "resources": [
    { … }
  ],
  "planning": "2d429708-7857-4300-9552-6e473ce0d566",
  "metadata": {}
}

Updates an existing location

Request

Updates an existing location.

Security
tokenAuth
Path
idstring(uuid)required
Bodyapplication/json
externalIdstring or null
namestring<= 100 characters
planningstring(uuid)
metadataobject
curl -i -X PATCH \
  'https://api.acc.adm.wearetransformers.nl/v1/locations/{id}/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "externalId": "string",
    "name": "string",
    "planning": "2d429708-7857-4300-9552-6e473ce0d566",
    "metadata": {}
  }'

Responses

Bodyapplication/json
idstring(uuid)read-onlyrequired
externalIdstring or null
namestring<= 100 charactersrequired
resourcesArray of objects(Resource)read-onlyrequired
resources[].​idstring(uuid)read-onlyrequired
resources[].​externalIdstring or null
resources[].​namestring<= 100 charactersrequired
resources[].​orderingnumber(double)
resources[].​tagsArray of strings(uuid)required
resources[].​locationstring(uuid)required
resources[].​requiredTagsArray of stringsread-onlyrequired
resources[].​metadataMaritimeBerthResourceMetadataSchema (object)
One of:

Input schema for maritime berth resource metadata.

planningstring(uuid)required
metadataobject
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "externalId": "string",
  "name": "string",
  "resources": [
    { … }
  ],
  "planning": "2d429708-7857-4300-9552-6e473ce0d566",
  "metadata": {}
}

Get all locations and resources for a planing

Request

List a nested result of locations and resources for a planning.

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

Responses

Bodyapplication/jsonArray [
idstring(uuid)read-onlyrequired
externalIdstring or null
namestring<= 100 charactersrequired
resourcesArray of objects(Resource)read-onlyrequired
resources[].​idstring(uuid)read-onlyrequired
resources[].​externalIdstring or null
resources[].​namestring<= 100 charactersrequired
resources[].​orderingnumber(double)
resources[].​tagsArray of strings(uuid)required
resources[].​locationstring(uuid)required
resources[].​requiredTagsArray of stringsread-onlyrequired
resources[].​metadataMaritimeBerthResourceMetadataSchema (object)
One of:

Input schema for maritime berth resource metadata.

planningstring(uuid)required
metadataobject
]
Response
application/json
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "externalId": "string",
    "name": "string",
    "resources": [ … ],
    "planning": "2d429708-7857-4300-9552-6e473ce0d566",
    "metadata": {}
  }
]

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

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