tagged_entities

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

Overview

Name	tagged_entities
Type	Resource
Id	pagerduty.tags.tagged_entities

Fields

The following fields are returned by SELECT queries:

list

An array of connected entities.

Name	Datatype	Description
escalation_policies	array
limit	integer	Echoes limit pagination property.
more	boolean	Indicates if there are additional records to return
offset	integer	Echoes offset pagination property.
teams	array
total	integer	The total number of records matching the given query.
users	array

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	id, entity_type	limit, offset, total	Get related Users, Teams or Escalation Policies for the Tag.<br /><br />A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them.<br /><br />For more information see the [API Concepts Document](https:​//developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#tags)<br /><br />Scoped OAuth requires: tags.read<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
entity_type	string	Type of entity related with the tag
id	string	The ID of the resource.
limit	integer	The number of results per page.
offset	integer	Offset to start pagination search results.
total	boolean	By default the total field in pagination responses is set to null to provide the fastest possible response times. Set total to true for this field to be populated. See our [Pagination Docs](https:​//developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information.

SELECT examples

list

Get related Users, Teams or Escalation Policies for the Tag.<br /><br />A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them.<br /><br />For more information see the [API Concepts Document](https:​//developer.pagerduty.com/api-reference/a47605517c19a-api-concepts#tags)<br /><br />Scoped OAuth requires: tags.read<br />

SELECT
escalation_policies,
limit,
more,
offset,
teams,
total,
users
FROM pagerduty.tags.tagged_entities
WHERE id = '{{ id }}' -- required
AND entity_type = '{{ entity_type }}' -- required
AND limit = '{{ limit }}'
AND offset = '{{ offset }}'
AND total = '{{ total }}'
;