Get Configuration Item Tags
Retrieve Returns a paginated list of configuration item (CI) tags. Tags are of type KEY_VALUE (key and value) or KEY_ONLY (key only).
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
This example shows a sample request to get configuration item tags.
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
input | GetAllConfigurationItemTagsInput | The pagination parameters used to retrieve configuration item (CI) tags. | Required | 67.0 |
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
nextPageCursor | 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 |
This example is a sample response from the getAllConfigurationItemTags query.
| Name | Type | Description | Available Version |
|---|---|---|---|
hasMoreTags | Boolean | Indicates whether more tags are available (true) or not (false). | 67.0 |
nextPageCursor | 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 number of tags per page. | 67.0 |
totalTags | Integer | The total number of tags. | 67.0 |
Configuration item tags returned when requested in the query.
| Name | Type | Description | Available Version |
|---|---|---|---|
key | BigInteger | The tag key name. | 67.0 |
keyId | BigInteger | 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 |