related_incidents
Creates, updates, deletes, gets or lists a related_incidents resource.
Overview
| Name | related_incidents |
| Type | Resource |
| Id | pagerduty.incidents.related_incidents |
Fields
The following fields are returned by SELECT queries:
- get_related_incidents
A list of Related Incidents and their relationships.
| Name | Datatype | Description |
|---|---|---|
incident_details | object | Details of the incident. |
relationship_details | array | A list of reasons for why the Incident is considered related. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_related_incidents | select | id | Accept, Content-Type, additional_details[] | Returns the 20 most recent Related Incidents that are impacting other Responders and Services. Note: This feature is currently available as part of the Event Intelligence package or Digital Operations plan only. For more information see the API Concepts Document Scoped OAuth requires: incidents.read |
_get_related_incidents | exec | id | Accept, Content-Type, additional_details[] | Returns the 20 most recent Related Incidents that are impacting other Responders and Services. Note: This feature is currently available as part of the Event Intelligence package or Digital Operations plan only. For more information see the API Concepts Document 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 | |
additional_details[] | string | Array of additional attributes to any of the returned incidents for related incidents. |
SELECT examples
- get_related_incidents
Returns the 20 most recent Related Incidents that are impacting other Responders and Services. Note: This feature is currently available as part of the Event Intelligence package or Digital Operations plan only.
For more information see the API Concepts Document
Scoped OAuth requires: incidents.read
SELECT
incident_details,
relationship_details
FROM pagerduty.incidents.related_incidents
WHERE id = '{{ id }}' -- required
AND Accept = '{{ Accept }}'
AND Content-Type = '{{ Content-Type }}'
AND additional_details[] = '{{ additional_details[] }}'
;
Lifecycle Methods
- _get_related_incidents
Returns the 20 most recent Related Incidents that are impacting other Responders and Services. Note: This feature is currently available as part of the Event Intelligence package or Digital Operations plan only.
For more information see the API Concepts Document
Scoped OAuth requires: incidents.read
EXEC pagerduty.incidents.related_incidents._get_related_incidents
@id='{{ id }}' --required,
@Accept='{{ Accept }}',
@Content-Type='{{ Content-Type }}',
@additional_details[]='{{ additional_details[] }}'
;