global_paths
Creates, updates, deletes, gets or lists a global_paths resource.
Overview​
| Name | global_paths |
| Type | Resource |
| Id | pagerduty.event_orchestrations.global_paths |
Fields​
The following fields are returned by SELECT queries:
- get
The Global Orchestration Rules object.
| Name | Datatype | Description |
|---|---|---|
catch_all | object | When none of the Rules in a set match an event, we apply the catch_all actions to the event. |
created_at | string (date-time) | The date/time the object was created. |
created_by | object | Reference to the user that created the object. |
parent | object | |
sets | array | Must contain at least a "start" set, but can contain any number of additional sets that are routed to by other rules to form a directional graph of rules. |
type | string | (default: service) |
updated_at | string (date-time) | The date/time the object was last updated. |
updated_by | object | Reference to the user that last updated the object. |
version | string | Version of these Orchestration Rules |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | id | Get the Global Orchestration for an Event Orchestration.<br /><br />Global Orchestration Rules allows you to create a set of Event Rules. These rules evaluate against all Events sent to an Event Orchestration. When a matching rule is found, it can modify and enhance the event and can route the event to another set of Global Rules within this Orchestration for further processing.<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: event_orchestrations.read<br /> | |
update | update | id, orchestration_path | Update the Global Orchestration for an Event Orchestration.<br /><br />Global Orchestration Rules allows you to create a set of Event Rules. These rules evaluate against all Events sent to an Event Orchestration. When a matching rule is found, it can modify and enhance the event and can route the event to another set of Global Rules within this Orchestration for further processing.<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: event_orchestrations.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 |
|---|---|---|
id | string | The ID of an Event Orchestration. |
SELECT examples​
- get
Get the Global Orchestration for an Event Orchestration.<br /><br />Global Orchestration Rules allows you to create a set of Event Rules. These rules evaluate against all Events sent to an Event Orchestration. When a matching rule is found, it can modify and enhance the event and can route the event to another set of Global Rules within this Orchestration for further processing.<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: event_orchestrations.read<br />
SELECT
catch_all,
created_at,
created_by,
parent,
sets,
type,
updated_at,
updated_by,
version
FROM pagerduty.event_orchestrations.global_paths
WHERE id = '{{ id }}' -- required
;
UPDATE examples​
- update
Update the Global Orchestration for an Event Orchestration.<br /><br />Global Orchestration Rules allows you to create a set of Event Rules. These rules evaluate against all Events sent to an Event Orchestration. When a matching rule is found, it can modify and enhance the event and can route the event to another set of Global Rules within this Orchestration for further processing.<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: event_orchestrations.write<br />
UPDATE pagerduty.event_orchestrations.global_paths
SET
orchestration_path = '{{ orchestration_path }}'
WHERE
id = '{{ id }}' --required
AND orchestration_path = '{{ orchestration_path }}' --required
RETURNING
orchestration_path,
warnings;