Skip to content
API Reference/
/
Creates a new planning fo...

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

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

Get all organizations for the authenticated user

Request

Get all organizations for the authenticated user.

Security
tokenAuth
curl -i -X GET \
  https://api.acc.adm.wearetransformers.nl/v1/organizations/ \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [
idstring(uuid)read-onlyrequired
namestring<= 255 charactersrequired
planningsArray of objects(PlanningSummery)read-onlyrequired
plannings[].​idstring(uuid)read-onlyrequired
plannings[].​namestring<= 255 charactersrequired
plannings[].​createdAtstring(date-time)read-onlyrequired
plannings[].​pluginstring<= 30 charactersrequired

Name of installed planning plug-in (e.g. 'stand', 'berth').

plannings[].​timezonestringread-onlyrequired
plannings[].​freezeWindowintegerread-onlyrequired
]
Response
application/json
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "plannings": [ … ]
  }
]

Get all plannings for an organization

Request

Get all plannings for an organization.

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

Responses

Bodyapplication/jsonArray [
idstring(uuid)read-onlyrequired
namestring<= 255 charactersrequired
pluginstringrequired
created_atstring(date-time)read-onlyrequired
locationsArray of strings(uuid)required
descriptionstring
solversArray of objects(SolverStrategy)read-onlyrequired
solvers[].​namestringrequired
solvers[].​displayNamestringrequired
solvers[].​descriptionstringrequired
solvers[].​isDefaultbooleanrequired
solvers[].​isAvailablebooleanrequired
solvers[].​isBetabooleanrequired
timezonestring
freezeWindowinteger
]
Response
application/json
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "plugin": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "locations": [ … ],
    "description": "string",
    "solvers": [ … ],
    "timezone": "string",
    "freezeWindow": 0
  }
]

Creates a new planning for an organization

Request

Creates a new planning associated with an organization.

Security
tokenAuth
Path
org_pkstring(uuid)required
Bodyapplication/jsonrequired
namestring<= 255 charactersrequired
pluginstringrequired
locationsArray of strings(uuid)required
descriptionstring
timezonestring
freezeWindowinteger
curl -i -X POST \
  'https://api.acc.adm.wearetransformers.nl/v1/organizations/{org_pk}/plannings/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "plugin": "string",
    "locations": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "description": "string",
    "timezone": "string",
    "freezeWindow": 0
  }'

Responses

Bodyapplication/json
idstring(uuid)read-onlyrequired
namestring<= 255 charactersrequired
pluginstringrequired
created_atstring(date-time)read-onlyrequired
locationsArray of strings(uuid)required
descriptionstring
solversArray of objects(SolverStrategy)read-onlyrequired
solvers[].​namestringrequired
solvers[].​displayNamestringrequired
solvers[].​descriptionstringrequired
solvers[].​isDefaultbooleanrequired
solvers[].​isAvailablebooleanrequired
solvers[].​isBetabooleanrequired
timezonestring
freezeWindowinteger
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "plugin": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "locations": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "description": "string",
  "solvers": [
    { … }
  ],
  "timezone": "string",
  "freezeWindow": 0
}

Updates a planning

Request

Updates an existing planning.

Security
tokenAuth
Path
idstring(uuid)required
org_pkstring(uuid)required
Bodyapplication/json
namestring<= 255 characters
pluginstring
locationsArray of strings(uuid)
descriptionstring
timezonestring
freezeWindowinteger
curl -i -X PATCH \
  'https://api.acc.adm.wearetransformers.nl/v1/organizations/{org_pk}/plannings/{id}/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "plugin": "string",
    "locations": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "description": "string",
    "timezone": "string",
    "freezeWindow": 0
  }'

Responses

Bodyapplication/json
idstring(uuid)read-onlyrequired
namestring<= 255 charactersrequired
pluginstringrequired
created_atstring(date-time)read-onlyrequired
locationsArray of strings(uuid)required
descriptionstring
solversArray of objects(SolverStrategy)read-onlyrequired
solvers[].​namestringrequired
solvers[].​displayNamestringrequired
solvers[].​descriptionstringrequired
solvers[].​isDefaultbooleanrequired
solvers[].​isAvailablebooleanrequired
solvers[].​isBetabooleanrequired
timezonestring
freezeWindowinteger
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "plugin": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "locations": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "description": "string",
  "solvers": [
    { … }
  ],
  "timezone": "string",
  "freezeWindow": 0
}

Delete a planning

Request

Deletes a planning and all associated resources.

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

Responses

No Content

Response
No content

Get all metadata for a planning

Request

Gets all metadata for a planning like solvers etc.

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

Responses

Bodyapplication/json
idstring(uuid)read-onlyrequired
organization_idstring(uuid)read-onlyrequired
namestring<= 255 charactersrequired
created_atstring(date-time)read-onlyrequired
descriptionstringread-onlyrequired
solversArray of objects(SolverStrategy)read-onlyrequired
solvers[].​namestringrequired
solvers[].​displayNamestringrequired
solvers[].​descriptionstringrequired
solvers[].​isDefaultbooleanrequired
solvers[].​isAvailablebooleanrequired
solvers[].​isBetabooleanrequired
pluginstringread-onlyrequired
timezonestringread-onlyrequired
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "name": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "description": "string",
  "solvers": [
    { … }
  ],
  "plugin": "string",
  "timezone": "string"
}

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).

Tags

Our mechanism for indicating constraints, penalties or preferences.

Operations

Rules

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

Operations

Authentication

Operations

Entity History

Operations

Operation Groups

Operations

Assignment History

Operations

Plannings

Operations

Workspaces

Operations
Copyright © Transformers Group