incidents_related_change_events
Creates, updates, deletes, gets or lists an incidents_related_change_events resource.
Overview
| Name | incidents_related_change_events |
| Type | Resource |
| Id | pagerduty.change_events.incidents_related_change_events |
Fields
The following fields are returned by SELECT queries:
- list_incident_related_change_events
The array of Change Events returned by the query.
| Name | Datatype | Description |
|---|---|---|
id | string | |
correlation_reason | object | |
custom_details | object | Additional details about the change event. (title: Custom Details) |
html_url | string (url) | a URL at which the entity is uniquely displayed in the Web app |
images | array | |
integration | object | |
links | array | List of links to include. |
routing_key | string | This is the 32 character Integration Key for an Integration on a Service. The same Integration Key can be used for both alert and change events. (title: Routing Key) |
self | string (url) | the API show URL at which the object is accessible |
services | array | An array containing Service objects that this change event is associated with. |
source | string | The unique name of the location where the Change Event occurred. |
summary | string | A brief text summary of the event. Displayed in PagerDuty to provide information about the change. The maximum permitted length of this property is 1024 characters. |
timestamp | string (date-time) | The time at which the emitting tool detected or generated the event. |
type | string | The type of object being created. (default: change_event) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_incident_related_change_events | select | id | limit, Accept, Content-Type | List related Change Events for an Incident, as well as the reason these changes are correlated with the incident. Change events represent service changes such as deploys, build completion, and configuration changes, providing information that is critical during incident triage or hypercare. For more information on change events, see Change Events. The Change Correlation feature provides incident responders with recent change events that are most relevant to that incident. Change Correlation informs the responder why a particular change event was surfaced and correlated to an incident based on three key factors which include time, related service, or intelligence (machine learning). Scoped OAuth requires: incidents.read |
_list_incident_related_change_events | exec | id | limit, Accept, Content-Type | List related Change Events for an Incident, as well as the reason these changes are correlated with the incident. Change events represent service changes such as deploys, build completion, and configuration changes, providing information that is critical during incident triage or hypercare. For more information on change events, see Change Events. The Change Correlation feature provides incident responders with recent change events that are most relevant to that incident. Change Correlation informs the responder why a particular change event was surfaced and correlated to an incident based on three key factors which include time, related service, or intelligence (machine learning). Scoped OAuth requires: incidents.read |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
id | string | The ID of the resource. |
Accept | string | The Accept header is used as a versioning header. |
Content-Type | string | |
limit | integer | The number of results per page. |
SELECT examples
- list_incident_related_change_events
List related Change Events for an Incident, as well as the reason these changes are correlated with the incident.
Change events represent service changes such as deploys, build completion, and configuration changes, providing information that is critical during incident triage or hypercare. For more information on change events, see Change Events.
The Change Correlation feature provides incident responders with recent change events that are most relevant to that incident. Change Correlation informs the responder why a particular change event was surfaced and correlated to an incident based on three key factors which include time, related service, or intelligence (machine learning).
Scoped OAuth requires: incidents.read
SELECT
id,
correlation_reason,
custom_details,
html_url,
images,
integration,
links,
routing_key,
self,
services,
source,
summary,
timestamp,
type
FROM pagerduty.change_events.incidents_related_change_events
WHERE id = '{{ id }}' -- required
AND limit = '{{ limit }}'
AND Accept = '{{ Accept }}'
AND Content-Type = '{{ Content-Type }}'
;
Lifecycle Methods
- _list_incident_related_change_events
List related Change Events for an Incident, as well as the reason these changes are correlated with the incident.
Change events represent service changes such as deploys, build completion, and configuration changes, providing information that is critical during incident triage or hypercare. For more information on change events, see Change Events.
The Change Correlation feature provides incident responders with recent change events that are most relevant to that incident. Change Correlation informs the responder why a particular change event was surfaced and correlated to an incident based on three key factors which include time, related service, or intelligence (machine learning).
Scoped OAuth requires: incidents.read
EXEC pagerduty.change_events.incidents_related_change_events._list_incident_related_change_events
@id='{{ id }}' --required,
@limit='{{ limit }}',
@Accept='{{ Accept }}',
@Content-Type='{{ Content-Type }}'
;