Update Schedule Rotation

Schedule Identifier

Type of schedule identifier for the team. Choose one of the following options:

• Schedule ID: Unique ID of the schedule.
• Schedule Name: Name of the schedule.

Update Time Restriction?

Specify if time restriction is updated. Choose one of the following options:

• No: No updated time restriction.
• Time Only: Limit schedule rotation to a time of the week.
• Day and Time: Limit schedule rotation based on a certain day and time of the week.

Rotation

Schedule ID

Unique ID of the schedule.

This field displays when Schedule ID is selected from Schedule Identifier options.

Schedule Name

Name of the schedule.

This field displays when Schedule Name is selected from Schedule Identifier option.

Rotation ID

Unique ID of schedule rotation.

Name

Name of the rotation.

Start Date

Start date of the rotation. Date format as yyyy-MM-dd'T'HH:mm:ssZ (for example, 2017-01-15T08:00:00+02:00). Minutes may take 0 or 30 as value. Otherwise they will be converted to nearest 0 or 30 automatically.

End Date

End date of the rotation. Date format as yyyy-MM-dd'T'HH:mm:ssZ (for example, 2017-01-15T08:00:00+02:00) Minutes may take 0 or 30 as value. Otherwise they will be converted to nearest 0 or 30 automatically.

Type

Duration of rotation. Choose one of the following options:

• Hourly
• Daily
• Weekly

Length

Length of the rotation. Default value is 1.

Merge Participants?

Indicates whether to merge the existing participants list with the input list. Choose one of the following options:

• Yes
• No

Participants

List of escalations, teams, users or none which are used in a schedule. Each of them can be used multiple times and will be rotated in the order they are given.

For user and team, optionally define ID or username properties.

For example:

[
	{
		"type":"escalation",
		"id":"3f145401-e6f3-428f-9f3c-41b0e1d172d5",
		"name":"Team 2_escalation"
	},
	{
		"type":"user",
		"id":"d92b2aa1-4bc8-481b-a30e-4f19e5a27f83",
		"username":"johnathan.doe@okta.com"
	},
	{
		"type":"team",
		"id":"d00f95c1-2cce-4110-adbc-2ceca786c305",
		"username":"lily.doe@okta.com"
	},
	{
	"type":"none"
	}
]

Array of Objects

Time Restrictions

Used to limit schedule rotation to a certain day and time of the week, using multiple start and end times for each day of the week. This allows for applying different scheduling rotations at different times.

This field displays when Time Only or Day and Time is selected from Update Time Restriction? in Options.

When Time Only is selected for the Update Time Restrictions? field in Options, the following options are available.

Note: Hours are rounded down, and minutes are rounded to the closest 00/30.

For example:

{
	"startHour": 5
	"startMin": 30
	"endHour": 16
	"endMin": 0
}

When >Day and Time is selected for the Update Time Restrictions? field Options, the following options are available.

Note: Both day and time options are required.

Array of Objects

For example:

[
	{
		"startDay":"monday",
		"endDay":"tuesday",
		"startHour":8,
		"endHour":18,
		"startMin":0,
		"endMin":30
	},
	{
		"startDay":"thursday",
		"endDay":"sunday",
		"startHour":6,
		"endHour":8,
		"startMin":0,
		"endMin":30
	}
]

Status Code

Result

Result of the API call.

For example, Deleted.