Create planning config

post

{backendUrlScheme}://{backendUrlHost}/api/public/planning-config/create

Create a new planning config. Provide a session ID in the header and the planning config details in the request body.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

required

Name of the planning config

description

string

Description of the planning config

skipTravelTimeStartDay

boolean

Indicates whether travel time at the start of the day is skipped (default: false)

skipTravelTimeEndDay

boolean

Indicates whether travel time at the end of the day is skipped (default: false)

maxTravelTimeFromBase

int64

Maximum allowed travel time (in milliseconds) from the base location to the first appointment

maxTravelTimeToBase

int64

Maximum allowed travel time (in milliseconds) from the last appointment back to the base location

maxDeltaTravelTime

int64

Maximum allowed increase in route travel time (in milliseconds)

maxTravelTime

int64

Maximum allowed route travel time (in milliseconds)

speedModifier

int64

Factor used to adjust the estimated time required to execute a task

maxTasks

int64

Maximum allowed tasks per shift

breakIds

array of strings

List of shift break IDs associated with this planning config

breakIds

archived

boolean

Defaults to false

Whether the planning config is archived

Headers

bsy-sid

string

required

Session ID

Responses

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Planning config created successfully

400Bad request, invalid planning config details

401Unauthorized access, invalid or missing session ID