Get Configuration Item History

Perform a paginated retrieval of the audit trail for a specific configuration item. Returns a list of changes, including field-level modifications, timestamps, and user information.

To query a configuration item history, 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 retrieve the history of a specific configuration item.

NameTypeDescriptionRequired or OptionalAvailable Version
idIntegerThe unique identifier of the Configuration Item record whose history is to be retrieved.Required67.0
filtersFiltersList of filters.Optional67.0
sortSortSort criteria.Optional67.0
pageNumberIntegerThe count of pages to return for results pagination.Optional67.0
pageSizeIntegerThe maximum number of history records to return in each page.Optional67.0

Use Filters to filter audit results.

NameTypeDescriptionRequired or OptionalAvailable Version
filterKeyStringThe field to filter by. Valid values are:
  • TIME
  • OPERATION_TYPE
Required67.0
operatorStringThe comparison operator to use for filtering. Valid values are:
  • EQUALS—Matches a single exact value. Use with exactly one value in the values array.
  • NOT_EQUALS—Does not match a single exact value. Use with exactly one value in the values array.
  • CONTAINS—Matches if the field contains the specified value. Use with exactly one value in the values array.
  • NOT_CONTAINS—Matches if the field does not contain the specified value. Use with exactly one value in the values array.
  • GREATER_THAN—Matches if the field value is greater than the specified value. Use with exactly one value in the values array.
  • GREATER_THAN_OR_EQUAL—Matches if the field value is greater than or equal to the specified value. Use with exactly one value in the values array.
  • LESS_THAN—Matches if the field value is less than the specified value. Use with exactly one value in the values array.
  • LESS_THAN_OR_EQUAL—Matches if the field value is less than or equal to the specified value. Use with exactly one value in the values array.
  • IS_BETWEEN—Matches if the field value is between two specified values (inclusive). Use with exactly two values in the values array.
  • NOT_BETWEEN—Matches if the field value is not between two specified values (inclusive). Use with exactly two values in the values array.
Required67.0
fromValueStringFirst value of the filterKey.Required67.0
toValueStringSecond value of the filterKey. Required if the FilterOperator requires two values.Optional67.0
valueStringFilter value for single-value operators.Optional67.0

Use SortCriteria to specify how search results should be ordered.

NameTypeDescriptionRequired or OptionalAvailable Version
sortKeyStringThe field name to use for sorting the search results.
  • TIME
  • OPERATION_TYPE
Required67.0
sortOrderStringThe sort direction for the results. Valid values are:
  • ASC
  • DESC
Required67.0

This example is a sample response from the getConfigurationItemHistory query.

FieldTypeDescriptionAvailable Version
auditRecordIdIDThe unique identifer of the audit record.67.0
modifiedRecordIdIDThe unique identifier of the object that was modified.67.0
parentConfigurationItemIdIDThe unique identifier of the parent object.67.0
operationTypeStringThe operation type.67.0
modifiedByUserIdStringThe unique identifier of the user who performed the update.67.0
modifiedOnBigIntergerThe date and time the object was last updated.67.0
attributeChangesListThe list of attributes updated.67.0
modifiedAttributesListThe list of updated attribute instances.67.0
FieldTypeDescriptionAvailable Version
attributeNameBooleanThe name of the updated attribute.67.0
originalValueStringThe original value before an update was performed.67.0
modifiedValueStringThe value after an update was performed.67.0
NameTypeDescriptionAvailable Version
cnfgItemAuditRecordsCnfgItemAuditRecordsList of changes to the Configuration Item record.67.0
totalRecordsIntegerThe total number of records that match the filter criteria across all pages, regardless of pagination.67.0