EntityChangeHistoryDTO¶
Example Json Object
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "entityName": "string",
6 "entityId": 0,
7 "linkedEntityName": "string",
8 "linkedEntityId": 0,
9 "changeType": "string",
10 "fieldName": "string",
11 "oldValue": "string",
12 "newValue": "string",
13 "linkedEntityDisplayId": "string",
14 "linkedEntityDisplayName": "string"
15}
📄 Description: Data transfer object representing the historical changes made to an entity, capturing essential details such as timestamps and user actions for audit and compliance purposes.
Properties
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
id |
integer(int64) |
false |
none |
Unique identifier for the resource |
createdBy |
string |
false |
none |
Username of who created this resource |
createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
entityName |
string |
true |
none |
Name of the entity |
entityId |
integer(int64) |
true |
none |
Unique identifier for the entity |
linkedEntityName |
string |
true |
none |
Name of the linked entity |
linkedEntityId |
integer(int64) |
true |
none |
Unique identifier for the linked entity |
changeType |
string |
true |
none |
Type of the change |
fieldName |
string |
true |
none |
Name of the field |
oldValue |
string |
false |
none |
Represents the previous value of the entity before the change was made, providing a historical reference for auditing and analysis purposes. |
newValue |
string |
false |
none |
Represents the updated value associated with a specific change in the entity’s history, providing insight into modifications made for effective tracking and auditing. |
linkedEntityDisplayId |
string |
false |
none |
Unique identifier for the linked entity display |
linkedEntityDisplayName |
string |
false |
none |
Name of the linked entity display |