service_active_statuses
Creates, updates, deletes, gets or lists a service_active_statuses resource.
Overview
| Name | service_active_statuses |
| Type | Resource |
| Id | pagerduty.event_orchestrations.service_active_statuses |
Fields
The following fields are returned by SELECT queries:
- get
An object with the active status.
| Name | Datatype | Description |
|---|---|---|
active | boolean | The status of the service orchestration. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | service_id | Get a Service Orchestration's active status.<br /><br />A Service Orchestration allows you to set an active status based on whether an event will be evaluated against a service orchestration path (true) or service ruleset (false).<br /><br />For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)<br /><br />Scoped OAuth requires: services.read<br /> | |
update | update | service_id | Update a Service Orchestration's active status.<br /><br />A Service Orchestration allows you to set an active status based on whether an event will be evaluated against a service orchestration path (true) or service ruleset (false).<br /><br />For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)<br /><br />Scoped OAuth requires: services.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 |
|---|---|---|
service_id | string | The service ID |
SELECT examples
- get
Get a Service Orchestration's active status.<br /><br />A Service Orchestration allows you to set an active status based on whether an event will be evaluated against a service orchestration path (true) or service ruleset (false).<br /><br />For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)<br /><br />Scoped OAuth requires: services.read<br />
SELECT
active
FROM pagerduty.event_orchestrations.service_active_statuses
WHERE service_id = '{{ service_id }}' -- required
;
UPDATE examples
- update
Update a Service Orchestration's active status.<br /><br />A Service Orchestration allows you to set an active status based on whether an event will be evaluated against a service orchestration path (true) or service ruleset (false).<br /><br />For more information see the [API Concepts Document](https://developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#event-orchestrations)<br /><br />Scoped OAuth requires: services.write<br />
UPDATE pagerduty.event_orchestrations.service_active_statuses
SET
active = {{ active }}
WHERE
service_id = '{{ service_id }}' --required
RETURNING
active;