Audit Log
Audit log is a list of changes for an entity or a user. You can view a list of changes in the Change log section and specific REST API requests for objects, links and users.
Audit log model
Internally, each change is represented by the previous value (oldBody
) and a new value (newBody
) of a changed field.
The following table contains a description of all fields of an internal data model.
Field | Type | Description |
---|---|---|
entityId |
String |
The ID of the modified entity. |
entityType |
Integer |
A type of the modified entity. See EntityTypes for a list of entity types. |
kind |
Integer |
A type of the modification. See EntityTypes for a list of entity types. |
newBody |
Object |
New value of the entity’s modified field. |
oldBody |
Object |
Previous value of the entity’s modified field. |
timestamp |
Integer |
A timestamp of the entity modification. |
userId |
String |
The ID of the user who modified an entity. |
Difference between entityType
and kind
The entityType
field refers to the type of entity that’s being modified. The kind
field is a type of field of this entity, that’s being modified. Both of these are EntityTypes.
The examples of audit logs with different entityType
and kind
values:
[
{
"entityType": 1,
"kind": 10,
...
},
...
]
[
{
"entityType": 2,
"kind": 10,
...
},
...
]
[
{
"entityType": 5,
"kind": 13,
...
},
...
]