Publishes an intelligent schedule.

post

https://localhost:44395/api/admin/schedule/{scheduleId}/publish

Behavior: Publishes the intelligent schedule, optionally locking it for a specified number of days. When background mode is enabled (default), a batch action message is queued for asynchronous processing. When background mode is disabled, the schedule is published synchronously.

Authorization: Requires a valid Bearer token.

Side Effects: The schedule is published and its expiration date may be set. A batch action message may be sent for asynchronous processing.

Error Scenarios: Returns 400 if the request body is null. Returns 401 if the caller is not authenticated.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

scheduleId

uuid

required

The ID of the intelligent schedule to publish.

Query Params

background

boolean

Defaults to true

Whether to run the operation asynchronously in the background. Defaults to true.

Body Params

The publish request containing the number of locked days.

Represents a request to publish a schedule, locking it for a specified number of days.

scheduleId

uuid

Gets or sets schedule Id

numberOfLockedDays

int32

required

Gets or sets number of days to lock schedule

Headers

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

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

application/json

200The schedule was published successfully.

400The request body was null.

401Caller is not authenticated.