/system/schedules/{Schedule.name}

patch

https://switch-ip/rest/v10.16/system/schedules/{Schedule.name}

Path Params

Schedule.name

string

required

Reference Resource: Schedule
Schedule name.

Body Params

count

integer

1 to 1000

Maximum number of times the schedule can trigger. If not set, no limit is applied on the number of triggers. This is not applicable for 'one-shot' schedule type. Once schedule is triggered count number of times, the status changes to expired.

days_of_month

array of integers

length ≤ 31

Specify the days of the month associated with this schedule. If the day is greater than the number of days of that month, then the schedule gets triggered on last day of that month. This is only applicable when the schedule type is set to 'calendar' type.

days_of_month

days_of_week

array of strings

length ≤ 7

Specify the days of the week associated with this schedule. This is only applicable when the schedule type is set to 'calendar' type. Note: If both days_of_month and days_of_week are specified, then only days_of_week is considered.

days_of_week

description

string

length between 1 and 128

Description about the schedule.

disable

boolean

Disable the schedule.

job

object

Reference Resource: Job
Jobs associated with this schedule.

periodicity

object

Specify the periodic interval associated with this schedule. This is only applicable when the schedule type is set to 'periodic' type.

schedule_type

string

enum

Type of the schedule. 'calendar' : Triggered at a specific calendar date and time. 'one-shot' : Triggered only once at a specific calendar date and time. 'periodic' : Triggered at specific periodic intervals.

Allowed:

start_date

string

length between 10 and 10

Specify the start date in format YYYY-MM-DD for the schedule.

time

string

length between 5 and 5

Specify the time in HH:MM format. This indicates the schedule time, if the schedule type is set to 'calendar' or 'one-shot'. And this indicates the start time, if the schedule type is set to 'periodic'. Note that 'time' needs to be specified in conjunction with either 'days_of_month' or 'days_of_week' if the schedule type is set to 'calendar'. And 'time' needs to be specified in conjunction with 'periodicity', if the schedule type is set to 'periodic'.

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Unsupported Media Type

500

Internal Server Error

501

Not Implemented

503

Service Unavailable

Language

Response

Click Try It! to start a request and see the response here!