API docs by Redocly

adiutaOpt (v9.3.3)

Download OpenAPI specification:

adiutaByte GmbH: info@adiutabyte.de URL: https://adiutabyte.de

Introduction

Welcome to the adiutaOpt API documentation!

This document specifies all endpoints and schema requirements. If you notice an error, please contact us.

The typical process of an optimization request looks as follows:

  • Obtain authentication tokens
  • Use authentication tokens to post an input data set to the optimization request endpoint. If everything is in order, a key will be returned that has to be stored
    • If the request was rejected, check authentication details and schema. The return code and data will give some hints as to what needs to be fixed.
  • Use the authentication token and the key on the solution endpoint to request the solved data.
    • If the plan is still in calculation, wait until it's done
    • If the calculation has finished, store the solution
  • Check if the calculation could be carried out or if an error was returned (see ErrorPlan as possible return data of the solution endpoint)

The overview site can be found here.

Deployment Status

Deployment status data is available only on PROD/DEV/EXP documentation.

Common Data Types

Types that are reused in different definitions.

Date

string (Date) ^[0-9]{4}-(0?[1-9]|1[0-2])-(0?[1-9]|[1-2][0-9...

A string consisting of three parts following the pattern "YYYY-MM-DD":

  • "YYYY" year AD: 0-9999
  • "MM" month: 1-12
  • "DD" day: 1-31

While the schema does not check for validity, the optimization algorithms do. Including invalid dates (e.g. 2020-02-31) leads to a validation error.

Examples:

  • "2020-04-10"
  • "2051-4-1"
  • "1953-04-10"
"2020-04-10"

Language Type

integer (Language Type) [ 0 .. 1 ]

Values are:

  • 0: German
  • 1: English
1

Time

string (Time) ^[-]?([0-9]{1,9}):([0-5][0-9]|[0-9])$

A string of either format "hh:mm" or "-hh:mm":

  • "hh": hours (24h format),
  • "mm": minutes

Times are always interpreted relative to a date in the same object as the Time field. This allows times to exceed 24h or even become negative, as the value gets "added" to midnight of the date. For example, the following times applied to the respective date (in Date format) are equivalent:

  • "2021-05-21" at "07:25"
  • "2021-05-20" at "31:25"
  • "2021-05-19" at "55:25"
  • "2021-05-22" at "-16:35"
  • "2021-05-23" at "-40:35"
"07:25"

Gender Type

integer (Gender Type) [ 0 .. 3 ]

Values are:

  • 0: not provided
  • 1: male
  • 2: female
  • 3: other
3

FieldPlacerVersion

string (FieldPlacerVersion) ^[0-9]{4}-[0-9]{2}-[0-9]{2}_[0-9]+(p[0-9]+)?$...

A version consisting of the date of release [0-9]{4}-[0-9]{2}-[0-9]{2}_[0-9]+, which can have a patch suffix p[0-9]+.

"1970-01-01_0p0"

SemanticVersion

string (SemanticVersion) ^(v)?(0|([1-9][0-9]{0,4}))(\.(0|([1-9][0-9]{0...

See https://semver.org/ for a full description of semantic versioning. The regex here is a subset of allowed semantic versions.

"v1.2.3"

Authentication

How to authenticate before any request.

AWS Cognito

The authentication is performed via AWS Cognito (Developer-Guide). It is recommended to use one of the SKDs provided by AWS to simplify the authentication process considerably. Examples for SDKs:

Configuration

  • Used protocol: Secure Remote Password Protocol
  • User pool data:
    • UserPoolId/ClientId is available only on PROD/DEV/EXP documentation.
  • Username/Password are provided when signing up for an account. If you don't have an account, please contact us.

Tokens

Authentication provides three tokens: the access-token, the ID-token and the refresh-token. All three are JSON Web Tokens.

  • The access-token is currently not used in the API.
  • The ID-token has to be proposed in every request in the header as follows:

Authorization: 'ID-token'

  • The ID-token contains a timestamp when the token has been authorized (auth_time) and when it will expire (exp). Currently, an ID-token expires after one hour and requests with expired ID-tokens are rejected automatically. You can get a new ID-token by using the refresh-token without having to re-enter your credentials.

Request samples 

const user = "";        // your username
const pw = "";          // your password
const userPoolID = "";  // UserPoolID, see configuration details
const clientID = "";    // ClientId, see configuration details

const AmazonCognitoIdentity = require('amazon-cognito-identity-js');

module.exports.login = () => new Promise((resolve, reject) => {

  const userPool = new AmazonCognitoIdentity.CognitoUserPool({
    UserPoolId: userPoolID,
    ClientId: clientID
  });

  const authenticationDetails = new AmazonCognitoIdentity.AuthenticationDetails({
      Username: user,
      Password: pw,
  });

  const cognitoUser = new AmazonCognitoIdentity.CognitoUser({
      Username: user,
      Pool: userPool
  });

  cognitoUser.authenticateUser(authenticationDetails, {
    onSuccess: function (result) {
        const token = result.getIdToken().getJwtToken();
        resolve(token);
    },
    onFailure: function (err) {
        reject();
    }
  });
})

Optimization Request

Post an optimization request.

Optimization Request

Post a request to be solved.

If a new optimization request was received and was successfully processed, the endpoint will return 201 and the key with which the solution can be retrieved. This does not mean that calculating a solution will succeed, as logic errors, invalid ids and many other checks are performed later - these kinds of issues will result in an ErrorPlan, retrievable from the solution endpoint. Only schema violations are being checked in this request, they will result in the request being rejected with code 422.

Usually, if an optimization request was received but an identical request was already posted before, the endpoint will return 200 and the key with which the solution can be retrieved, which is identical to the key from the earlier request. This is not the case for certain errors which allow a repeat request (marked by the allowRepeat property of an ErrorPlan). Repeats for such requests are allowed after a certain amount of time has passed, trying to post before this cooldown has expired will result in rejection (code 429) where the retry-after header contains the remaining time in seconds until the request will be accepted again. If the repeat request was accepted, the endpoint returns code 201 and a new key to get the solution with.

Request to this endpoint have a content size limit which depends on the used content-type. Requests with content-type: application/json must contain a "plain-text" json payload which must be less than 6Mb in size. For sending larger requests, you must use content-type: application/vnd.adiutabyte.adiutaopt.json+[gzip,deflate,br]. These requests must contain the json data, compressed with gzip, deflate (zlib) or brotli, the payload size limit is 4.5Mb for the compressed data.

Authorizations:
BearerAuth
header Parameters
required
"application/json" (string) or "application/vnd.adiutabyte.adiutaopt.json+gzip" (string) or "application/vnd.adiutabyte.adiutaopt.json+deflate" (string) or "application/vnd.adiutabyte.adiutaopt.json+br" (string)

The content-type of the payload. Invalid values result in status code 415.

adiutaopt-version
string

(optional) A specific version to process the request under. Valid versions can be retrieved with the /packages-list endpoint (Name).

Using a specific version is not recommended for "general" application but for testing, debugging or other developer actions. Versions represent a specific state of the application, they cannot be changed, bug-fixed or extended in any way. For that reason, support for these requests may be limited.

Request Body schema:
object (Client)

Contains information about the client which sends this request.

required
object (FloorPlannerMeta)

Meta information about what to consider in the optimization.

required
object (FloorPlannerOptimizationParameters)

Parameters for the optimizer.

required
Array of objects (FloorPlannerInputTask)

Array of tasks to be planned by the optimizer.

required
Array of objects (FloorPlannerInputWorker)

Array of available workers.

object (FloorPlannerHistory)

History data the optimizer can learn from to apply to the current request. History analysis is done differently for each of our customers, if you know what issues you want to address/ what results you want to see from such methods, please contact us so we can set up a solution.

recovery
Array of integers (IDReferences) [ items [ 0 .. 2147483647 ] ]
Deprecated

List of ids.

object (DeveloperOptions)

Options for developers. Do not use!

Responses

Request samples

Content type
Example

Basic blueprint for an optimization data set

{
  • "meta": {
    },
  • "parameters": { },
  • "tasks": [
    ],
  • "workers": [
    ]
}

Response samples

Content type
application/json
"VGVzdEtleUZvckFQSURvY3VtZW50YXRpb24uYXNk=="

Optimization Request (Preflight)

Responses

Solution

Retrieve the optimization solution for any application

Retrieving Solution

Retrieve the solution from this endpoint with the key you got when posting the request. The solution can either be a solved request or an ErrorPlan.

Responses from this endpoint have a content size limit which depends on the used content-type of the response, which can be specified with the accept header. If the response size would exceed that limit, the endpoint returns code 409 instead. Responses of type application/json can include payloads of up to 6Mb, all other types can return up to 4.5Mb of (compressed) data.

Authorizations:
BearerAuth
path Parameters
planID
required
string

Key returned in the 200/201 response of the POST request

header Parameters
"application/json" (string) or "application/vnd.adiutabyte.adiutaopt.json+gzip" (string) or "application/vnd.adiutabyte.adiutaopt.json+deflate" (string) or "application/vnd.adiutabyte.adiutaopt.json+br" (string)

(optional) The content-type of the response. Defaults to application/json if not set, invalid values result in status code 406.

"identity" (string) or "gzip" (string) or "deflate" (string)

(optional) The content-encode of the response. Only permitted for application/json responses.

Responses

Request samples 

curl \
  --request GET \
  --url '[see url above]/[key obtained from POST request]' \
  --header 'Authorization: Bearer [ID-Token obtained from Authentication (JWT)]'

Response samples

Content type
Example
{
  • "requestID": "string",
  • "client": {
    },
  • "meta": {
    },
  • "parameters": {
    },
  • "tasks": [
    ],
  • "workers": [
    ],
  • "statistics": {
    },
  • "info": {
    },
  • "anomalies": [
    ],
  • "backendVersion": {
    },
  • "recovery": [
    ],
  • "developerOptions": {
    }
}

Get Solution (Preflight)

path Parameters
planID
required
string

Can be anything.

Responses

Get Solution (header-only)

Same behavior as the GET request but returns no content for any of the responses.

path Parameters
planID
required
string

Key returned in the 200/201 response of the POST request

header Parameters
"application/json" (string) or "application/vnd.adiutabyte.adiutaopt.json+gzip" (string) or "application/vnd.adiutabyte.adiutaopt.json+deflate" (string) or "application/vnd.adiutabyte.adiutaopt.json+br" (string)

(optional) The content-type of the response. Defaults to application/json if not set, invalid values result in status code 406.

"identity" (string) or "gzip" (string) or "deflate" (string)

(optional) The content-encode of the response. Only permitted for application/json responses.

Version

Retrieve currently deployed version data

Get Version

Get the currently deployed version.

Responses from this endpoint have a content size limit which depends on the used content-type of the response, which can be specified with the accept header. If the response size would exceed that limit, the endpoint returns code 409 instead. Responses of type application/json can include payloads of up to 6Mb, all other types can return up to 4.5Mb of (compressed) data.

Authorizations:
BearerAuth
header Parameters
adiutaopt-version
string

(optional) A specific version to process the request under. Valid versions can be retrieved with the /packages-list endpoint (Name).

Using a specific version is not recommended for "general" application but for testing, debugging or other developer actions. Versions represent a specific state of the application, they cannot be changed, bug-fixed or extended in any way. For that reason, support for these requests may be limited.

"application/json" (string) or "application/vnd.adiutabyte.adiutaopt.json+gzip" (string) or "application/vnd.adiutabyte.adiutaopt.json+deflate" (string) or "application/vnd.adiutabyte.adiutaopt.json+br" (string)

(optional) The content-type of the response. Defaults to application/json if not set, invalid values result in status code 406.

"identity" (string) or "gzip" (string) or "deflate" (string)

(optional) The content-encode of the response. Only permitted for application/json responses.

Responses

Request samples 

curl \
  --request GET \
  --url '[see url above]' \
  --header 'Authorization: Bearer [ID-Token obtained from Authentication (JWT)]'

Response samples

Content type
{
  • "schema": "v1.7.0",
  • "version": "2024-10-01_0",
  • "meta_data": "v19",
  • "api_scripts": "v1.6.2"
}

Get Version (Preflight)

Responses

Get Version (header-only)

Same behavior as the GET request but returns no content for any of the responses.

header Parameters
adiutaopt-version
string

(optional) A specific version to process the request under. Valid versions can be retrieved with the /packages-list endpoint (Name).

Using a specific version is not recommended for "general" application but for testing, debugging or other developer actions. Versions represent a specific state of the application, they cannot be changed, bug-fixed or extended in any way. For that reason, support for these requests may be limited.

"application/json" (string) or "application/vnd.adiutabyte.adiutaopt.json+gzip" (string) or "application/vnd.adiutabyte.adiutaopt.json+deflate" (string) or "application/vnd.adiutabyte.adiutaopt.json+br" (string)

(optional) The content-type of the response. Defaults to application/json if not set, invalid values result in status code 406.

"identity" (string) or "gzip" (string) or "deflate" (string)

(optional) The content-encode of the response. Only permitted for application/json responses.

Get List of Available Packages

Get a list of all available packages. The Name of each package can be used in a POST request in header adiutaopt-version, the algorithm will then run on the specified version.

Responses from this endpoint have a content size limit which depends on the used content-type of the response, which can be specified with the accept header. If the response size would exceed that limit, the endpoint returns code 409 instead. Responses of type application/json can include payloads of up to 6Mb, all other types can return up to 4.5Mb of (compressed) data.

Authorizations:
BearerAuth
header Parameters
"application/json" (string) or "application/vnd.adiutabyte.adiutaopt.json+gzip" (string) or "application/vnd.adiutabyte.adiutaopt.json+deflate" (string) or "application/vnd.adiutabyte.adiutaopt.json+br" (string)

(optional) The content-type of the response. Defaults to application/json if not set, invalid values result in status code 406.

"identity" (string) or "gzip" (string) or "deflate" (string)

(optional) The content-encode of the response. Only permitted for application/json responses.

Responses

Request samples 

curl \
  --request GET \
  --url '[see url above]' \
  --header 'Authorization: Bearer [ID-Token obtained from Authentication (JWT)]'

Response samples

Content type
[
  • {
    },
  • {
    }
]

Get List of Available Packages (Preflight)

Responses

Get List of Available Packages (header-only)

Same behavior as the GET request but returns no content for any of the responses.

header Parameters
"application/json" (string) or "application/vnd.adiutabyte.adiutaopt.json+gzip" (string) or "application/vnd.adiutabyte.adiutaopt.json+deflate" (string) or "application/vnd.adiutabyte.adiutaopt.json+br" (string)

(optional) The content-type of the response. Defaults to application/json if not set, invalid values result in status code 406.

"identity" (string) or "gzip" (string) or "deflate" (string)

(optional) The content-encode of the response. Only permitted for application/json responses.

Error IDs

Error ID data is available only on PROD/DEV/EXP documentation.

Index

List of all schema definitions

Date

string (Date) ^[0-9]{4}-(0?[1-9]|1[0-2])-(0?[1-9]|[1-2][0-9...

A string consisting of three parts following the pattern "YYYY-MM-DD":

  • "YYYY" year AD: 0-9999
  • "MM" month: 1-12
  • "DD" day: 1-31

While the schema does not check for validity, the optimization algorithms do. Including invalid dates (e.g. 2020-02-31) leads to a validation error.

Examples:

  • "2020-04-10"
  • "2051-4-1"
  • "1953-04-10"
"2020-04-10"

Number_u64

number (Number_u64) [ 0 .. 1.7e+308 ]

Unsigned 64bit number with the upper limit of a signed 64bit number

1.7e+308

Language Type

integer (Language Type) [ 0 .. 1 ]

Values are:

  • 0: German
  • 1: English
1

Integer_u32_1

integer (Integer_u32_1) [ 1 .. 2147483647 ]

Unsigned 32 bit integer (not zero) with the upper limit of a signed 32bit integer

1

Integer_u32

integer (Integer_u32) [ 0 .. 2147483647 ]

Unsigned 32 bit integer with the upper limit of a signed 32bit integer

2147483647

FloorPlannerMeta

dateFrom
required
string (Date) ^[0-9]{4}-(0?[1-9]|1[0-2])-(0?[1-9]|[1-2][0-9...

Planning horizon start.

dateTo
required
string (Date) ^[0-9]{4}-(0?[1-9]|1[0-2])-(0?[1-9]|[1-2][0-9...

Planning horizon end.

resCategory
boolean
Default: false

Activate/Deactivate whether category types should be considered in the optimization.

resQualification
boolean
Default: false

Activate/Deactivate whether qualifications should be considered in the optimization.

accuracyMode
number (Number_u64) [ 0 .. 1.7e+308 ]
Default: 1

Manages a solution refinement process. An accuracy > 0.0 can improve the solution significantly but will take longer to calculate, effects increase with higher accuracyMode.

outputLanguage
integer (LanguageType) [ 0 .. 1 ]
Default: 0

Defines which language should be used in the output.

enablePlanSplitting
boolean
Deprecated
Default: true
allowUnassignedTasks
boolean
Default: false

If this flag is set to false, all tasks will be assigned by the algorithm (for exceptions regarding unassignable tasks, see removeInvalidTasks). If this flag is set to true, tasks can be left unassigned, if the algorithm cannot find a "good fit". The likelihood of this happening can be influenced with the value of assignmentPriority on the InputTask.

removeInvalidTasks
boolean

If this flag is set to false and the input data contains tasks that cannot be assigned to any worker (e.g. no worker has a qualification high enough for the task), an ErrorPlan with a corresponding error is returned. If the flag is set to true, these tasks simply won't get assigned but the optimization will be carried out for all valid tasks.

If this field is not set, it will assume the value of allowUnassignedTasks.

minConcurrentSolutions
integer (Integer_u32_1) [ 1 .. 2147483647 ]
Default: 1

Number of concurrently calculated solutions. Developer feature, use at your own risk!

minTaskDuration
integer (Integer_u32) [ 0 .. 2147483647 ]
Default: 0

Minimum value for an input task's duration. Task durations with a lower value are being overwritten before the optimization. Profit calculations (e.g. costsPerMinute), coverage, etc use adjusted values.

disableTaskTimeWindowRelaxation
boolean
Default: false

Per default, time windows of tasks are slightly relaxed before optimization depending on their timePriority. This usually creates better results as it is common that customer declared time windows are tighter than what they would actually accept as a good scheduling. However, if the time windows are indeed reliable and can be used without modification, the relaxation is no longer necessary or beneficial and can be turned off with this flag.

{
  • "dateFrom": "2020-04-10",
  • "dateTo": "2020-04-10",
  • "resCategory": false,
  • "resQualification": false,
  • "accuracyMode": 1.7e+308,
  • "outputLanguage": 1,
  • "enablePlanSplitting": true,
  • "allowUnassignedTasks": false,
  • "removeInvalidTasks": true,
  • "minConcurrentSolutions": 1,
  • "minTaskDuration": 2147483647,
  • "disableTaskTimeWindowRelaxation": false
}

FloorPlannerOptimizationParameters

fairDistribution
integer (Integer_0_9) [ 0 .. 9 ]
Default: 0

Distribute the tasks fairly among the workers. A fair distribution is one where every worker has the same ratio of total task duration to shift length. Consequently, only tasks with non-zero durations affect the fair distribution.

workerPrefs
integer (Integer_0_9) [ 0 .. 9 ]
Default: 0

Optimize towards fulfilling preferences on tasks and workers.

qualificationFitting
integer (Integer_0_9) [ 0 .. 9 ]
Default: 0

Avoid assignments where the worker has a higher qualification than the task. Tasks without qualification count as having a qualification of 0.

constancy
integer (Integer_0_9) [ 0 .. 9 ]
Default: 0

Prioritize consistency with history.

groupPrefs
integer (Integer_0_9) [ 0 .. 9 ]
Default: 0

Keep tasks of the same groups on the same workers.

{
  • "fairDistribution": 9,
  • "workerPrefs": 9,
  • "qualificationFitting": 9,
  • "constancy": 9,
  • "groupPrefs": 9
}

Time

string (Time) ^[-]?([0-9]{1,9}):([0-5][0-9]|[0-9])$

A string of either format "hh:mm" or "-hh:mm":

  • "hh": hours (24h format),
  • "mm": minutes

Times are always interpreted relative to a date in the same object as the Time field. This allows times to exceed 24h or even become negative, as the value gets "added" to midnight of the date. For example, the following times applied to the respective date (in Date format) are equivalent:

  • "2021-05-21" at "07:25"
  • "2021-05-20" at "31:25"
  • "2021-05-19" at "55:25"
  • "2021-05-22" at "-16:35"
  • "2021-05-23" at "-40:35"
"07:25"

IDReferences

Array
integer (Integer_u32) [ 0 .. 2147483647 ]

Unsigned 32 bit integer with the upper limit of a signed 32bit integer

[
  • 2147483647
]

Integer_s32

integer (Integer_s32) [ -2147483648 .. 2147483647 ]

Signed 32 bit integer

-2147483648

Gender Type

integer (Gender Type) [ 0 .. 3 ]

Values are:

  • 0: not provided
  • 1: male
  • 2: female
  • 3: other
3

FloorPlannerInputTask

taskID
required
integer (Integer_u32) [ 0 .. 2147483647 ]

The ID of this task. IDs need to be unique among all Tasks.

externalID
string

A string to identify the task in the solution. Cannot be used for reference in the input data or the optimizer, it only serves as a helping tool for integrations.

clientID
integer (Integer_u32) [ 0 .. 2147483647 ]

The ID of the client this task is assigned to.

date
required
string (Date) ^[0-9]{4}-(0?[1-9]|1[0-2])-(0?[1-9]|[1-2][0-9...

The date this task should be planned on.

duration
integer (Integer_u32) [ 0 .. 2147483647 ]

The time in minutes it takes to complete this task. Exactly one of duration and durationInSeconds must be set, it can be set to zero though.

durationInSeconds
integer (Integer_u32) [ 0 .. 2147483647 ]

The time in seconds it takes to complete this task. Exactly one of duration and durationInSeconds must be set, it can be set to zero though.

timeEarliest
required
string (Time) ^[-]?([0-9]{1,9}):([0-5][0-9]|[0-9])$

The earliest possible starting time of this task.

This is a preference and can be violated for other preferences or restrictions.

timeLatest
required
string (Time) ^[-]?([0-9]{1,9}):([0-5][0-9]|[0-9])$

The latest time at which this task should be finished.

This is a preference and can be violated for other preferences or restrictions.

timePriority
integer (Integer_0_5) [ 0 .. 5 ]
Default: 1

The priority of the time window:

  • 0 - irrelevant
  • 1 - not important (automatically extended by 30 minutes)
  • 2 - more important (automatically extended by 15 minutes)
  • 3 - important (no extension)
  • 4 - very important (no extension)
  • 5 - fixed time (no extension)

Tasks with high time priority are more likely to get scheduled inside their given time window. Tasks with time priority 0 completely ignore their given time window.

For tasks with a timePriority of 5, the time window is considered a strict restriction.

prefWorkers
Array of integers (IDReferences) [ items [ 0 .. 2147483647 ] ]

The IDs of preferred workers.

This is a preference and can be violated for other preferences or restrictions. Its importance depends on the parameter workerPrefs.

qualification
integer (Integer_u32) [ 0 .. 2147483647 ]

The minimum qualification of the worker required to perform the task (e.g. years of experience). Workers without qualification are not allowed to perform tasks of any qualification.

This is a strict restriction and might fail validation if it is impossible to keep.

categories
Array of integers (IDReferences) [ items [ 0 .. 2147483647 ] ]

A suitable worker has to fulfill all of these categories.

This is a strict restriction and might fail validation if it is impossible to keep.

preassignedWorker
integer (Integer_u32) [ 0 .. 2147483647 ]

The workerID of the only worker that is allowed to carry out the task. This setting overrules any other strict restriction - for example, if the worker does not fulfil the qualification requirement, the task will still get assigned to them. The field can also be used for dontAlter and dontVary assignments. A preassignedWorker does not imply an assignmentPriority - if allowUnassignedTasks is active, the task being unassigned is not a violation of this restriction.

When there are multiple workers with the same workerID:

  • if the task only has preassignedWorker set, the task can be assigned to any of the workers with that workerID, regardless of what their shiftIDs are (or if they have one)
  • if the task has an initassignedShiftID set as well as preassignedWorker, the task can only be assigned to the worker that matches the workerID to preassignedWorker and the shiftID to initassignedShiftID

This is a strict restriction and might fail validation if it is impossible to keep.

preassignedOrder
integer (Integer_s32) [ -2147483648 .. 2147483647 ]

Tasks with a value > 0 will be assigned to the start of the tour of the preassignedWorker, tasks with a value < 0 to the end. If multiple tasks preassigned to a worker have a preassignedOrder, the tasks will be sorted so that the preassignedOrder is increasing (tasks at the front of the tour and tasks at the end of the tour separately).

This is a strict restriction and might fail validation if it is impossible to keep.

initassignedWorker
integer (Integer_u32) [ 0 .. 2147483647 ]

A hint for large optimization data sets, e.g. solution data from a previous optimization request. The field can also be used for dontAlter and dontVary assignments.

initassignedOrder
integer (Integer_u32) [ 0 .. 2147483647 ]

The order within the initially assigned worker's tour. Requires preassignedWorker or initassignedWorker.

initassignedShiftID
integer (Integer_u32) [ 0 .. 2147483647 ]

A shiftID to compliment either initassignedWorker or preassignedWorker in case the workerID is not unique.

precedingTasks
Array of integers (IDReferences) [ items [ 0 .. 2147483647 ] ]

Tasks in this list and this task will be performed by the same worker and all listed tasks will have to be finished before this task starts.

This is a strict restriction and might fail validation if it is impossible to keep.

preferredPrecedingTasks
Array of integers (IDReferences) [ items [ 0 .. 2147483647 ] ]

If the tasks in this list together with this task are performed by the same worker, all listed tasks should be completed before this task begins. If the tasks in this list and this task are performed by different workers, the order does not have to be followed.

This is a preference and can be violated for other preferences or restrictions.

predecessorTasks
Array of integers (IDReferences) [ items [ 0 .. 2147483647 ] ]

One of these tasks has be carried out right before this task by the same worker. Putting multiple values in the array does not mean they are carried out in that order - if you want to have a predecessor-chain, you need to set the direct predecessor on each task in the chain (see examples). Do not put redundant values in here, as having more than one value in the array has negative impact on performance and solution quality.

This is a strict restriction and might fail validation if it is impossible to keep.

assignmentPriority
integer (Integer_0_5) [ 0 .. 5 ]
Default: 1

A priority for assignment (see allowUnassignedTasks):.

  • 0 - no preference regarding unassignment, whether or not the task is assigned does not matter and will depend solely on other factors
  • 1-4 - progressively higher assignment importance
  • 5 - task has to be assigned

If allowUnassignedTasks is set to false, this field has no effect.

For tasks with an assignmentPriority of 5, the task being assigned is considered a strict restriction.

preferredGroup
integer (Integer_u32) [ 0 .. 2147483647 ]

Tasks with the same value in this field will preferably be assigned to the same worker shift. It does not incentivize the optimizer to assign the tasks consecutively, if you want that to happen, you have to use desiredPredecessorGroup.

This is a preference and can be violated for other preferences or restrictions. Its importance depends on the parameter groupPrefs.

desiredPredecessorGroup
integer (Integer_u32) [ 0 .. 2147483647 ]

Tasks with the same value in this field will preferably be assigned consecutively, if they are assigned to the same worker. It does not incentivize the optimizer to assign the tasks on the same worker, if you want that to happen, you have to use preferredGroup.

This is a preference and can be violated for other preferences or restrictions.

locationSiteID
integer (Integer_u32) [ 0 .. 2147483647 ]

An id for the position this task has to be carried out at.

prefGender
integer (GenderType) [ 0 .. 3 ]

The preferred gender for the assigned worker.

This is a preference and can be violated for other preferences or restrictions.

exclusiveSetID
integer (Integer_u32) [ 0 .. 2147483647 ]

Tasks with the same exclusiveSetID form a "set". A worker can only carry out tasks of at most one set (and any number of tasks without an exclusiveSetID - see hasStrictExclusiveSet). Please note that this does not force tasks of the same set to be assigned to the same worker.

This is a strict restriction and might fail validation if it is impossible to keep.

hasStrictExclusiveSet
boolean
Default: false

If this field is set to true, the worker carrying out this task cannot carry out tasks without an exclusiveSetID. In other words, the worker will only carry out tasks with the exact same exclusiveSetID as this task.

{
  • "taskID": 2147483647,
  • "externalID": "string",
  • "clientID": 2147483647,
  • "date": "2020-04-10",
  • "duration": 2147483647,
  • "durationInSeconds": 2147483647,
  • "timeEarliest": "07:25",
  • "timeLatest": "07:25",
  • "timePriority": 5,
  • "prefWorkers": [
    ],
  • "qualification": 2147483647,
  • "categories": [
    ],
  • "preassignedWorker": 2147483647,
  • "preassignedOrder": -2147483648,
  • "initassignedWorker": 2147483647,
  • "initassignedOrder": 2147483647,
  • "initassignedShiftID": 2147483647,
  • "precedingTasks": [
    ],
  • "preferredPrecedingTasks": [
    ],
  • "predecessorTasks": [
    ],
  • "assignmentPriority": 5,
  • "preferredGroup": 2147483647,
  • "desiredPredecessorGroup": 2147483647,
  • "locationSiteID": 2147483647,
  • "prefGender": 3,
  • "exclusiveSetID": 2147483647,
  • "hasStrictExclusiveSet": false
}

FloorPlannerInputWorker

workerID
required
integer (Integer_u32) [ 0 .. 2147483647 ]

The ID of the worker.

shiftID
integer (Integer_u32) [ 0 .. 2147483647 ]

A second ID in case there are multiple workers with the same workerID. This one needs to be unique among all workers with the same workerID. It can be referenced whenever a unique reference to this worker object is required.

externalID
string

A string to identify the worker in the solution. Cannot be used for reference in the input data or the optimizer, it only serves as a helping tool for integrations.

shiftDate
required
string (Date) ^[0-9]{4}-(0?[1-9]|1[0-2])-(0?[1-9]|[1-2][0-9...

The date of this shift.

shiftStart
required
string (Time) ^[-]?([0-9]{1,9}):([0-5][0-9]|[0-9])$

The time this shift starts.

This is a preference and can be violated for other preferences or restrictions.

shiftEnd
required
string (Time) ^[-]?([0-9]{1,9}):([0-5][0-9]|[0-9])$

The time this shift ends.

This is a preference and can be violated for other preferences or restrictions.

shiftPriority
integer (Integer_0_3) [ 0 .. 3 ]
Default: 1

The priority to keep the defined shift start and end times:

  • 0: irrelevant
  • 1: neutral
  • 2: important
  • 3: very important
qualification
integer (Integer_u32) [ 0 .. 2147483647 ]

The qualification of the worker. They are able to take over tasks with the same or lower qualification.

categories
Array of integers (IDReferences) [ items [ 0 .. 2147483647 ] ]

The worker can only carry out tasks if he has each category the task requires.

preferredCategories
Array of integers (IDReferences) [ items [ 0 .. 2147483647 ] ]

The worker prefers tasks that have any of these categories. Categories listed here are automatically considered valid as if they're listed in categories.

This is a preference and can be violated for other preferences or restrictions. Its importance depends on the parameter workerPrefs.

unpreferredCategories
Array of integers (IDReferences) [ items [ 0 .. 2147483647 ] ]

The worker has an aversion against tasks that have any of these categories. Categories listed here are automatically considered valid as if they're listed in categories.

This is a preference and can be violated for other preferences or restrictions. Its importance depends on the parameter workerPrefs.

desiredCategories
Array of integers (IDReferences) [ items [ 0 .. 2147483647 ] ]

The worker strongly prefers tasks that have any of these categories. Categories listed here are automatically considered valid as if they're listed in categories.

This is a preference and can be violated for other preferences or restrictions.

undesiredCategories
Array of integers (IDReferences) [ items [ 0 .. 2147483647 ] ]

The worker has a strong aversion against tasks that have any of these categories. Categories listed here are automatically considered valid as if they're listed in categories.

This is a preference and can be violated for other preferences or restrictions.

dontVary
boolean
Default: false

A worker with dontVary set to true is "fixed" for the optimizer, meaning they get assigned all tasks (and only those tasks) that have this worker set as preassignedWorker or initassignedWorker in the order of initassignedOrder. That also means that initassignedOrder is required for these tasks, as well as shiftID on the worker and initassignedShiftID on the task if the workerID is not unique. All assignments will be considered in statistics and info.

This is a strict restriction and might fail validation if it is impossible to keep.

dontAlter
boolean
Default: false

Workers with dontAlter set to true behave similarly to workers with dontVary. The only difference is that a dontVary-worker cannot get assigned more tasks than specified in the input data, a dontAlter-worker will be assigned all tasks that have this worker as initassignedWorker or preassignedWorker, but can also have other tasks assigned. While the preassigned/initassigned tasks will be in order of initassignedOrder, other tasks can be inserted before, between or after those tasks; if there is no initassignedOrder set, the task will be ignored. Every other behavior and requirement is exactly as in dontVary.

This is a strict restriction and might fail validation if it is impossible to keep.

allowPreassignedTasksOnly
boolean
Default: false

If this flag is true, only tasks preassigned to this worker can be assigned to it. Tasks not preassigned to this worker cannot be assigned to it.

This is a strict restriction and might fail validation if it is impossible to keep.

gender
integer (GenderType) [ 0 .. 3 ]

The gender of the worker.

{
  • "workerID": 2147483647,
  • "shiftID": 2147483647,
  • "externalID": "string",
  • "shiftDate": "2020-04-10",
  • "shiftStart": "07:25",
  • "shiftEnd": "07:25",
  • "shiftPriority": 3,
  • "qualification": 2147483647,
  • "categories": [
    ],
  • "preferredCategories": [
    ],
  • "unpreferredCategories": [
    ],
  • "desiredCategories": [
    ],
  • "undesiredCategories": [
    ],
  • "dontVary": false,
  • "dontAlter": false,
  • "allowPreassignedTasksOnly": false,
  • "gender": 3
}

FloorPlannerHistoryAssignment

date
required
string (Date) ^[0-9]{4}-(0?[1-9]|1[0-2])-(0?[1-9]|[1-2][0-9...

The date of the assignment.

locationSiteID
integer (Integer_u32) [ 0 .. 2147483647 ]

The id for the location the task was carried out at at the time.

timeScheduled
string (Time) ^[-]?([0-9]{1,9}):([0-5][0-9]|[0-9])$

The time the corresponding task was scheduled (meaning the time the final plan had this task scheduled on, not to be confused with actualStartTime)

assignedWorker
integer (Integer_u32) [ 0 .. 2147483647 ]

The worker the corresponding task was assigned to in the final planned version.

assignedShiftID
integer (Integer_u32) [ 0 .. 2147483647 ]

An id for the assigned shift of the assigned worker.

assignedOrder
integer (Integer_u32) [ 0 .. 2147483647 ]

The order number this task was assigned to the worker shift.

timeScheduledAutomatically
string (Time) ^[-]?([0-9]{1,9}):([0-5][0-9]|[0-9])$

The time the corresponding task was scheduled on by the optimizer at the time.

assignedWorkerAutomatically
integer (Integer_u32) [ 0 .. 2147483647 ]

The worker the corresponding task was assigned to by the optimizer at the time.

assignedShiftIDAutomatically
integer (Integer_u32) [ 0 .. 2147483647 ]

An id for the assigned shift of the assigned worker.

assignedOrderAutomatically
integer (Integer_u32) [ 0 .. 2147483647 ]

The order number this task was assigned to the worker shift.

actualWorker
integer (Integer_u32) [ 0 .. 2147483647 ]

The worker the task was actually carried out by, for instance as determined by mobile tracking.

actualStartTime
string (Time) ^[-]?([0-9]{1,9}):([0-5][0-9]|[0-9])$

The time the task was actually started, for instance as determined by mobile tracking.

actualShiftID
integer (Integer_u32) [ 0 .. 2147483647 ]

An id for the assigned shift of the assigned worker.

actualOrder
integer (Integer_u32) [ 0 .. 2147483647 ]

The order number this task was assigned to the worker shift.

{
  • "date": "2020-04-10",
  • "locationSiteID": 2147483647,
  • "timeScheduled": "07:25",
  • "assignedWorker": 2147483647,
  • "assignedShiftID": 2147483647,
  • "assignedOrder": 2147483647,
  • "timeScheduledAutomatically": "07:25",
  • "assignedWorkerAutomatically": 2147483647,
  • "assignedShiftIDAutomatically": 2147483647,
  • "assignedOrderAutomatically": 2147483647,
  • "actualWorker": 2147483647,
  • "actualStartTime": "07:25",
  • "actualShiftID": 2147483647,
  • "actualOrder": 2147483647
}

FloorPlannerHistoryTask

taskID
required
integer (Integer_u32) [ 0 .. 2147483647 ]

Task ID for referencing task in planning tasks.

required
Array of objects (FloorPlannerHistoryAssignment)

All considered historical assignments of this task.

{
  • "taskID": 2147483647,
  • "scheduling": [
    ]
}

FloorPlannerHistoryWorker

workerID
required
integer (Integer_u32) [ 0 .. 2147483647 ]

ID of a worker that is not present in the input data. Has to be unique among all History-Workers.

{
  • "workerID": 2147483647
}

FloorPlannerHistory

required
Array of objects (FloorPlannerHistoryTask)

All history tasks

required
Array of objects (FloorPlannerHistoryWorker)

All history workers

Array of objects (FloorPlannerInputTask)

All tasks that are relevant for the analysis but are not part of the optimization.

{
  • "tasks": [
    ],
  • "workers": [
    ],
  • "additionalTasks": [
    ]
}

DeveloperOptions

recovery
Array of integers (IDReferences) [ items [ 0 .. 2147483647 ] ]

[developer feature] Contains recovery data that can be used to reproduce timeout behaviour.

debugSolution
string

[developer feature] Contains data for (re-)producing specific solutions.

{
  • "recovery": [
    ],
  • "debugSolution": "string"
}

FloorPlannerInputPlan

object (Client)

Contains information about the client which sends this request.

required
object (FloorPlannerMeta)

Meta information about what to consider in the optimization.

required
object (FloorPlannerOptimizationParameters)

Parameters for the optimizer.

required
Array of objects (FloorPlannerInputTask)

Array of tasks to be planned by the optimizer.

required
Array of objects (FloorPlannerInputWorker)

Array of available workers.

object (FloorPlannerHistory)

History data the optimizer can learn from to apply to the current request. History analysis is done differently for each of our customers, if you know what issues you want to address/ what results you want to see from such methods, please contact us so we can set up a solution.

recovery
Array of integers (IDReferences) [ items [ 0 .. 2147483647 ] ]
Deprecated

List of ids.

object (DeveloperOptions)

Options for developers. Do not use!

{
  • "client": {
    },
  • "meta": {
    },
  • "parameters": {
    },
  • "tasks": [
    ],
  • "workers": [
    ],
  • "history": {
    },
  • "recovery": [
    ],
  • "developerOptions": {
    }
}

AjvError

keyword
required
string

Validation keyword.

instancePath
required
string

JSON Pointer to the location in the data instance (e.g., "/prop/1/subProp").

schemaPath
required
string

JSON Pointer to the location of the failing keyword in the schema

params
required
object

Params property is the object with the additional information about error. It can be used to generate error messages (e.g., using ajv-i18n package).

propertyName
string

Set for errors in propertyNames keyword schema. instancePath still points to the object in this case.

message
string

The error message.

schema
any

The value of the failing keyword in the schema.

parentSchema
object

The schema containing the keyword.

data
any

The data validated by the keyword.

{
  • "keyword": "string",
  • "instancePath": "string",
  • "schemaPath": "string",
  • "params": { },
  • "propertyName": "string",
  • "message": "string",
  • "schema": null,
  • "parentSchema": { },
  • "data": null
}

FloorPlannerOutputTaskAssigned

taskID
required
integer (Integer_u32) [ 0 .. 2147483647 ]

The ID of this task. IDs need to be unique among all Tasks.

externalID
string

A string to identify the task in the solution. Cannot be used for reference in the input data or the optimizer, it only serves as a helping tool for integrations.

clientID
integer (Integer_u32) [ 0 .. 2147483647 ]

The ID of the client this task is assigned to.

date
required
string (Date) ^[0-9]{4}-(0?[1-9]|1[0-2])-(0?[1-9]|[1-2][0-9...

The date this task should be planned on.

duration
integer (Integer_u32) [ 0 .. 2147483647 ]

The time in minutes it takes to complete this task. Exactly one of duration and durationInSeconds must be set, it can be set to zero though.

durationInSeconds
integer (Integer_u32) [ 0 .. 2147483647 ]

The time in seconds it takes to complete this task. Exactly one of duration and durationInSeconds must be set, it can be set to zero though.

timeEarliest
required
string (Time) ^[-]?([0-9]{1,9}):([0-5][0-9]|[0-9])$

The earliest possible starting time of this task.

This is a preference and can be violated for other preferences or restrictions.

timeLatest
required
string (Time) ^[-]?([0-9]{1,9}):([0-5][0-9]|[0-9])$

The latest time at which this task should be finished.

This is a preference and can be violated for other preferences or restrictions.

timePriority
integer (Integer_0_5) [ 0 .. 5 ]
Default: 1

The priority of the time window:

  • 0 - irrelevant
  • 1 - not important (automatically extended by 30 minutes)
  • 2 - more important (automatically extended by 15 minutes)
  • 3 - important (no extension)
  • 4 - very important (no extension)
  • 5 - fixed time (no extension)

Tasks with high time priority are more likely to get scheduled inside their given time window. Tasks with time priority 0 completely ignore their given time window.

For tasks with a timePriority of 5, the time window is considered a strict restriction.

prefWorkers
Array of integers (IDReferences) [ items [ 0 .. 2147483647 ] ]

The IDs of preferred workers.

This is a preference and can be violated for other preferences or restrictions. Its importance depends on the parameter workerPrefs.

qualification
integer (Integer_u32) [ 0 .. 2147483647 ]

The minimum qualification of the worker required to perform the task (e.g. years of experience). Workers without qualification are not allowed to perform tasks of any qualification.

This is a strict restriction and might fail validation if it is impossible to keep.

categories
Array of integers (IDReferences) [ items [ 0 .. 2147483647 ] ]

A suitable worker has to fulfill all of these categories.

This is a strict restriction and might fail validation if it is impossible to keep.

preassignedWorker
integer (Integer_u32) [ 0 .. 2147483647 ]

The workerID of the only worker that is allowed to carry out the task. This setting overrules any other strict restriction - for example, if the worker does not fulfil the qualification requirement, the task will still get assigned to them. The field can also be used for dontAlter and dontVary assignments. A preassignedWorker does not imply an assignmentPriority - if allowUnassignedTasks is active, the task being unassigned is not a violation of this restriction.

When there are multiple workers with the same workerID:

  • if the task only has preassignedWorker set, the task can be assigned to any of the workers with that workerID, regardless of what their shiftIDs are (or if they have one)
  • if the task has an initassignedShiftID set as well as preassignedWorker, the task can only be assigned to the worker that matches the workerID to preassignedWorker and the shiftID to initassignedShiftID

This is a strict restriction and might fail validation if it is impossible to keep.

preassignedOrder
integer (Integer_s32) [ -2147483648 .. 2147483647 ]

Tasks with a value > 0 will be assigned to the start of the tour of the preassignedWorker, tasks with a value < 0 to the end. If multiple tasks preassigned to a worker have a preassignedOrder, the tasks will be sorted so that the preassignedOrder is increasing (tasks at the front of the tour and tasks at the end of the tour separately).

This is a strict restriction and might fail validation if it is impossible to keep.

initassignedWorker
integer (Integer_u32) [ 0 .. 2147483647 ]

A hint for large optimization data sets, e.g. solution data from a previous optimization request. The field can also be used for dontAlter and dontVary assignments.

initassignedOrder
integer (Integer_u32) [ 0 .. 2147483647 ]

The order within the initially assigned worker's tour. Requires preassignedWorker or initassignedWorker.

initassignedShiftID
integer (Integer_u32) [ 0 .. 2147483647 ]

A shiftID to compliment either initassignedWorker or preassignedWorker in case the workerID is not unique.

precedingTasks
Array of integers (IDReferences) [ items [ 0 .. 2147483647 ] ]

Tasks in this list and this task will be performed by the same worker and all listed tasks will have to be finished before this task starts.

This is a strict restriction and might fail validation if it is impossible to keep.

preferredPrecedingTasks
Array of integers (IDReferences) [ items [ 0 .. 2147483647 ] ]

If the tasks in this list together with this task are performed by the same worker, all listed tasks should be completed before this task begins. If the tasks in this list and this task are performed by different workers, the order does not have to be followed.

This is a preference and can be violated for other preferences or restrictions.

predecessorTasks
Array of integers (IDReferences) [ items [ 0 .. 2147483647 ] ]

One of these tasks has be carried out right before this task by the same worker. Putting multiple values in the array does not mean they are carried out in that order - if you want to have a predecessor-chain, you need to set the direct predecessor on each task in the chain (see examples). Do not put redundant values in here, as having more than one value in the array has negative impact on performance and solution quality.

This is a strict restriction and might fail validation if it is impossible to keep.

assignmentPriority
integer (Integer_0_5) [ 0 .. 5 ]
Default: 1

A priority for assignment (see allowUnassignedTasks):.

  • 0 - no preference regarding unassignment, whether or not the task is assigned does not matter and will depend solely on other factors
  • 1-4 - progressively higher assignment importance
  • 5 - task has to be assigned

If allowUnassignedTasks is set to false, this field has no effect.

For tasks with an assignmentPriority of 5, the task being assigned is considered a strict restriction.

preferredGroup
integer (Integer_u32) [ 0 .. 2147483647 ]

Tasks with the same value in this field will preferably be assigned to the same worker shift. It does not incentivize the optimizer to assign the tasks consecutively, if you want that to happen, you have to use desiredPredecessorGroup.

This is a preference and can be violated for other preferences or restrictions. Its importance depends on the parameter groupPrefs.

desiredPredecessorGroup
integer (Integer_u32) [ 0 .. 2147483647 ]

Tasks with the same value in this field will preferably be assigned consecutively, if they are assigned to the same worker. It does not incentivize the optimizer to assign the tasks on the same worker, if you want that to happen, you have to use preferredGroup.

This is a preference and can be violated for other preferences or restrictions.

locationSiteID
integer (Integer_u32) [ 0 .. 2147483647 ]

An id for the position this task has to be carried out at.

prefGender
integer (GenderType) [ 0 .. 3 ]

The preferred gender for the assigned worker.

This is a preference and can be violated for other preferences or restrictions.

exclusiveSetID
integer (Integer_u32) [ 0 .. 2147483647 ]

Tasks with the same exclusiveSetID form a "set". A worker can only carry out tasks of at most one set (and any number of tasks without an exclusiveSetID - see hasStrictExclusiveSet). Please note that this does not force tasks of the same set to be assigned to the same worker.

This is a strict restriction and might fail validation if it is impossible to keep.

hasStrictExclusiveSet
boolean
Default: false

If this field is set to true, the worker carrying out this task cannot carry out tasks without an exclusiveSetID. In other words, the worker will only carry out tasks with the exact same exclusiveSetID as this task.

timeScheduled
required
string (Time) ^[-]?([0-9]{1,9}):([0-5][0-9]|[0-9])$

The planned time to start this task by the assigned worker.

timeWindowViolation
integer (Integer_s32) [ -2147483648 .. 2147483647 ]

If the task is scheduled outside its time window, this value displays the discrepancy in minutes - the value is < 0 if the task was scheduled earlier than its time window and > 0 otherwise. If the task is scheduled within its time window, the field does not get added.

Examples:

  • A task of 30 minutes with timeLatest: 12:00 scheduled at 11:45 will have timeWindowViolation: 15.
  • A task with timeEarliest: 10:00 scheduled at 09:30 will have timeWindowViolation: -30.
assignedWorker
required
integer (Integer_u32) [ 0 .. 2147483647 ]

The ID (workerID) of the assigned worker who will perform this task.

assignedShiftID
integer (Integer_u32) [ 0 .. 2147483647 ]

The shiftID to which the task is assigned to.

info
required
string

May contain some information about the task.

finalassignedOrder
required
integer (Integer_u32_1) [ 1 .. 2147483647 ]

The order number on the assigned worker.

allowedWorkers
Array of integers (IDReferences) [ items [ 0 .. 2147483647 ] ]

A list of all workers (workerID) this task can be assigned to.

{
  • "taskID": 2147483647,
  • "externalID": "string",
  • "clientID": 2147483647,
  • "date": "2020-04-10",
  • "duration": 2147483647,
  • "durationInSeconds": 2147483647,
  • "timeEarliest": "07:25",
  • "timeLatest": "07:25",
  • "timePriority": 5,
  • "prefWorkers": [
    ],
  • "qualification": 2147483647,
  • "categories": [
    ],
  • "preassignedWorker": 2147483647,
  • "preassignedOrder": -2147483648,
  • "initassignedWorker": 2147483647,
  • "initassignedOrder": 2147483647,
  • "initassignedShiftID": 2147483647,
  • "precedingTasks": [
    ],
  • "preferredPrecedingTasks": [
    ],
  • "predecessorTasks": [
    ],
  • "assignmentPriority": 5,
  • "preferredGroup": 2147483647,
  • "desiredPredecessorGroup": 2147483647,
  • "locationSiteID": 2147483647,
  • "prefGender": 3,
  • "exclusiveSetID": 2147483647,
  • "hasStrictExclusiveSet": false,
  • "timeScheduled": "07:25",
  • "timeWindowViolation": -2147483648,
  • "assignedWorker": 2147483647,
  • "assignedShiftID": 2147483647,
  • "info": "string",
  • "finalassignedOrder": 1,
  • "allowedWorkers": [
    ]
}

FloorPlannerOutputTaskUnassigned

taskID
required
integer (Integer_u32) [ 0 .. 2147483647 ]

The ID of this task. IDs need to be unique among all Tasks.

externalID
string

A string to identify the task in the solution. Cannot be used for reference in the input data or the optimizer, it only serves as a helping tool for integrations.

clientID
integer (Integer_u32) [ 0 .. 2147483647 ]

The ID of the client this task is assigned to.

date
required
string (Date) ^[0-9]{4}-(0?[1-9]|1[0-2])-(0?[1-9]|[1-2][0-9...

The date this task should be planned on.

duration
integer (Integer_u32) [ 0 .. 2147483647 ]

The time in minutes it takes to complete this task. Exactly one of duration and durationInSeconds must be set, it can be set to zero though.

durationInSeconds
integer (Integer_u32) [ 0 .. 2147483647 ]

The time in seconds it takes to complete this task. Exactly one of duration and durationInSeconds must be set, it can be set to zero though.

timeEarliest
required
string (Time) ^[-]?([0-9]{1,9}):([0-5][0-9]|[0-9])$

The earliest possible starting time of this task.

This is a preference and can be violated for other preferences or restrictions.

timeLatest
required
string (Time) ^[-]?([0-9]{1,9}):([0-5][0-9]|[0-9])$

The latest time at which this task should be finished.

This is a preference and can be violated for other preferences or restrictions.

timePriority
integer (Integer_0_5) [ 0 .. 5 ]
Default: 1

The priority of the time window:

  • 0 - irrelevant
  • 1 - not important (automatically extended by 30 minutes)
  • 2 - more important (automatically extended by 15 minutes)
  • 3 - important (no extension)
  • 4 - very important (no extension)
  • 5 - fixed time (no extension)

Tasks with high time priority are more likely to get scheduled inside their given time window. Tasks with time priority 0 completely ignore their given time window.

For tasks with a timePriority of 5, the time window is considered a strict restriction.

prefWorkers
Array of integers (IDReferences) [ items [ 0 .. 2147483647 ] ]

The IDs of preferred workers.

This is a preference and can be violated for other preferences or restrictions. Its importance depends on the parameter workerPrefs.

qualification
integer (Integer_u32) [ 0 .. 2147483647 ]

The minimum qualification of the worker required to perform the task (e.g. years of experience). Workers without qualification are not allowed to perform tasks of any qualification.

This is a strict restriction and might fail validation if it is impossible to keep.

categories
Array of integers (IDReferences) [ items [ 0 .. 2147483647 ] ]

A suitable worker has to fulfill all of these categories.

This is a strict restriction and might fail validation if it is impossible to keep.

preassignedWorker
integer (Integer_u32) [ 0 .. 2147483647 ]

The workerID of the only worker that is allowed to carry out the task. This setting overrules any other strict restriction - for example, if the worker does not fulfil the qualification requirement, the task will still get assigned to them. The field can also be used for dontAlter and dontVary assignments. A preassignedWorker does not imply an assignmentPriority - if allowUnassignedTasks is active, the task being unassigned is not a violation of this restriction.

When there are multiple workers with the same workerID:

  • if the task only has preassignedWorker set, the task can be assigned to any of the workers with that workerID, regardless of what their shiftIDs are (or if they have one)
  • if the task has an initassignedShiftID set as well as preassignedWorker, the task can only be assigned to the worker that matches the workerID to preassignedWorker and the shiftID to initassignedShiftID

This is a strict restriction and might fail validation if it is impossible to keep.

preassignedOrder
integer (Integer_s32) [ -2147483648 .. 2147483647 ]

Tasks with a value > 0 will be assigned to the start of the tour of the preassignedWorker, tasks with a value < 0 to the end. If multiple tasks preassigned to a worker have a preassignedOrder, the tasks will be sorted so that the preassignedOrder is increasing (tasks at the front of the tour and tasks at the end of the tour separately).

This is a strict restriction and might fail validation if it is impossible to keep.

initassignedWorker
integer (Integer_u32) [ 0 .. 2147483647 ]

A hint for large optimization data sets, e.g. solution data from a previous optimization request. The field can also be used for dontAlter and dontVary assignments.

initassignedOrder
integer (Integer_u32) [ 0 .. 2147483647 ]

The order within the initially assigned worker's tour. Requires preassignedWorker or initassignedWorker.

initassignedShiftID
integer (Integer_u32) [ 0 .. 2147483647 ]

A shiftID to compliment either initassignedWorker or preassignedWorker in case the workerID is not unique.

precedingTasks
Array of integers (IDReferences) [ items [ 0 .. 2147483647 ] ]

Tasks in this list and this task will be performed by the same worker and all listed tasks will have to be finished before this task starts.

This is a strict restriction and might fail validation if it is impossible to keep.

preferredPrecedingTasks
Array of integers (IDReferences) [ items [ 0 .. 2147483647 ] ]

If the tasks in this list together with this task are performed by the same worker, all listed tasks should be completed before this task begins. If the tasks in this list and this task are performed by different workers, the order does not have to be followed.

This is a preference and can be violated for other preferences or restrictions.

predecessorTasks
Array of integers (IDReferences) [ items [ 0 .. 2147483647 ] ]

One of these tasks has be carried out right before this task by the same worker. Putting multiple values in the array does not mean they are carried out in that order - if you want to have a predecessor-chain, you need to set the direct predecessor on each task in the chain (see examples). Do not put redundant values in here, as having more than one value in the array has negative impact on performance and solution quality.

This is a strict restriction and might fail validation if it is impossible to keep.

assignmentPriority
integer (Integer_0_5) [ 0 .. 5 ]
Default: 1

A priority for assignment (see allowUnassignedTasks):.

  • 0 - no preference regarding unassignment, whether or not the task is assigned does not matter and will depend solely on other factors
  • 1-4 - progressively higher assignment importance
  • 5 - task has to be assigned

If allowUnassignedTasks is set to false, this field has no effect.

For tasks with an assignmentPriority of 5, the task being assigned is considered a strict restriction.

preferredGroup
integer (Integer_u32) [ 0 .. 2147483647 ]

Tasks with the same value in this field will preferably be assigned to the same worker shift. It does not incentivize the optimizer to assign the tasks consecutively, if you want that to happen, you have to use desiredPredecessorGroup.

This is a preference and can be violated for other preferences or restrictions. Its importance depends on the parameter groupPrefs.

desiredPredecessorGroup
integer (Integer_u32) [ 0 .. 2147483647 ]

Tasks with the same value in this field will preferably be assigned consecutively, if they are assigned to the same worker. It does not incentivize the optimizer to assign the tasks on the same worker, if you want that to happen, you have to use preferredGroup.

This is a preference and can be violated for other preferences or restrictions.

locationSiteID
integer (Integer_u32) [ 0 .. 2147483647 ]

An id for the position this task has to be carried out at.

prefGender
integer (GenderType) [ 0 .. 3 ]

The preferred gender for the assigned worker.

This is a preference and can be violated for other preferences or restrictions.

exclusiveSetID
integer (Integer_u32) [ 0 .. 2147483647 ]

Tasks with the same exclusiveSetID form a "set". A worker can only carry out tasks of at most one set (and any number of tasks without an exclusiveSetID - see hasStrictExclusiveSet). Please note that this does not force tasks of the same set to be assigned to the same worker.

This is a strict restriction and might fail validation if it is impossible to keep.

hasStrictExclusiveSet
boolean
Default: false

If this field is set to true, the worker carrying out this task cannot carry out tasks without an exclusiveSetID. In other words, the worker will only carry out tasks with the exact same exclusiveSetID as this task.

info
required
string

May contain some information about the task, will give a reason as to why this task is unassigned.

allowedWorkers
Array of integers (IDReferences) [ items [ 0 .. 2147483647 ] ]

A list of all workers (workerID) this task can be assigned to.

{
  • "taskID": 2147483647,
  • "externalID": "string",
  • "clientID": 2147483647,
  • "date": "2020-04-10",
  • "duration": 2147483647,
  • "durationInSeconds": 2147483647,
  • "timeEarliest": "07:25",
  • "timeLatest": "07:25",
  • "timePriority": 5,
  • "prefWorkers": [
    ],
  • "qualification": 2147483647,
  • "categories": [
    ],
  • "preassignedWorker": 2147483647,
  • "preassignedOrder": -2147483648,
  • "initassignedWorker": 2147483647,
  • "initassignedOrder": 2147483647,
  • "initassignedShiftID": 2147483647,
  • "precedingTasks": [
    ],
  • "preferredPrecedingTasks": [
    ],
  • "predecessorTasks": [
    ],
  • "assignmentPriority": 5,
  • "preferredGroup": 2147483647,
  • "desiredPredecessorGroup": 2147483647,
  • "locationSiteID": 2147483647,
  • "prefGender": 3,
  • "exclusiveSetID": 2147483647,
  • "hasStrictExclusiveSet": false,
  • "info": "string",
  • "allowedWorkers": [
    ]
}

FloorPlannerOutputWorker

workerID
required
integer (Integer_u32) [ 0 .. 2147483647 ]

The ID of the worker.

shiftID
integer (Integer_u32) [ 0 .. 2147483647 ]

A second ID in case there are multiple workers with the same workerID. This one needs to be unique among all workers with the same workerID. It can be referenced whenever a unique reference to this worker object is required.

externalID
string

A string to identify the worker in the solution. Cannot be used for reference in the input data or the optimizer, it only serves as a helping tool for integrations.

shiftDate
required
string (Date) ^[0-9]{4}-(0?[1-9]|1[0-2])-(0?[1-9]|[1-2][0-9...

The date of this shift.

shiftStart
required
string (Time) ^[-]?([0-9]{1,9}):([0-5][0-9]|[0-9])$

The time this shift starts.

This is a preference and can be violated for other preferences or restrictions.

shiftEnd
required
string (Time) ^[-]?([0-9]{1,9}):([0-5][0-9]|[0-9])$

The time this shift ends.

This is a preference and can be violated for other preferences or restrictions.

shiftPriority
integer (Integer_0_3) [ 0 .. 3 ]
Default: 1

The priority to keep the defined shift start and end times:

  • 0: irrelevant
  • 1: neutral
  • 2: important
  • 3: very important
qualification
integer (Integer_u32) [ 0 .. 2147483647 ]

The qualification of the worker. They are able to take over tasks with the same or lower qualification.

categories
Array of integers (IDReferences) [ items [ 0 .. 2147483647 ] ]

The worker can only carry out tasks if he has each category the task requires.

preferredCategories
Array of integers (IDReferences) [ items [ 0 .. 2147483647 ] ]

The worker prefers tasks that have any of these categories. Categories listed here are automatically considered valid as if they're listed in categories.

This is a preference and can be violated for other preferences or restrictions. Its importance depends on the parameter workerPrefs.

unpreferredCategories
Array of integers (IDReferences) [ items [ 0 .. 2147483647 ] ]

The worker has an aversion against tasks that have any of these categories. Categories listed here are automatically considered valid as if they're listed in categories.

This is a preference and can be violated for other preferences or restrictions. Its importance depends on the parameter workerPrefs.

desiredCategories
Array of integers (IDReferences) [ items [ 0 .. 2147483647 ] ]

The worker strongly prefers tasks that have any of these categories. Categories listed here are automatically considered valid as if they're listed in categories.

This is a preference and can be violated for other preferences or restrictions.

undesiredCategories
Array of integers (IDReferences) [ items [ 0 .. 2147483647 ] ]

The worker has a strong aversion against tasks that have any of these categories. Categories listed here are automatically considered valid as if they're listed in categories.

This is a preference and can be violated for other preferences or restrictions.

dontVary
boolean
Default: false

A worker with dontVary set to true is "fixed" for the optimizer, meaning they get assigned all tasks (and only those tasks) that have this worker set as preassignedWorker or initassignedWorker in the order of initassignedOrder. That also means that initassignedOrder is required for these tasks, as well as shiftID on the worker and initassignedShiftID on the task if the workerID is not unique. All assignments will be considered in statistics and info.

This is a strict restriction and might fail validation if it is impossible to keep.

dontAlter
boolean
Default: false

Workers with dontAlter set to true behave similarly to workers with dontVary. The only difference is that a dontVary-worker cannot get assigned more tasks than specified in the input data, a dontAlter-worker will be assigned all tasks that have this worker as initassignedWorker or preassignedWorker, but can also have other tasks assigned. While the preassigned/initassigned tasks will be in order of initassignedOrder, other tasks can be inserted before, between or after those tasks; if there is no initassignedOrder set, the task will be ignored. Every other behavior and requirement is exactly as in dontVary.

This is a strict restriction and might fail validation if it is impossible to keep.

allowPreassignedTasksOnly
boolean
Default: false

If this flag is true, only tasks preassigned to this worker can be assigned to it. Tasks not preassigned to this worker cannot be assigned to it.

This is a strict restriction and might fail validation if it is impossible to keep.

gender
integer (GenderType) [ 0 .. 3 ]

The gender of the worker.

info
string

Some textual information about the worker.

tourStart
string (Time) ^[-]?([0-9]{1,9}):([0-5][0-9]|[0-9])$

The actual time this worker starts their tour. The value is set only if the worker has a task assigned. If the worker has a task assigned and tourStartsOnShiftStart is set to true, it will always be equal to shiftStart.

tourEnd
string (Time) ^[-]?([0-9]{1,9}):([0-5][0-9]|[0-9])$

The actual time this worker ends their tour, including travel to its endLocation and any capacity resets.

totalTaskTime
required
integer (Integer_u32) [ 0 .. 2147483647 ]

The sum of all task durations on this worker.

{
  • "workerID": 2147483647,
  • "shiftID": 2147483647,
  • "externalID": "string",
  • "shiftDate": "2020-04-10",
  • "shiftStart": "07:25",
  • "shiftEnd": "07:25",
  • "shiftPriority": 3,
  • "qualification": 2147483647,
  • "categories": [
    ],
  • "preferredCategories": [
    ],
  • "unpreferredCategories": [
    ],
  • "desiredCategories": [
    ],
  • "undesiredCategories": [
    ],
  • "dontVary": false,
  • "dontAlter": false,
  • "allowPreassignedTasksOnly": false,
  • "gender": 3,
  • "info": "string",
  • "tourStart": "07:25",
  • "tourEnd": "07:25",
  • "totalTaskTime": 2147483647
}

Fraction

number (Fraction) [ 0 .. 1 ]
1

FloorPlannerStatistics

required
Array of objects

Contains all restriction types and gives the absolute value as well as a percentage (0.0-1.0) evaluation of each restriction's final influence on the algorithmic optimization and plan result.

timeWindowViolationTaskIDs
Array of integers (Integer_u32) [ items [ 0 .. 2147483647 ] ]

taskIDs of all tasks not assigned within their given time window

unassignedTaskIDs
Array of integers (Integer_u32) [ items [ 0 .. 2147483647 ] ]

taskIDs of all tasks that were not assigned during optimization.

unassignableTaskIDs
Array of integers (Integer_u32) [ items [ 0 .. 2147483647 ] ]

taskIDs of all tasks that were not assigned during optimization because there is no assignment possible (meaning they would fail input validation if unassigned tasks were not allowed).

object

All data determined from the history.

{
  • "impact": [
    ],
  • "timeWindowViolationTaskIDs": [
    ],
  • "unassignedTaskIDs": [
    ],
  • "unassignableTaskIDs": [
    ],
  • "history": {
    }
}

FloorPlannerInfo

feasible
required
boolean

Set to false if any restrictions are violated in the solution.

{
  • "feasible": true
}

FieldPlacerVersion

string (FieldPlacerVersion) ^[0-9]{4}-[0-9]{2}-[0-9]{2}_[0-9]+(p[0-9]+)?$...

A version consisting of the date of release [0-9]{4}-[0-9]{2}-[0-9]{2}_[0-9]+, which can have a patch suffix p[0-9]+.

"1970-01-01_0p0"

SemanticVersion

string (SemanticVersion) ^(v)?(0|([1-9][0-9]{0,4}))(\.(0|([1-9][0-9]{0...

See https://semver.org/ for a full description of semantic versioning. The regex here is a subset of allowed semantic versions.

"v1.2.3"

BackendVersion

version
any
Deprecated
Value: "v1.0.0"
optVersion
string (FieldPlacerVersion) ^[0-9]{4}-[0-9]{2}-[0-9]{2}_[0-9]+(p[0-9]+)?$...

The version of the algorithm used for calculating the result.

rev
string >= 7 characters

An internal identifier for the algorithm version.

schema
required
string (SemanticVersion) ^(v)?(0|([1-9][0-9]{0,4}))(\.(0|([1-9][0-9]{0...

The version of the schema used for validating both request data sent via the PUT request as well as response data gotten from the GET request.

{
  • "version": "v1.0.0",
  • "optVersion": "1970-01-01_0p0",
  • "rev": "strings",
  • "schema": "v1.2.3"
}

FloorPlannerOutputPlan

requestID
string

The identifier that allows finding input/output data, logs and more. This ID will be asked for in most non-trivial support cases so it should be stored when receiving the data.

object (Client)

Contains information about the client which sends this request.

required
object (FloorPlannerMeta)

Meta information about what to consider in the optimization.

required
object (FloorPlannerOptimizationParameters)

Parameters for the optimizer.

required
Array of FloorPlannerOutputTaskAssigned (object) or FloorPlannerOutputTaskUnassigned (object) (FloorPlannerOutputTask)

Array of assigned and unassigned tasks.

required
Array of objects (FloorPlannerOutputWorker)

Array of available Workers.

required
object (FloorPlannerStatistics)

Some statistics about the plan.

required
object (FloorPlannerInfo)

Some textual information about the plan.

Array of objects (Anomalies) non-empty

List of all anomalies found in solution.

required
object (BackendVersion)

Used validation/ calculation version.

recovery
Array of integers (IDReferences) [ items [ 0 .. 2147483647 ] ]
Deprecated

List of ids.

object (DeveloperOptions)

Additional debug information for developers.

{
  • "requestID": "string",
  • "client": {
    },
  • "meta": {
    },
  • "parameters": {
    },
  • "tasks": [
    ],
  • "workers": [
    ],
  • "statistics": {
    },
  • "info": {
    },
  • "anomalies": [
    ],
  • "backendVersion": {
    },
  • "recovery": [
    ],
  • "developerOptions": {
    }
}

VersionInfo

schema
string

Schema version against which input and output data are validated

version
string

Version of the application that calculates solutions

meta_data
string

Meta data version

api_scripts
string

Version of the scripts handling requests

{
  • "schema": "v1.7.0",
  • "version": "2024-10-01_0",
  • "meta_data": "v19",
  • "api_scripts": "v1.6.2"
}

PackagesList

Array
Name
required
string

Package name to use in the adiutaopt-version header

LastModified
string

Modification timestamp of the package, usually of the time it was uploaded at

object (VersionInfo)
[
  • {
    },
  • {
    }
]

Changelog

v9.3.3

  • In Client: Updated description for clientID.

v9.3.2

  • In Client: Updated description for clientID.

v9.3.1

  • In FloorPlannerOptimizationParameters: Updated descriptions for parameter entries.
    • Fixed incorrect description for workerPrefs

v9.3.0

  • In FloorPlannerInputTask: Added preassignedOrder

v9.1.1

  • Marked inactive errors in error id overview

v9.1.0

  • In FloorPlannerStatistics: Added property absolute to impact

v9.0.0

  • Added definition DeveloperOptions
  • In ErrorPlan: Added developerOptions, deprecated recovery
  • In FloorPlannerInputPlan, FloorPlannerOutputPlan: Added developerOptions, deprecated recovery

v8.6.0

  • In FloorPlannerStatisticHistoryTaskEntry: Added predecessorTask.

v8.4.0

  • In FloorPlannerInputWorker: Added allowPreassignedTasksOnly
  • In FloorPlannerInputTask: Updated description of preassignedWorker to better explain behaviour when there are multiple worker with the same workerID

v8.3.0

  • In FloorPlannerOutputTaskAssigned: Added timeWindowViolation

v8.1.0

  • In FloorPlannerInputTask: Added preferredPrecedingTasks.

v7.18.2

  • In FloorPlannerInputPlan: Updated description for history.
  • In FloorPlannerInputTask: Updated description for preassignedWorker, initassignedWorker, predecessorTasks.
  • Added example PredecessorChain for POST /floor-description endpoint

v7.17.0

  • Added accept and accept-encoding headers to GET /version, GET /packages-list endpoints, added 406 response code
  • Added 409 response code to all GET endpoints

v7.16.0

  • In FloorPlannerInputTask: Added desiredPredecessorGroup

v7.15.1

  • In Client: Updated description for clientID, added examples

v7.14.1

  • Updated descriptions to include whether a field is a restriction or a preference and optionally, if the latter, what parameter influences it.

v7.12.0

  • In OutputTaskAssigned, OutputTaskUnassigned: Added allowedWorkers

v7.11.0

  • In AnomalyEntry:
    • Added severity
    • Changed text to required

v7.10.0

  • In OutputPlan: Added anomalies

v7.9.0

  • In FloorPlannerInputTask: Added hasStrictExclusiveSet.

v7.8.0

  • Added section Index which contains all major schema defintions

v7.7.0

  • Updated 4xx and 5xx http responses with content documentation
  • Added description for PackagesList and VersionInfo component

v7.6.0

  • Added missing HEAD request documentation to GET endpoints

v7.5.0

  • Added response code 405 to all endpoints

v7.4.1

  • Updated changelog to only include changes related to the corresponding site.

v7.3.0

  • Added definition FloorPlannerOutput:
    • Combines FloorPlannerOutputPlan and ErrorPlan into one definition to use as schema in /plan GET response

v7.1.0

  • Added response code 429 to all POST requests
  • In ErrorPlan: Added allowRepeat

v5.1.0

  • Added new content-type options in POST requests:
    • application/vnd.adiutabyte.adiutaopt.json+gzip
    • application/vnd.adiutabyte.adiutaopt.json+deflate
    • application/vnd.adiutabyte.adiutaopt.json+br
  • Updated description for POST request, added explanations to response codes, compression and returned key
  • Added header accept-encoding in GET requests with allowed values:
    • identity
    • deflate
    • gzip
  • Added header accept in GET requests with allowed values:
    • application/json
    • application/vnd.adiutabyte.adiutaopt.json+gzip
    • application/vnd.adiutabyte.adiutaopt.json+deflate
    • application/vnd.adiutabyte.adiutaopt.json+br
  • Renamed header version to adiutaopt-version

v5.0.0

  • Restored compatibility to v3 schemata
  • In BackendVersion:
    • Changed version to be constant "v1.0.0", marked as deprecated
    • Added optVersion, has the same properties as version did in v4

v4.0.1

  • Added response codes to OPTIONS requests
  • Removed incorrect authentication details from OPTIONS requests

v4.0.0

  • Changed FieldPlacerVersion pattern to ^d{4}-d{2}-d{2}_d+(pd+)?$.

v2.9.0

  • Added header parameter Version to paths /floor-description and /floor-version
    • Updated curl/nodejs code examples to include one with the new header
  • Added path /floor-packages-list

v2.8.1

  • Fixed response content type for status 200, 201 for endpoint /floor-description

v2.2.0

  • In FloorPlannerMeta:
    • Added disableTaskTimeWindowRelaxation

v2.0.0

  • Added Number_s64

v1.14.0

  • In ErrorPlan
    • Added recovery

v1.13.0

  • In FloorPlannerInputPlan, FloorPlannerOutputPlan:
    • Added recovery

v1.11.0

  • In FloorPlannerMeta:
    • Added new field removeInvalidTasks

v1.9.0

  • Added some missing default values

v1.8.1

  • Added missing return codes 400, 413 to endpoints for posting new optimization requests

v1.8.0

  • In FloorPlannerInputTask:
    • Added exclusiveSetID
  • In FloorPlannerInputWorker:
    • Added preferredCategories
    • Added unpreferredCategories
    • Added desiredCategories
    • Added undesiredCategories

v1.7.3

  • Added missing return code 401 to all endpoints

v1.7.1

  • Minor (non-functional) rework of ErrorEntry
  • Minor (non-functional) rework of FloorPlannerInputTask, FloorPlannerInputWorker
  • Fixed unevaluated properties being allowed in:
    • ErrorPlan
  • Fixed unevaluated properties being allowed in:
    • FloorPlannerOutputTaskAssigned
    • FloorPlannerOutputTaskUnassigned
    • FloorPlannerOutputWorker

v1.7.0

  • In FloorPlannerInputTask:
    • Added property durationInSeconds
    • Removed duration from required properties