invocations

Creates, updates, deletes, gets or lists an invocations resource.

Overview

Name	invocations
Type	Resource
Id	pagerduty.automation_actions.invocations

Fields

The following fields are returned by SELECT queries:

get_automation_actions_invocation

Invocation information

Name	Datatype	Description
id	string
action_id	string
runner_id	string
action_snapshot	object
duration	integer	The duration of the invocation's execution time.
html_url	string (url)	a URL at which the entity is uniquely displayed in the Web app
metadata	object
self	string (url)	the API show URL at which the object is accessible
state	string	prepared -- the invocation exists and can be referenced, but is NOT available to a Runner created -- the invocation exists and is waiting for a Runner sent -- invocation sent to a Runner queued -- invocation queued by a Runner running -- invocation is being ran by a Runner aborted -- invocation was aborted on a Runner completed -- invocation completed on a Runner error -- invocation encountered an error on a Runner (example: sent)
summary	string	A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to name, though it is not intended to be an identifier.
timing	array	A list of state transitions with timestamps. Only the 'created' transition is guaranteed to exist at any time.
type	string	A string that determines the schema of the object. This must be the standard name for the entity, suffixed by _reference if the object is a reference.

list_automation_action_invocations

Invocations matching the criteria

Name	Datatype	Description
id	string
action_id	string
runner_id	string
action_snapshot	object
duration	integer	The duration of the invocation's execution time.
html_url	string (url)	a URL at which the entity is uniquely displayed in the Web app
metadata	object
self	string (url)	the API show URL at which the object is accessible
state	string	prepared -- the invocation exists and can be referenced, but is NOT available to a Runner created -- the invocation exists and is waiting for a Runner sent -- invocation sent to a Runner queued -- invocation queued by a Runner running -- invocation is being ran by a Runner aborted -- invocation was aborted on a Runner completed -- invocation completed on a Runner error -- invocation encountered an error on a Runner (example: sent)
summary	string	A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to name, though it is not intended to be an identifier.
timing	array	A list of state transitions with timestamps. Only the 'created' transition is guaranteed to exist at any time.
type	string	A string that determines the schema of the object. This must be the standard name for the entity, suffixed by _reference if the object is a reference.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_automation_actions_invocation	select	id	Accept, Content-Type	Get an Automation Action Invocation
list_automation_action_invocations	select	incident_id	Accept, Content-Type, invocation_state	List Invocations
_list_automation_action_invocations	exec	incident_id	Accept, Content-Type, invocation_state	List Invocations
_get_automation_actions_invocation	exec	id	Accept, Content-Type	Get an Automation Action Invocation

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 the resource.
incident_id	string	Incident ID
Accept	string	The Accept header is used as a versioning header.
Content-Type	string
invocation_state	string	Invocation state

SELECT examples

get_automation_actions_invocation

Get an Automation Action Invocation

SELECT
id,
action_id,
runner_id,
action_snapshot,
duration,
html_url,
metadata,
self,
state,
summary,
timing,
type
FROM pagerduty.automation_actions.invocations
WHERE id = '{{ id }}' -- required
AND Accept = '{{ Accept }}'
AND Content-Type = '{{ Content-Type }}'
;

list_automation_action_invocations

List Invocations

SELECT
id,
action_id,
runner_id,
action_snapshot,
duration,
html_url,
metadata,
self,
state,
summary,
timing,
type
FROM pagerduty.automation_actions.invocations
WHERE incident_id = '{{ incident_id }}' -- required
AND Accept = '{{ Accept }}'
AND Content-Type = '{{ Content-Type }}'
AND invocation_state = '{{ invocation_state }}'
;

Lifecycle Methods

_list_automation_action_invocations

List Invocations

EXEC pagerduty.automation_actions.invocations._list_automation_action_invocations 
@incident_id='{{ incident_id }}' --required, 
@Accept='{{ Accept }}', 
@Content-Type='{{ Content-Type }}', 
@invocation_state='{{ invocation_state }}'
;

_get_automation_actions_invocation

Get an Automation Action Invocation

EXEC pagerduty.automation_actions.invocations._get_automation_actions_invocation 
@id='{{ id }}' --required, 
@Accept='{{ Accept }}', 
@Content-Type='{{ Content-Type }}'
;