Skip to main content
POST
Solve

Authorizations

Authorization
string
header
required

Api Key based authentication (apikey)

Query Parameters

millis
string | null

Body

application/json

FILL request for solving, evaluating

employees
employees · object[]
required

List of employees

Minimum array length: 1
shifts
object[]
required

List of shifts that should be assigned to employees

Minimum array length: 1
rules
object[] | null

List of Rules. Rules can be Counters or Series.

rests
object[] | null

List of Rest definitions. A rest is defined for a fixed period or a duration.

demands
object[] | null

List of shift demands. Demands are periodic minima and maxima for a certain number of employees to be present.

patterns
object[] | null

List of shift patterns. Patterns are sequences of shifts that can be desired or prohibited.

fairnessBuckets
object[] | null

Buckets or groups of employees where fairness in workload is required.

requirements
object[] | null

List of shared skill requirements. Shared skills are skill requirements that govern a group of shifts.

assignments
object[] | null

List of assignments that are pre-set. (optional)

weights
object | null

Weights adjust objectives and scores.

options
object

Options for tuning the solver

hook
string<uri> | null

Webhook endpoint to receive POST request with the id.

label
string | null
Maximum string length: 255
Pattern: ^(?!.*\$\{).*$
metadata
object | null

Response

OK

Status of a solve job

id
string
required

Job ID

status
enum<string> | null

Status of the solve.

Available options:
QUEUED,
SOLVING,
SOLVED,
ERROR
Example:

"SOLVING"

solveDuration
integer<int32> | null

Duration of the solve in seconds

errors
object[] | null

List of errors

warnings
object[] | null

List of warnings