Update Schedule

put

https://example.com/test/api/web/schedules/{ScheduleId}

api/web/schedules/{ScheduleId}

Updates an existing schedule based on the supplied model.
The 'Name', 'CalendarId', and 'TimeZoneId' properties of the model are required.

Path Params

ScheduleId

int32

required

≥ 1

The ID of the schedule to update (ScheduleId >= 1).

Body Params

The schedule model with updated data.

Schedule that controls execution of scheduled tasks.

Name

string

required

length ≥ 1

The name of the schedule.

TimeZoneId

string

required

length ≥ 1

The time zone IANA ID used by the API. Required on write. On read this is
null only when the stored Windows time zone has no IANA equivalent, in which
case SkySparc.Web.Backend.API.Models.WebAccess.APIScheduleModel.TimeZoneMappingError explains why and
SkySparc.Web.Backend.API.Models.WebAccess.APIScheduleModel.WindowsTimeZoneId carries the stored value.

CalendarId

int32

required

The ID of the calendar used with this schedule.

Comment

string | null

Gets or sets a comment (max length = 1000 characters).

Headers

content-type

string

enum

Defaults to application/json;odata.metadata=minimal;odata.streaming=true

Generated from available request content types

Response

200OK