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 | 67.0 |
filters | Filters | List of filters. | Optional | 67.0 |
sort | Sort | Sort criteria. | Optional | 67.0 |
pageNumber | Integer | The count of pages to return for results pagination. | Optional | 67.0 |
pageSize | Integer | The maximum number of history records to return in each page. | Optional | 67.0 |
Use Filters to filter audit results.
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
filterKey | String | The field to filter by. Valid values are:
| Required | 67.0 |
operator | String | The comparison operator to use for filtering. Valid values are:
| Required | 67.0 |
fromValue | String | First value of the filterKey. | Required | 67.0 |
toValue | String | Second value of the filterKey. Required if the FilterOperator requires two values. | Optional | 67.0 |
value | String | Filter value for single-value operators. | Optional | 67.0 |
Use SortCriteria to specify how search results should be ordered.
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
sortKey | String | The field name to use for sorting the search results.
| Required | 67.0 |
sortOrder | String | The sort direction for the results. Valid values are:
| Required | 67.0 |
This example is a sample response from the getConfigurationItemHistory query.
| Field | Type | Description | Available Version |
|---|---|---|---|
auditRecordId | ID | The unique identifer of the audit record. | 67.0 |
modifiedRecordId | ID | The unique identifier of the object that was modified. | 67.0 |
parentConfigurationItemId | ID | The unique identifier of the parent object. | 67.0 |
operationType | String | The operation type. | 67.0 |
modifiedByUserId | String | The unique identifier of the user who performed the update. | 67.0 |
modifiedOn | BigInterger | The date and time the object was last updated. | 67.0 |
attributeChanges | List | The list of attributes updated. | 67.0 |
modifiedAttributes | List | The list of updated attribute instances. | 67.0 |
| Field | Type | Description | Available Version |
|---|---|---|---|
attributeName | Boolean | The name of the updated attribute. | 67.0 |
originalValue | String | The original value before an update was performed. | 67.0 |
modifiedValue | String | The value after an update was performed. | 67.0 |
| Name | Type | Description | Available Version |
|---|---|---|---|
cnfgItemAuditRecords | CnfgItemAuditRecords | List of changes to the Configuration Item record. | 67.0 |
totalRecords | Integer | The total number of records that match the filter criteria across all pages, regardless of pagination. | 67.0 |