supporting_services_impacts
Creates, updates, deletes, gets or lists a supporting_services_impacts
resource.
Overview
Name | supporting_services_impacts |
Type | Resource |
Id | pagerduty.business_services.supporting_services_impacts |
Fields
The following fields are returned by SELECT
queries:
- get_business_service_supporting_service_impacts
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_business_service_supporting_service_impacts | select | id , X-EARLY-ACCESS | Accept , additional_fields[] , ids[] | Retrieve of Business Services that support the given Business Service sorted by highest Impact with status included.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. The returned Business Services are sorted first by Impact, secondarily by most recently impacted, and finally by name. To get impact information about a specific set of Business Services, use the ids[] parameter on the /business_services/impacts endpoint.<!-- 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_business_service_supporting_service_impacts | exec | id , X-EARLY-ACCESS | Accept , additional_fields[] , ids[] | Retrieve of Business Services that support the given Business Service sorted by highest Impact with status included.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. The returned Business Services are sorted first by Impact, secondarily by most recently impacted, and finally by name. To get impact information about a specific set of Business Services, use the ids[] parameter on the /business_services/impacts endpoint.<!-- 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! |
id | string | The ID of the resource. |
Accept | string | The Accept header is used as a versioning header. |
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
- get_business_service_supporting_service_impacts
Retrieve of Business Services that support the given Business Service sorted by highest Impact with status
included.
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.
The returned Business Services are sorted first by Impact, secondarily by most recently impacted, and finally by name.
To get impact information about a specific set of Business Services, use the ids[]
parameter on the /business_services/impacts
endpoint.
<!-- 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.business_services.supporting_services_impacts
WHERE id = '{{ id }}' -- required
AND X-EARLY-ACCESS = '{{ X-EARLY-ACCESS }}' -- required
AND Accept = '{{ Accept }}'
AND additional_fields[] = '{{ additional_fields[] }}'
AND ids[] = '{{ ids[] }}'
;
Lifecycle Methods
- _get_business_service_supporting_service_impacts
Retrieve of Business Services that support the given Business Service sorted by highest Impact with status
included.
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.
The returned Business Services are sorted first by Impact, secondarily by most recently impacted, and finally by name.
To get impact information about a specific set of Business Services, use the ids[]
parameter on the /business_services/impacts
endpoint.
<!-- 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.business_services.supporting_services_impacts._get_business_service_supporting_service_impacts
@id='{{ id }}' --required,
@X-EARLY-ACCESS='{{ X-EARLY-ACCESS }}' --required,
@Accept='{{ Accept }}',
@additional_fields[]='{{ additional_fields[] }}',
@ids[]='{{ ids[] }}'
;