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.

Special Access Rules

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

Request

JSON example

This example shows a sample request to retrieve the history of a specific configuration item.

1query GetConfigurationItemHistory {
2   getConfigurationItemHistory(
3       input: {
4           id: "6780001"
5           filters: [{ filterKey: TIME, fromValue: "1768545221848", operator: LESS_THAN_OR_EQUAL },
6           { filterKey: OPERATION_TYPE, toValue: "EDIT", operator: CONTAINS }]
7           pageNumber: 0
8           pageSize: 10
9           sort: { sortKey: OPERATION_TYPE, sortOrder: DESC }
10       }
11   ) {
12       totalRecords
13       cnfgItemAuditRecords {
14           modifiedRecordId
15           modifiedByUserId
16           attributeChanges {
17               attributeName
18               originalValue
19               modifiedValue
20           }
21           modifiedAttributes
22           operationType
23           userName
24           valid
25           time
26           auditRecordId
27           module
28           parentConfigurationItemId
29       }
30   }
31}

Properties

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

Filters Properties

Use Filters to filter audit results.

Name	Type	Description	Required or Optional	Available Version
`filterKey`	String	The field to filter by. Valid values are: `TIME` `OPERATION_TYPE`	Required	67.0
`operator`	String	The 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.	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

Sort Properties

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. `TIME` `OPERATION_TYPE`	Required	67.0
`sortOrder`	String	The sort direction for the results. Valid values are: `ASC` `DESC`	Required	67.0

Response

JSON example

This example is a sample response from the getConfigurationItemHistory query.

1{
2   "data": {
3       "getConfigurationItemHistory": {
4           "totalRecords": 7,
5           "cnfgItemAuditRecords": [
6               {
7                   "modifiedRecordId": "6780001",
8                   "modifiedByUserId": "470701",
9                   "attributeChanges": [
10                       {
11                           "attributeName": "Status",
12                           "modifiedValue": "In Build",
13                           "originalValue": ""
14                       },
15                       {
16                           "attributeName": "IP Address",
17                           "modifiedValue": "192.168.172.45",
18                           "originalValue": ""
19                       },
20                       {
21                           "attributeName": "Approval State",
22                           "modifiedValue": "Awaiting Approval",
23                           "originalValue": ""
24                       }
25                   ],
26                   "modifiedAttributes": [],
27                   "operationType": "EDIT_CMDBCI",
28                   "userName": "00Dxx00J5TkgqCi 00Dxx00J5TkgqCi",
29                   "valid": true,
30                   "time": 1768305455444,
31                   "auditRecordId": "36051312",
32                   "module": "CMDBCI",
33                   "parentConfigurationItemId": "6780001"
34               },
35               {
36                   "modifiedRecordId": "6780001",
37                   "modifiedByUserId": "470701",
38                   "attributeChanges": [
39                       {
40                           "attributeName": "Status",
41                           "modifiedValue": "In Test",
42                           "originalValue": "In Build"
43                       }
44                   ],
45                   "modifiedAttributes": [],
46                   "operationType": "EDIT_CMDBCI",
47                   "userName": "00Dxx00J5TkgqCi 00Dxx00J5TkgqCi",
48                   "valid": true,
49                   "time": 1768306294383,
50                   "id": "36056961",
51                   "module": "CMDBCI",
52                   "parentConfigurationItemId": "6780001"
53               }
54           ]
55       }
56   }
57}

CnfgItemAuditRecords

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

AuditRecordDetails

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

Properties

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