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 GetCIHistory {
2   getCIHistory(
3       input: {
4           ciId: "6780001"
5           filters: [{ filterKey: TIME, value1: "1768545221848", operator: LESS_THAN_OR_EQUAL },
6           { filterKey: OPERATION_TYPE, value1: "EDIT", operator: CONTAINS }]
7           pageNumber: 0
8           pageSize: 10
9           sort: { sortKey: OPERATION_TYPE, sortOrder: DESC }
10       }
11   ) {
12       totalRecords
13       auditRecords {
14           commentCount
15           entityId
16           userId
17           parameters {
18               propertyName
19               oldValue
20               newValue
21           }
22           propertyInstanceChanges
23           operationType
24           userName
25           valid
26           time
27           id
28           module
29           parentEntityId
30       }
31   }
32}

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	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

FilterCriteria Properties

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: `TIME` `OPERATION_TYPE`	Required	66.0
`operator`	`FilterOperator` (enumeration)	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	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

SortCriteria Properties

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: ASC—Ascending DESC—Descending	Required	66.0

Response

JSON example

This example is a sample response from the getCIHistory query.

1{
2   "data": {
3       "getCIHistory": {
4           "totalRecords": 7,
5           "auditRecords": [
6               {
7                   "commentCount": 0,
8                   "entityId": "6780001",
9                   "userId": "470701",
10                   "parameters": [
11                       {
12                           "propertyName": "Status",
13                           "oldValue": "",
14                           "newValue": "In Build"
15                       },
16                       {
17                           "propertyName": "IP Address",
18                           "oldValue": "",
19                           "newValue": "192.168.172.45"
20                       },
21                       {
22                           "propertyName": "Approval State",
23                           "oldValue": "",
24                           "newValue": "Awaiting Approval"
25                       }
26                   ],
27                   "propertyInstanceChanges": [],
28                   "operationType": "EDIT_CMDBCI",
29                   "userName": "00Dxx00J5TkgqCi 00Dxx00J5TkgqCi",
30                   "valid": true,
31                   "time": 1768305455444,
32                   "id": "36051312",
33                   "module": "CMDBCI",
34                   "parentEntityId": "6780001"
35               },
36               {
37                   "commentCount": 0,
38                   "entityId": "6780001",
39                   "userId": "470701",
40                   "parameters": [
41                       {
42                           "propertyName": "Status",
43                           "oldValue": "In Build",
44                           "newValue": "In Test"
45                       }
46                   ],
47                   "propertyInstanceChanges": [],
48                   "operationType": "EDIT_CMDBCI",
49                   "userName": "00Dxx00J5TkgqCi 00Dxx00J5TkgqCi",
50                   "valid": true,
51                   "time": 1768306294383,
52                   "id": "36056961",
53                   "module": "CMDBCI",
54                   "parentEntityId": "6780001"
55               },
56               {
57                   "commentCount": 0,
58                   "entityId": "6780001",
59                   "userId": "470701",
60                   "parameters": [
61                       {
62                           "propertyName": "Approval State",
63                           "oldValue": "Awaiting Approval",
64                           "newValue": "Approved"
65                       }
66                   ],
67                   "propertyInstanceChanges": [],
68                   "operationType": "EDIT_CMDBCI",
69                   "userName": "00Dxx00J5TkgqCi 00Dxx00J5TkgqCi",
70                   "valid": true,
71                   "time": 1768306278954,
72                   "id": "36057001",
73                   "module": "CMDBCI",
74                   "parentEntityId": "6780001"
75               },
76               {
77                   "commentCount": 0,
78                   "entityId": "6780001",
79                   "userId": "470701",
80                   "parameters": [
81                       {
82                           "propertyName": "Operating System",
83                           "oldValue": "",
84                           "newValue": "os123"
85                       }
86                   ],
87                   "propertyInstanceChanges": [],
88                   "operationType": "EDIT_CMDBCI",
89                   "userName": "00Dxx00J5TkgqCi 00Dxx00J5TkgqCi",
90                   "valid": true,
91                   "time": 1768306507193,
92                   "id": "36057003",
93                   "module": "CMDBCI",
94                   "parentEntityId": "6780001"
95               },
96               {
97                   "commentCount": 0,
98                   "entityId": "6780001",
99                   "userId": "470701",
100                   "parameters": [
101                       {
102                           "propertyName": "Status",
103                           "oldValue": "In Test",
104                           "newValue": "In Use"
105                       }
106                   ],
107                   "propertyInstanceChanges": [],
108                   "operationType": "EDIT_CMDBCI",
109                   "userName": "00Dxx00J5TkgqCi 00Dxx00J5TkgqCi",
110                   "valid": true,
111                   "time": 1768306528084,
112                   "id": "36057004",
113                   "module": "CMDBCI",
114                   "parentEntityId": "6780001"
115               },
116               {
117                   "commentCount": 0,
118                   "entityId": "6780001",
119                   "userId": "470701",
120                   "parameters": [
121                       {
122                           "propertyName": "Approval State",
123                           "oldValue": "Approved",
124                           "newValue": "Rejected"
125                       }
126                   ],
127                   "propertyInstanceChanges": [],
128                   "operationType": "EDIT_CMDBCI",
129                   "userName": "00Dxx00J5TkgqCi 00Dxx00J5TkgqCi",
130                   "valid": true,
131                   "time": 1768306286136,
132                   "id": "36057101",
133                   "module": "CMDBCI",
134                   "parentEntityId": "6780001"
135               },
136               {
137                   "commentCount": 0,
138                   "entityId": "6780001",
139                   "userId": "470701",
140                   "parameters": [
141                       {
142                           "propertyName": "Description",
143                           "oldValue": "",
144                           "newValue": "good"
145                       }
146                   ],
147                   "propertyInstanceChanges": [],
148                   "operationType": "EDIT_CMDBCI",
149                   "userName": "00Dxx00J5TkgqCi 00Dxx00J5TkgqCi",
150                   "valid": true,
151                   "time": 1768306518034,
152                   "id": "36057301",
153                   "module": "CMDBCI",
154                   "parentEntityId": "6780001"
155               }
156           ]
157       }
158   }
159}

Properties

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: `id` (ID): Row ID of that record. `time` (Int): Timestamp of that change. `parameters` ([ParameterObject]): Array of changes. `operationType` (String): Type of operation. `entityId` (String): CI ID. `userId` (String): User ID who performed the change.	66.0