service_impacts
Creates, updates, deletes, gets or lists a service_impacts resource.
Overview
| Name | service_impacts |
| Type | Resource |
| Id | pagerduty.status_dashboards.service_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 | id | additional_fields[] | Get impacted Business Services for a Status Dashboard by id<br /><br />This endpoint does not return an exhaustive list of Business Services but rather provides access to the most impacted on the specified Status Dashboard 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 Business Service on the Status Dashboard that does not appear in the Impact-sorted response, use the ids[] parameter on the /business_services/impacts endpoint.<br /><br />Scoped OAuth requires: status_dashboards.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 |
|---|---|---|
id | string | The ID of the resource. |
additional_fields[] | string | Provides access to additional fields such as highest priority per business service and total impacted count |
SELECT examples
- list
Get impacted Business Services for a Status Dashboard by id<br /><br />This endpoint does not return an exhaustive list of Business Services but rather provides access to the most impacted on the specified Status Dashboard 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 Business Service on the Status Dashboard that does not appear in the Impact-sorted response, use the ids[] parameter on the /business_services/impacts endpoint.<br /><br />Scoped OAuth requires: status_dashboards.read<br />
SELECT
id,
name,
additional_fields,
status,
type
FROM pagerduty.status_dashboards.service_impacts
WHERE id = '{{ id }}' -- required
AND additional_fields[] = '{{ additional_fields[] }}'
;