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

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

Request

Returns the assignment version history for a specific operation.

Shows all historical assignment states with timestamps, who made the assignment, and field-level diffs between versions.

If X-Workspace-Id header is provided, includes workspace draft assignments merged with mainline history. Workspace drafts appear alongside mainline assignments (not replacing them).

Security
tokenAuth
Path
operation_idstringrequired

UUID of the operation

Query
include_diffsboolean

Include field-level diffs (default true)

limitinteger

Maximum number of versions to return (default 50, max 200)

offsetinteger

Pagination offset

Headers
X-Workspace-Idstring

Optional workspace UUID to include draft assignments

curl -i -X GET \
  'https://api.acc.adm.wearetransformers.nl/v1/operations/{operation_id}/assignments/history/?include_diffs=true&limit=0&offset=0' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'X-Workspace-Id: string'

Responses

Bodyapplication/json
operationIdstring(uuid)required
workspacestring or null(uuid)required
totalintegerrequired
versionsArray of objects(AssignmentHistoryVersion)required
versions[].​assignmentIdstring(uuid)required
versions[].​validFromstring(date-time)required
versions[].​validTostring or null(date-time)required
versions[].​changeIdstring or null(uuid)required
versions[].​closedByChangeIdstring or null(uuid)
versions[].​changeTypestring(ChangeTypeEnum)required
  • created - created
  • updated - updated
  • deleted - deleted
Enum"created""updated""deleted"
versions[].​sourcestring(SourceEnum)required
  • mainline - mainline
  • workspace - workspace
Enum"mainline""workspace"
versions[].​assignedByUser (object) or nullrequired
One of:
versions[].​assignedBy.​idintegerread-onlyrequired
versions[].​assignedBy.​usernamestring<= 150 characters^[\w.@+-]+$required

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

versions[].​assignedBy.​firstNamestringrequired
versions[].​assignedBy.​lastNamestringrequired
versions[].​assignedBy.​uuidstring(uuid)
versions[].​assignedBy.​groupsArray of strings(GroupsEnum)read-onlyrequired
Items Enum"ADM View Only""ADM Planner""ADM Flight Manager""ADM Resource Configurator""ADM Rules & Tags Configurator"
versions[].​tombstonebooleanrequired
versions[].​beforeany or nullrequired
One of:
any
versions[].​afterany or nullrequired
One of:
any
versions[].​changesArray of objects(StateDiffChange)required
versions[].​changes[].​fieldstringrequired
versions[].​changes[].​beforeany or nullrequired
One of:
any
versions[].​changes[].​afterany or nullrequired
One of:
any
Response
application/json
{ "operationId": "3051932a-fdd2-48fa-b330-7e7d41535969", "workspace": "3f216741-15dd-4e46-b5ac-0077a2640e89", "total": 0, "versions": [ {} ] }
Operations
Operations