Start a job
{
"jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}Authorizations
Include the access token in the Authorization header using the Bearer scheme.
Body
The data required to initialize a new roster job.
High-level information about the job that is being started.
Show child attributes
Show child attributes
List of employees to be used in this roster.
Show child attributes
Show child attributes
List of demands used in this roster.
Show child attributes
Show child attributes
List of shifts that employees can be assigned to.
Show child attributes
Show child attributes
List of time slots for which demand can be specified (only if using TIME_DEMAND)
Show child attributes
Show child attributes
Rules that should be active. Used to specify all sorts of preferences and restrictions.
Show child attributes
Show child attributes
Extensions that can be helpful in more advanced rostering scenarios.
Show child attributes
Show child attributes
Optional configuration for live status updates during the run, including metrics to track and return from the status endpoint.
Show child attributes
Show child attributes
Response
Response containing the job ID of the initiated roster job.