business_services_impacts
Creates, updates, deletes, gets or lists a business_services_impacts
resource.
Overview
Name | business_services_impacts |
Type | Resource |
Id | pagerduty.incidents.business_services_impacts |
Fields
The following fields are returned by SELECT
queries:
- get_incident_impacted_business_services
Name | Datatype | Description |
---|---|---|
id | string | |
name | string | |
additional_fields | object | |
status | string | The current impact status of the object |
type | string | The kind of object that has been impacted |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get_incident_impacted_business_services | select | id , X-EARLY-ACCESS | Accept | Retrieve a list of Business Services that are being impacted by the given Incident. <!-- theme: warning --> > ### Early Access > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. |
put_incident_manual_business_service_association | exec | id , business_service_id , X-EARLY-ACCESS , relation | Accept | Change Impact of an Incident on a Business Service. <!-- theme: warning --> > ### Early Access > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. |
_get_incident_impacted_business_services | exec | id , X-EARLY-ACCESS | Accept | Retrieve a list of Business Services that are being impacted by the given Incident. <!-- theme: warning --> > ### Early Access > This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it. |
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 |
---|---|---|
X-EARLY-ACCESS | string | This header indicates that this API endpoint is UNDER CONSTRUCTION and may change at any time. You MUST pass in this header with the value business-impact-early-access . Do not use this endpoint in production, as it may change! |
business_service_id | string | The business service ID. |
id | string | The ID of the resource. |
Accept | string | The Accept header is used as a versioning header. |
SELECT
examples
- get_incident_impacted_business_services
Retrieve a list of Business Services that are being impacted by the given Incident.
<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
SELECT
id,
name,
additional_fields,
status,
type
FROM pagerduty.incidents.business_services_impacts
WHERE id = '{{ id }}' -- required
AND X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' -- required
AND Accept = '{{ Accept }}'
;
Lifecycle Methods
- put_incident_manual_business_service_association
- _get_incident_impacted_business_services
Change Impact of an Incident on a Business Service.
<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
EXEC pagerduty.incidents.business_services_impacts.put_incident_manual_business_service_association
@id='{{ id }}' --required,
@business_service_id='{{ business_service_id }}' --required,
@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required,
@Accept='{{ Accept }}'
@@json=
'{
"relation": "{{ relation }}"
}'
;
Retrieve a list of Business Services that are being impacted by the given Incident.
<!-- theme: warning -->
> ### Early Access
> This endpoint is in Early Access and may change at any time. You must pass in the X-EARLY-ACCESS header to access it.
EXEC pagerduty.incidents.business_services_impacts._get_incident_impacted_business_services
@id='{{ id }}' --required,
@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required,
@Accept='{{ Accept }}'
;