services_active

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

Overview

Name	services_active
Type	Resource
Id	pagerduty.event_orchestrations.services_active

Fields

The following fields are returned by SELECT queries:

get_orch_active_status

An object with the active status.

Name	Datatype	Description

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_orch_active_status	select	service_id	Accept, Content-Type	Get a Service Orchestration's active status. 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). For more information see the API Concepts Document Scoped OAuth requires: services.read
_get_orch_active_status	exec	service_id	Accept, Content-Type	Get a Service Orchestration's active status. 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). For more information see the API Concepts Document Scoped OAuth requires: services.read
update_orch_active_status	exec	service_id	Accept, Content-Type	Update a Service Orchestration's active status. 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). For more information see the API Concepts Document Scoped OAuth requires: services.write

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
Accept	string	The Accept header is used as a versioning header.
Content-Type	string

SELECT examples

get_orch_active_status

Get a Service Orchestration's active status.

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).

For more information see the API Concepts Document

Scoped OAuth requires: services.read

SELECT
*
FROM pagerduty.event_orchestrations.services_active
WHERE service_id = '{{ service_id }}' -- required
AND Accept = '{{ Accept }}'
AND Content-Type = '{{ Content-Type }}'
;

Lifecycle Methods

_get_orch_active_status

Get a Service Orchestration's active status.

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).

For more information see the API Concepts Document

Scoped OAuth requires: services.read

EXEC pagerduty.event_orchestrations.services_active._get_orch_active_status 
@service_id='{{ service_id }}' --required, 
@Accept='{{ Accept }}', 
@Content-Type='{{ Content-Type }}'
;

update_orch_active_status

Update a Service Orchestration's active status.

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).

For more information see the API Concepts Document

Scoped OAuth requires: services.write

EXEC pagerduty.event_orchestrations.services_active.update_orch_active_status 
@service_id='{{ service_id }}' --required, 
@Accept='{{ Accept }}', 
@Content-Type='{{ Content-Type }}' 
@@json=
'{
"active": {{ active }}
}'
;