API Reference
/
Assignments

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

Assignments

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

Operations

Create Assignment

Request

Creates a new assignment for an operation to a resource. Automatically deactivates any existing active assignment for the same operation.

Security
tokenAuth
Bodyapplication/jsonrequired
idstring(uuid)
operationstring(uuid)required
resourcestring(uuid)required
planningstring(uuid)required
metadataMaritimeBerthAssignmentMetadataSchema (object)
One of:

Input schema for maritime berth assignment metadata.

curl -i -X POST \
  https://api.acc.adm.wearetransformers.nl/v1/assignments/ \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "operation": "fc63ceec-84f0-4df1-a7e8-77c5f8c0b283",
    "resource": "d008879e-b5d9-47da-af4e-3c8f40b7c9ee",
    "planning": "2d429708-7857-4300-9552-6e473ce0d566",
    "metadata": {
      "kind": "maritime_berth",
      "position": null
    }
  }'

Responses

Bodyapplication/json
idstring(uuid)
operationstring(uuid)required
resourcestring(uuid)required
assignedAtstring(date-time)read-onlyrequired
activebooleanread-onlyrequired
assignedBystringread-onlyrequired
locationstringread-onlyrequired
planningstring(uuid)required
metadataMaritimeBerthAssignmentMetadataSchema (object)
One of:

Input schema for maritime berth assignment metadata.

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "operation": "fc63ceec-84f0-4df1-a7e8-77c5f8c0b283",
  "resource": "d008879e-b5d9-47da-af4e-3c8f40b7c9ee",
  "assignedAt": "2019-08-24T14:15:22Z",
  "active": true,
  "assignedBy": "string",
  "location": "string",
  "planning": "2d429708-7857-4300-9552-6e473ce0d566",
  "metadata": {
    "kind": "maritime_berth",
    "position": null
  }
}

Deactivate an assignment

Request

Deactivates an assignment of an operation to a resource. The assignment is still kept for a historical record.

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

Responses

Bodyapplication/json
idstring(uuid)
operationstring(uuid)required
resourcestring(uuid)required
assignedAtstring(date-time)read-onlyrequired
activebooleanread-onlyrequired
assignedBystringread-onlyrequired
locationstringread-onlyrequired
planningstring(uuid)required
metadataMaritimeBerthAssignmentMetadataSchema (object)
One of:

Input schema for maritime berth assignment metadata.

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "operation": "fc63ceec-84f0-4df1-a7e8-77c5f8c0b283",
  "resource": "d008879e-b5d9-47da-af4e-3c8f40b7c9ee",
  "assignedAt": "2019-08-24T14:15:22Z",
  "active": true,
  "assignedBy": "string",
  "location": "string",
  "planning": "2d429708-7857-4300-9552-6e473ce0d566",
  "metadata": {
    "kind": "maritime_berth",
    "position": null
  }
}

Bulk create assignments

Request

Create multiple assignments in a single request.

Security
tokenAuth
Bodyapplication/jsonrequired
assignmentsArray of objects(Assignments)required
assignments[].​idId (string) or Id (null)(Id)required
Any of:
string(Id)
assignments[].​operationstring(Operation)required
assignments[].​resourcestring(Resource)required
assignments[].​planningstring(Planning)required
assignments[].​activeboolean(Active)required
assignments[].​metadataMaritimeBerthAssignmentMetadataSchema (object) or null

Metadata for the assignment, adhering to the metadata schema.

Default null
Any of:

Metadata for the assignment, adhering to the metadata schema.

curl -i -X POST \
  https://api.acc.adm.wearetransformers.nl/v1/assignments/bulk/ \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "assignments": [
      {
        "id": "string",
        "operation": "string",
        "resource": "string",
        "planning": "string",
        "active": true,
        "metadata": null
      }
    ]
  }'

Responses

Bodyapplication/json
created_assignmentsArray of objects(Created Assignments)required
created_assignments[].​idId (string) or Id (null)(Id)required
Any of:
string(Id)
created_assignments[].​operationstring(Operation)required
created_assignments[].​resourcestring(Resource)required
created_assignments[].​planningstring(Planning)required
created_assignments[].​activeboolean(Active)required
created_assignments[].​metadataMaritimeBerthAssignmentMetadataSchema (object) or null

Metadata for the assignment, adhering to the metadata schema.

Default null
Any of:

Metadata for the assignment, adhering to the metadata schema.

Response
application/json
{
  "created_assignments": [
    { … }
  ]
}

v1_plannings_assignments_list

Request

Return a list of assignments filtered by a timestamp range if provided. Only include assignments for operations within the given time range.

Security
tokenAuth
Path
idstring(uuid)required
Query
activeboolean

Filter assignments by active status

Default true
end_timestampinteger

End time for filtering assignments (Unix timestamp).

limitinteger

Limit the number of results

operationinteger

Filter by operation ID

start_timestampinteger

Start time for filtering assignments (Unix timestamp).

curl -i -X GET \
  'https://api.acc.adm.wearetransformers.nl/v1/plannings/{id}/assignments/?active=true&end_timestamp=0&limit=0&operation=0&start_timestamp=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [
idstring(uuid)
operationstring(uuid)required
resourcestring(uuid)required
assignedAtstring(date-time)read-onlyrequired
activebooleanread-onlyrequired
assignedBystringread-onlyrequired
locationstringread-onlyrequired
planningstring(uuid)required
metadataMaritimeBerthAssignmentMetadataSchema (object)
One of:

Input schema for maritime berth assignment metadata.

]
Response
application/json
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "operation": "fc63ceec-84f0-4df1-a7e8-77c5f8c0b283",
    "resource": "d008879e-b5d9-47da-af4e-3c8f40b7c9ee",
    "assignedAt": "2019-08-24T14:15:22Z",
    "active": true,
    "assignedBy": "string",
    "location": "string",
    "planning": "2d429708-7857-4300-9552-6e473ce0d566",
    "metadata": { … }
  }
]

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