v1

latestOpenAPI 3.1.02026-07-2649128242.2 KB
Schedule

Generate Schedule Slots

The $generate operation populates the Slots for a Schedule. It will use the online booking preferences to ensure that the available times adhere to buffer time, lead time and advance booking limit.

post/main/Schedule/{id}/$generate

Path parameters

idstring required

Schedule identifier

Headers

prefer'respond-async'
Example:respond-async

Specifies whether the response is immediate or asynchronous. Setting this to respond-async triggers the async pattern.

Request body

updatePlanningHorizonboolean nullable

Pass true to update the planning horizon. Default is false.

Response

Schedule resource created

type'document' | 'message' | 'transaction' | 'transaction-response' | 'batch' | 'batch-response' | 'history' | 'searchset' | 'collection'

document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection

timestampstring date-time

When the bundle was assembled

totalinteger

If search, the total number of matches

idstring nullable

Logical id of this artifact

resourceTypestring nullable

Resource Type