Skip to main content
POST
/
jobs
{
  "jobId": "78f0aawf13a0436f916cd6gf468afc61",
  "statusCode": "starting",
  "link": {
    "rel": "request",
    "href": "/jobs/78f0aawf13a0436f916cd6gf468afc61/request"
  }
}

Authorizations

​
Authorization
string
header
required

Enter the token with the Bearer: prefix. You can retrieve token from Visma connect.

Headers

​
CUSTOMER_ID
string
required
​
USER_ID
string
required

Body

application/json

Payload format representing a rostering job.

​
jobInfo
object
required

Details about the job that the solver will solve.

​
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)

​
constraints
object

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

​
configuration
object

Configurations for this solver run.

​
extensions
object

Extensions that can be helpful in more advanced rostering scenarios.

Response

Job accepted for processing

​
jobId
string
required

Unique identifier for the job.

Example:

"78f0aawf13a0436f916cd6gf468afc61"

​
statusCode
enum<string>
required

Current status of the job.

Available options:
starting,
running,
stopped,
error
Example:

"starting"

​
link
object

Links to retrieve the request payload.