impacts
Creates, updates, deletes, gets or lists an impacts resource.
Overview
| Name | impacts |
| Type | Resource |
| Id | pagerduty.business_services.impacts |
Fields
The following fields are returned by SELECT queries:
- list
| Name | Datatype | Description |
|---|---|---|
id | string | |
name | string | |
additional_fields | object | |
status | string | The current impact status of the object (impacted, not_impacted) |
type | string | The kind of object that has been impacted (business_service) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | additional_fields[], ids[] | Retrieve a list top-level Business Services sorted by highest Impact with status included.<br />When called without the ids[] parameter, this endpoint does not return an exhaustive list of Business Services but rather provides access to the most impacted up to the limit of 200.<br /><br />The returned Business Services are sorted first by Impact, secondarily by most recently impacted, and finally by name.<br /><br />To get impact information about a specific set of Business Services, use the ids[] parameter.<br />Scoped OAuth requires: services.read<br /> |
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 |
|---|---|---|
additional_fields[] | string | Provides access to additional fields such as highest priority per business service and total impacted count |
ids[] | string | The IDs of the resources. |
SELECT examples
- list
Retrieve a list top-level Business Services sorted by highest Impact with status included.<br />When called without the ids[] parameter, this endpoint does not return an exhaustive list of Business Services but rather provides access to the most impacted up to the limit of 200.<br /><br />The returned Business Services are sorted first by Impact, secondarily by most recently impacted, and finally by name.<br /><br />To get impact information about a specific set of Business Services, use the ids[] parameter.<br />Scoped OAuth requires: services.read<br />
SELECT
id,
name,
additional_fields,
status,
type
FROM pagerduty.business_services.impacts
WHERE additional_fields[] = '{{ additional_fields[] }}'
AND ids[] = '{{ ids[] }}'
;