Entity Change History Resource

Search Entity Change History

HTTP Request

POST /api/entityChangeHistory/search

📋 Description: Submits a request to search the entity change history, allowing users to access detailed records of modifications made to entities within the system.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the results of the entity change history search should be returned in a paginated format to enhance data retrieval efficiency.

body

body

EntityChangeHistoryFilter

true

Request body containing the criteria for searching entity change history, including filters and pagination details to facilitate efficient data retrieval.

Body Parameters

 1{
 2  "entityName": "string",
 3  "entityId": 0,
 4  "linkedEntityName": "string",
 5  "linkedEntityId": 0,
 6  "linkedEntityDisplayId": "string",
 7  "linkedEntityDisplayName": "string",
 8  "changeType": "string",
 9  "fieldName": "string",
10  "entityNameIn": [
11    "string"
12  ],
13  "entityIdIn": [
14    0
15  ]
16}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageEntityChangeHistoryDTO

Example Responses

 1{
 2  "totalPages": 0,
 3  "totalElements": 0,
 4  "pageable": {
 5    "paged": true,
 6    "unpaged": true,
 7    "pageNumber": 0,
 8    "pageSize": 0,
 9    "offset": 0,
10    "sort": {
11      "unsorted": true,
12      "sorted": true,
13      "empty": true
14    }
15  },
16  "numberOfElements": 0,
17  "first": true,
18  "last": true,
19  "size": 0,
20  "content": [
21    {
22      "id": 0,
23      "createdBy": "string",
24      "createdAt": "2019-08-24T14:15:22Z",
25      "entityName": "string",
26      "entityId": 0,
27      "linkedEntityName": "string",
28      "linkedEntityId": 0,
29      "changeType": "string",
30      "fieldName": "string",
31      "oldValue": "string",
32      "newValue": "string",
33      "linkedEntityDisplayId": "string",
34      "linkedEntityDisplayName": "string"
35    }
36  ],
37  "number": 0,
38  "sort": {
39    "unsorted": true,
40    "sorted": true,
41    "empty": true
42  },
43  "empty": true
44}

Get Entity Change History

HTTP Request

GET /api/entityChangeHistory/{entityName}/{entityId}

📋 Description: Retrieves the change history of a specified entity, identified by its name and ID, providing insights into modifications and updates for effective tracking and auditing.

Parameters

Name

In

Type

Required

Description

entityName

path

string

true

Name of the entity

entityId

path

integer(int64)

true

Unique identifier for the entity

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

 1[
 2  {
 3    "id": 0,
 4    "createdBy": "string",
 5    "createdAt": "2019-08-24T14:15:22Z",
 6    "entityName": "string",
 7    "entityId": 0,
 8    "linkedEntityName": "string",
 9    "linkedEntityId": 0,
10    "changeType": "string",
11    "fieldName": "string",
12    "oldValue": "string",
13    "newValue": "string",
14    "linkedEntityDisplayId": "string",
15    "linkedEntityDisplayName": "string"
16  }
17]

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[EntityChangeHistoryDTO]

false

none

[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.]

» 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