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.

NameTypeDescriptionRequired or OptionalAvailable Version
inputGetAllConfigurationItemTagsInputThe pagination parameters used to retrieve configuration item (CI) tags.Required67.0
NameTypeDescriptionRequired or OptionalAvailable Version
nextPageCursorStringThe 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.Optional67.0
pageSizeIntegerThe number of tags to return per page. Defaults to 10 if not specified. Valid values are 1 through 200.Optional67.0

This example is a sample response from the getAllConfigurationItemTags query.

NameTypeDescriptionAvailable Version
hasMoreTagsBooleanIndicates whether more tags are available (true) or not (false).67.0
nextPageCursorStringThe cursor for retrieving the next page of results. This field is null when no additional pages are available.67.0
pageSizeIntegerThe number of tags per page.67.0
totalTagsIntegerThe total number of tags.67.0

Configuration item tags returned when requested in the query.

NameTypeDescriptionAvailable Version
keyBigIntegerThe tag key name.67.0
keyIdBigIntegerThe unique identifier of the tag key.67.0
typeStringThe tag type: KEY_VALUE (key and value) or KEY_ONLY (key only).67.0
valueStringThe tag value. This field is null for KEY_ONLY tags.67.0
valueIdStringThe unique identifier of the tag value. This field is null for KEY_ONLY tags.67.0