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.
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
id | Integer | The unique identifier of the Configuration Item record whose history is to be retrieved. | Required | 66.0 |
filters | CIHistoryFilterCriteria[] | List of filters. | Optional | 66.0 |
sort | CIHistorySortCriteria | Sort criteria. | Optional | 66.0 |
pageNumber | Integer | The count of pages to return for results pagination. | Optional | 66.0 |
pageSize | Integer | The maximum number of history records to return in each page. | Optional | 66.0 |
Use FilterCriteria to filter audit results.
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
filterKey | CIHistoryFilterKey (enumeration) | The field to filter by. Valid values are:
| Required | 66.0 |
operator | FilterOperator (enumeration) | The comparison operator to use for filtering. Valid values are:
| Required | 66.0 |
value1 | String | First value of the filterKey. | Required | 66.0 |
value2 | String | Second value of the filterKey. Required if the FilterOperator requires two values. | Optional | 66.0 |
Use SortCriteria to specify how search results should be ordered.
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
sortKey | CIHistoryFilterKey | The field name to use for sorting the search results. | Required | 66.0 |
sortOrder | SortOrder | The sort direction for the results. Valid values are:
| Required | 66.0 |
This example is a sample response from the getCIHistory query.
| Name | Type | Description | Available Version |
|---|---|---|---|
totalRecords | Integer | The total number of records that match the filter criteria across all pages, regardless of pagination. | 66.0 |
auditRecords | [AuditRecord] | List of changes to the Configuration Item record. Each object contains these fields:
| 66.0 |