schedules

Overview

Name	schedules
Type	Resource
Id	pagerduty.schedules.schedules

Fields

Name	Datatype	Description
id	string
name	string	The name of the schedule
description	string	The description of the schedule
_type	string	The type of object being created.
escalation_policies	array	An array of all of the escalation policies that uses this schedule.
final_schedule	object
html_url	string	a URL at which the entity is uniquely displayed in the Web app
overrides_subschedule	object
schedule_layers	array	A list of schedule layers.
self	string	the API show URL at which the object is accessible
summary	string	A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to name, though it is not intended to be an identifier.
teams	array	An array of all of the teams on the schedule.
time_zone	string	The time zone of the schedule.
type	string	A string that determines the schema of the object. This must be the standard name for the entity, suffixed by _reference if the object is a reference.
users	array	An array of all of the users on the schedule.

Methods

Name	Accessible by	Required Params	Description
get_schedule	SELECT	id	Show detailed information about a schedule, including entries for each layer and sub-schedule. Scoped OAuth requires: schedules.read
list_schedules	SELECT		List the on-call schedules. A Schedule determines the time periods that users are On-Call. For more information see the API Concepts Document Scoped OAuth requires: schedules.read
create_schedule	INSERT	data__schedule	Create a new on-call schedule. A Schedule determines the time periods that users are On-Call. For more information see the API Concepts Document Scoped OAuth requires: schedules.write
create_schedule_preview	INSERT	data__schedule	Preview what an on-call schedule would look like without saving it. A Schedule determines the time periods that users are On-Call. For more information see the API Concepts Document Scoped OAuth requires: schedules.write
delete_schedule	DELETE	id	Delete an on-call schedule. A Schedule determines the time periods that users are On-Call. For more information see the API Concepts Document Scoped OAuth requires: schedules.write
_get_schedule	EXEC	id	Show detailed information about a schedule, including entries for each layer and sub-schedule. Scoped OAuth requires: schedules.read
_list_schedules	EXEC		List the on-call schedules. A Schedule determines the time periods that users are On-Call. For more information see the API Concepts Document Scoped OAuth requires: schedules.read
update_schedule	EXEC	id, data__schedule	Update an existing on-call schedule. A Schedule determines the time periods that users are On-Call. For more information see the API Concepts Document Scoped OAuth requires: schedules.write