runner_teams
Creates, updates, deletes, gets or lists a runner_teams resource.
Overview
| Name | runner_teams |
| Type | Resource |
| Id | pagerduty.automation_actions.runner_teams |
Fields
The following fields are returned by SELECT queries:
- get
- list
| Name | Datatype | Description |
|---|---|---|
id | string | |
html_url | string (url) | a URL at which the entity is uniquely displayed in the Web app |
self | string (url) | the API show URL at which the object is accessible |
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. |
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. |
| Name | Datatype | Description |
|---|---|---|
id | string | |
html_url | string (url) | a URL at which the entity is uniquely displayed in the Web app |
self | string (url) | the API show URL at which the object is accessible |
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. |
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 | select | id, team_id | Gets the details of a runner / team relation | |
list | select | id | Gets all team references associated with a runner | |
create | insert | id, team | Associate a runner with a team<br /> | |
delete | delete | id, team_id | Disassociates a runner from a team<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 the resource. |
team_id | string | The team ID |
SELECT examples
- get
- list
Gets the details of a runner / team relation
SELECT
id,
html_url,
self,
summary,
type
FROM pagerduty.automation_actions.runner_teams
WHERE id = '{{ id }}' -- required
AND team_id = '{{ team_id }}' -- required
;
Gets all team references associated with a runner
SELECT
id,
html_url,
self,
summary,
type
FROM pagerduty.automation_actions.runner_teams
WHERE id = '{{ id }}' -- required
;
INSERT examples
- create
- Manifest
Associate a runner with a team<br />
INSERT INTO pagerduty.automation_actions.runner_teams (
team,
id
)
SELECT
'{{ team }}' /* required */,
'{{ id }}'
RETURNING
team
;
# Description fields are for documentation purposes
- name: runner_teams
props:
- name: id
value: "{{ id }}"
description: Required parameter for the runner_teams resource.
- name: team
description: |
(opaque JSON object)
value:
id: "{{ id }}"
summary: "{{ summary }}"
type: "{{ type }}"
self: "{{ self }}"
html_url: "{{ html_url }}"
DELETE examples
- delete
Disassociates a runner from a team<br />
DELETE FROM pagerduty.automation_actions.runner_teams
WHERE id = '{{ id }}' --required
AND team_id = '{{ team_id }}' --required
;