Get Audit Trail
post
/config/sim/v2/getAuditTrail
Gets all audit trail records
Request
Supported Media Types
- application/json
- multipart/form-data
Root Schema : schema
Type:
Show Source
object-
include:
string
If specified, limits the data returned to these fields.Example:
hierUnitId, operation, fileNum -
limit:
integer
If using paging, number of results returned in this page.Example:
100 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supportedExample:
0 -
orderBy:
string
Sorts the response by the specified field name and sort order. Allowed fields are hierUnitId, hierStrucId, operation, subSystem, auditTime, itemNumber, auditTrailId, fileNum and employeeObjNum.Example:
hierUnitId:asc -
searchCriteria:
string
If specified, returns records that match the criteria. Allowed fields are hierUnitId, hierStrucId, operation, subSystem, itemNumber, auditTrailId, fileNum and employeeObjNum.Example:
where equals(hierUnitId, 7)
Response
Supported Media Types
- application/json
200 Response
Success
Root Schema : schema
Type:
Show Source
object-
count:
integer
Number of records returned on this page.Example:
9 -
hasMore:
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items:
array items
Audit Trail records.
-
limit:
integer
The maximum number of records returned on a pageExample:
10 -
offset:
integer
Starting resource record indexExample:
0 -
totalResults:
integer
Total number of records in the data setExample:
100
Nested Schema : items
Type:
arrayAudit Trail records.
Show Source
-
Array of:
object AuditTrail
Audit Trail
Nested Schema : AuditTrail
Type:
objectAudit Trail
Show Source
-
auditTime:
string
Date and time when the operation was performedExample:
2025-04-15T10:40:15 -
auditTrailId:
integer
Unique id of the audit trail recordExample:
3 -
changeSetObjNum:
integer
Effectivity group object number of the record which was modified.Example:
4 -
comments:
string
Comments added to the Audit Trail record. Some applications record comments to help clarify the change or the activity being audited.Example:
Update item name -
defSeqNum:
integer
Definition sequence number of the record which was modified.Example:
1 -
distSourceHierStrucId:
integer
The hierstrucid of the data distribution source.Example:
1 -
distSourceIsRemote:
boolean
A boolean flag indicating if the distribution source used was remote.Example:
false -
employeeFirstName:
string
First name of the employee who performed the operation.Example:
EmpFirstName1 -
employeeLastName:
string
Last name of the employee who performed the operation.Example:
EmpLastName1 -
employeeObjNum:
integer
Object number of the employee who performed the operation.Example:
2 -
field:
string
Name of the field which was modified.Example:
name -
fileNum:
integer
Unique reference of the object where operation was performed. Refer to the List Values section of the C&C API documentation for an explanation of the values.Example:
31 -
hierStrucId:
integer
Hierarchy Structure Id of the hierarchy where the operation was performed.Example:
7 -
hierUnitId:
integer
Hierarchy Unit Id of the hierarchy where the operation was performed.Example:
7 -
itemNumber:
integer
Item number of the record which was modified.Example:
3 -
newValue:
string
The value of a field after it was changed on a changed record.Example:
Cheesy Fries -
objectNumber:
integer
Object number of the record which was modified.Example:
1 -
oldValue:
string
The value of a field before it was changed on a changed record.Example:
Fries -
operation:
integer
A unique reference of the operation performed. Refer to the List Values section of the C&C API documentation for an explanation of the values.Example:
2 -
prSeqNum:
integer
Price sequence number of the record which was modified.Example:
1 -
stringLangId:
integer
Language Id corresponding to the language which was used to modify the text value.Example:
3 -
subRecordField:
string
Name of the field within the sub record which was modified.Example:
consumerDisplayname -
subRecordName:
string
Name of the sub record which was modified.Example:
Condiment Groups -
subRecordObjNum:
integer
Object number of the sub record which was modified.Example:
4 -
subSystem:
integer
A unique reference of the application where the operation was performed. Refer to the List Values section of the C&C API documentation for an explanation of the values.Example:
109 -
userName:
string
User name of the employee who performed the operation.Example:
EmpUserName1