Skip to main content
POST

Authorizations

Authorization
string
header
required

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

Body

application/json

The data required to initialize a new roster job.

context
object
required

High-level information about the job that is being started.

employees
object[]
required

List of employees to be used in this roster.

demands
object[]
required

List of demands used in this roster.

shifts
object[]

List of shifts that employees can be assigned to.

timeSlots
object[]

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

rules
object

Rules that should be active. Used to specify all sorts of preferences and restrictions.

extensions
object

Extensions that can be helpful in more advanced rostering scenarios.

statusOptions
object

Optional configuration for live status updates during the run, including metrics to track and return from the status endpoint.

Response

Response containing the job ID of the initiated roster job.

jobId
string<uuid>
required