Search Schedules
Search for schedules in your PagerDuty instance.
Options
| Field | Definition | Type | Required |
|---|---|---|---|
| Result Set |
Choose one of the following options to display your search results:
|
Dropdown | TRUE |
To learn how to use the Stream Matching Records option and set up a helper flow to return a large number of records, see Stream matching records with a helper flow.
Input
| Field | Definition | Type | Required |
|---|---|---|---|
| Search By | |||
| Name |
Full or partial strings used to query records based on a value in the schedule's Name field. For example, to search for the schedule name dgKyDNfmB3, any of the following are valid query terms:
|
String | TRUE |
| Search Criteria | |||
| Records Limit |
Specified maximum number of records that can be streamed.
The minimum allowable value is 1; the maximum is 1,000,000. Records Limit input field is only available with the Stream Matching Records option. |
Number | FALSE |
| Streaming | |||
| Flow |
Click Choose Flow to browse and select a helper flow to which the search results will be streamed, then click Choose to confirm.
Optionally, click the empty field under Click or drop here to create and add custom extensible fields that pass data to the helper flow. These fields are added as key/value pairs under the State output object in the helper flow. |
Flow | TRUE |
Output
| Field | Definition | Type |
|---|---|---|
| Schedules | List of schedules that match the search criteria. | Object |
| Schedule ID | Unique identifier of the schedule. | String |
| Name | Name of the schedule. | String |
| Summary | A short string that provides succinct, information about the schedule. In many cases, this will be identical to Name, though it is not intended to be an identifier. | String |
| Description | A short description given to the schedule. | String |
| Type | Type of data returned. | String |
| Time Zone | Time zone of the schedule. Default is UTC. |
String |
| HTML URL | URL for the team profile in your PagerDuty instance. | String |
| 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 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 |
| 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 |