Skip to main content
GET
Solution

Authorizations

Authorization
string
header
required

Api Key based authentication (apikey)

Path Parameters

id
string
required

Response

200 - application/json

OK

Fill response from solve

id
string | null

Id of the solve job

Example:

"0000-00000-00000-0000"

status
enum<string> | null

Status of the solve job.

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

"SOLVED"

score
object | null

The score of a solution shows how good this solution is w.r.t all the constraints. All solvers try to maximize the score.

assignments
object[] | null

Actual solution: assignments per shift

unassigned
string[] | null

Unassigned shifts

Example:

"[shift-1]"

unservedReasons
object | null

Per unassigned shift, the hard constraints blocking assignment.

Example:
suggestions
object[] | null

List of suggested shift assignments returned by suggest api call

violations
object[] | null