business_service_impacts

Creates, updates, deletes, gets or lists a business_service_impacts resource.

Overview

Name	business_service_impacts
Type	Resource
Id	pagerduty.incidents.business_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		Retrieve a list of Business Services that are being impacted by the given Incident.<br />Scoped OAuth requires: incidents.read<br />
update	update	id, business_service_id, relation		Change Impact of an Incident on a Business Service.<br />Scoped OAuth requires: incidents.write<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
business_service_id	string	The business service ID.
id	string	The ID of the resource.

SELECT examples

list

Retrieve a list of Business Services that are being impacted by the given Incident.<br />Scoped OAuth requires: incidents.read<br />

SELECT
id,
name,
additional_fields,
status,
type
FROM pagerduty.incidents.business_service_impacts
WHERE id = '{{ id }}' -- required
;

UPDATE examples

update

Change Impact of an Incident on a Business Service.<br />Scoped OAuth requires: incidents.write<br />

UPDATE pagerduty.incidents.business_service_impacts
SET 
relation = '{{ relation }}'
WHERE 
id = '{{ id }}' --required
AND business_service_id = '{{ business_service_id }}' --required
AND relation = '{{ relation }}' --required
RETURNING
relation;