Read Schedule

Read a schedule from your PagerDuty instance.

Input

Field Definition Type Required
Schedule
Schedule ID Unique identifier of the schedule that will be read. String TRUE
Since Start of the date range for the schedule search.

For example, 2015-11-10T08:00:00-05:00.

Date & Time FALSE
Time Zone Time zone of the schedule. Default is UTC. String FALSE
Until End of the date range for the schedule search.

For example, 2015-11-10T17:00:00-05:00.

Date & Time FALSE

Output

Field Definition Type
Schedule ID Unique identifier of the schedule that will be updated. String
Name Name of the schedule layer. String
Summary A short summary for the schedule. May be identical to Name, but it is not intended to be an identifier. String
Description A description of the purpose for the schedule. String
Type Type of data returned. String
Time Zone Time zone of the schedule. String
HTML URL URL at which the entity is uniquely displayed in the PagerDuty web app. String
Schedule Layers List of schedule layers. A schedule must include at least one schedule layer. Object
Name Name of a schedule layer. String
Start Start time of this layer. Date & Time
End End time for this layer. If null, the layer doesn't end. Date & Time
Users List of user objects. List of Objects
User ID Unique identifier of the user. String
Summary A short summary for the user object. May be identical to Name, but it is not intended to be an identifier. String
Type 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. String
HTML URL URL at which the entity is uniquely displayed in the PagerDuty web app. String
Restrictions Array of restrictions for a schedule layer. A restriction is a limit on which period of the day or week the schedule layer can accept assignments. List of Objects
Type Specified type of restriction. String
Duration Seconds Duration of the restriction in seconds. Number
Start Time of Day Start time in HH:mm:ss format. String
Start Day of Week Only required for use with a weekly_restriction restriction type. The first day of the weekly rotation schedule as ISO 8601 day (1 is Monday, and so forth). Number
Rotation Virtual Start Effective start time of the layer. This can be before the start time of the schedule. Date & Time
Rotation Turn Length Seconds Duration of each on-call shift in seconds. Number
Rendered Schedule Entries List of entries on the computed layer for the current time range. Since or until must be set in order for this field to be populated. List of Objects
User (Object)
User ID Unique user identifier for a user object. String
Summary A short summary for the user object. May be identical to Name, but it is not intended to be an identifier. String
Type 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. String
HTML URL URL at which the entity is uniquely displayed in the PagerDuty web app. String
Start Start time of this entry. Date & Time
End End time for this entry. If null, the entry doesn't end. Date & Time
Rendered Coverage Percentage Percentage of the time range covered by this layer. Returns null unless since or until are set. Number
     
Final Schedule (Object)
Name Name of the subschedule. String
Rendered Schedule Entries List of entries on the computed layer for the current time range. Since or until must be set in order for this field to be populated. List of Objects
User (Object)    
User ID Unique user identifier for a user object. String
Summary A short summary for the user object. May be identical to Name, but it is not intended to be an identifier. String
Type 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. String
HTML URL URL at which the entity is uniquely displayed in the PagerDuty web app. String
Start Start time of this entry. Date & Time
End End time for this entry. If null, the entry doesn't end. Date & Time
Rendered Coverage Percentage Percentage of the time range covered by this layer. Returns null unless since or until are set. Number
     
Overrides Subschedule (Object)
Name Name of the subschedule String
Rendered Schedule Entries List of entries on the computed layer for the current time range. Since or until must be set in order for this field to be populated. List of Objects
User (Object)    
User ID Unique user identifier for a user object. String
Summary A short summary for the user object. May be identical to Name, but it is not intended to be an identifier. String
Type 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. String
HTML URL URL at which the entity is uniquely displayed in the PagerDuty web app. String
Start Start time of this entry. Date & Time
End End time for this entry. If null, the entry doesn't end. Date & Time
Rendered Coverage Percentage Percentage of the time range covered by this layer. Returns null unless since or until are set. Number
     
Escalation Policies (List of Objects)
Escalation Policy ID Unique user identifier for the escalation policy. String
Summary A short summary for the escalation policy object. May be identical to Name, but it is not intended to be an identifier. String
Type 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. String
HTML URL URL at which the entity is uniquely displayed in the PagerDuty web app. String
Users(List of Objects)
User ID Unique user identifier for a user object. String
Summary A short summary for the user object. May be identical to Name, but it is not intended to be an identifier. String
Type 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. String
HTML URL URL at which the entity is uniquely displayed in the PagerDuty web app. String
Teams(List of Objects)
Team ID Unique user identifier for a team object. String
Summary A short summary for the team object. May be identical to Name, but it is not intended to be an identifier. String
Type 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. String
HTML URL URL at which the entity is uniquely displayed in the PagerDuty web app. String

Related topics

PagerDuty connector

Elements of Workflows

PagerDuty REST API