Get Configuration Item Tags

Retrieve Returns a paginated list of configuration item (CI) tags. Tags can be of type KEY_VALUE (key and value) orKEY_ONLY (key only).

Special Access Rules

To query configuration item tags, you must have the following user permissions:

IT Service Configuration Item Type Manager
IT Service Configuration Item Owner
IT Service Configuration Item Type Reader

Request

JSON example

This example shows a sample request to get configuration item tags.

1query GetAllConfigurationItemTags {
2  getAllConfigurationItemTags(
3    input: {
4      pageSize: 10
5    }
6  ) {
7    pageSize
8    nextPointer
9    hasMore
10    ciTags {
11      type
12      key
13      keyId
14      valueId
15      value
16    }
17  }
18}

Properties

Name	Type	Description	Required or Optional	Available Version
`input`	GetAllTagsInput	The pagination parameters used to retrieve configuration item (CI) tags.	Required	67.0

GetAllTagsInput

Properties

Name	Type	Description	Required or Optional	Available Version
`nextPointer`	String	The pagination cursor. Omit this field or set it to `null` to retrieve the first page. To retrieve subsequent pages, specify the `nextPointer` value returned in the previous response.	Optional	67.0
`pageSize`	Integer	The number of tags to return per page. Defaults to `10` if not specified. Valid values are `1` through `200`.	Optional	67.0

Response

JSON example

This example is a sample response from the getAllConfigurationItemTags query.

1{
2  "data": {
3    "getAllTags": {
4      "ciTags": [
5        {
6          "type": "KEY_VALUE",
7          "key": "Environment",
8          "keyId": 764952,
9          "valueId": 859952,
10          "value": "Production"
11        },
12        {
13          "type": "KEY_ONLY",
14          "key": "Critical",
15          "keyId": 764953,
16          "valueId": null,
17          "value": null
18        }
19      ],
20      "pageSize": 10,
21      "nextPointer": "539953",
22      "hasMore": true
23    }
24  }
25}

Properties

Name	Type	Description	Available Version
`hasMore`	Boolean	Indicates whether more pages of tags are available after this page (`true`) or not (`false`).	67.0
`nextPointer`	String	The cursor for retrieving the next page of results. This field is `null` when no additional pages are available.	67.0
`pageSize`	Integer	The page size applied to this response.	67.0

CnfgItemTags

Configuration item tags returned when requested in the query.

Properties

Name	Type	Description	Available Version
`key`	BigInt	The tag key name.	67.0
`keyId`	BigInt	The unique identifier of the tag key.	67.0
`type`	String	The tag type: `KEY_VALUE` (key and value) or `KEY_ONLY` (key only).	67.0
`value`	String	The tag value. This field is null for KEY_ONLY tags.	67.0
`valueId`	String	The unique identifier of the tag value. This field is null for KEY_ONLY tags.	67.0