Start a job - Automatic Rostering

Authorization

string

header

required

Include the access token in the Authorization header using the Bearer scheme.

application/json

The data required to initialize a new solve job.

context

object

required

Show child attributes

employees

object[]

required

List of employees to be used in this roster.

Show child attributes

demands

object[]

required

List of demands used in this roster.

Show child attributes

shifts

object[]

List of shifts that employees can be assigned to.

Show child attributes

timeSlots

object[]

List of time slots for which demand can be specified (only if using TIME_DEMAND)

Show child attributes

constraints

object

Constraints that should be active for this solver run. Used to specify all sorts of preferences, rules and restrictions.

Show child attributes

extensions

object

Extensions that can be helpful in more advanced rostering scenarios.

Show child attributes

Response containing the job ID of the initiated solve job.

jobId

string<uuid>

required