Changelogs v2

Get Entities Changelog

get

Get a log of entities changes for the specified timeframe, ordered chronologically. Option is to get by specified item type and id.

Query parameters
itemIdstring · uuidOptional

Unique item identification number in UUID format, for which changelogs are added

ChangelogItemTypestring · enumOptional

optional filtering by changelog item type

Possible values:
limitinteger · min: 1Required

Maximum number of items to return

Default: 20
cursorstringOptional

String value used for pagination

orderDirectionstring · enumOptional

order direction

Default: ASCPossible values:
startDatestring · date-timeOptional

The left boundary of [startDateTime - endDateTime] changelog entries date-time range

Example: 2019-04-12T23:20:50.52Z
endDatestring · date-timeOptional

The right boundary of [startDateTime - endDateTime] changelog entries date-time range

Example: 2019-05-12T23:20:50.52Z
Responses
200

OK

application/json
get
GET /entities-changelog HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Accept: */*

{
  "data": [
    {
      "itemType": "NATURAL_PERSON",
      "entryId": "123e4567-e89b-12d3-a456-426614174000",
      "itemId": "123e4567-e89b-12d3-a456-426614174000",
      "createdOn": "2025-09-14T05:06:08.345Z",
      "changes": [
        {
          "type": "REPLACE",
          "path": "/legalEntity/contact/email",
          "oldValue": "[email protected]",
          "value": "[email protected]"
        }
      ],
      "source": "PARTNER_SYSTEM"
    }
  ],
  "pagination": {
    "cursor": "text",
    "limit": 1
  }
}

Get Roles Changelog

get

Get a log of roles changes for the specified timeframe, ordered chronologically. Option is to get by specified item type and id.

Query parameters
itemIdstring · uuidOptional

Unique item identification number in UUID format, for which changelogs are added

ChangelogItemTypestring · enumOptional

optional filtering by changelog item type

Possible values:
limitinteger · min: 1Required

Maximum number of items to return

Default: 20
cursorstringOptional

String value used for pagination

orderDirectionstring · enumOptional

order direction

Default: ASCPossible values:
startDatestring · date-timeOptional

The left boundary of [startDateTime - endDateTime] changelog entries date-time range

Example: 2019-04-12T23:20:50.52Z
endDatestring · date-timeOptional

The right boundary of [startDateTime - endDateTime] changelog entries date-time range

Example: 2019-05-12T23:20:50.52Z
Responses
200

OK

application/json
get
GET /roles-changelog HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Accept: */*

{
  "data": [
    {
      "itemType": "CUSTOMER",
      "entryId": "123e4567-e89b-12d3-a456-426614174000",
      "itemId": "123e4567-e89b-12d3-a456-426614174000",
      "createdOn": "2025-09-14T05:06:08.345Z",
      "changes": [
        {
          "type": "REPLACE",
          "path": "/legalEntity/contact/email",
          "oldValue": "[email protected]",
          "value": "[email protected]"
        }
      ],
      "source": "PARTNER_SYSTEM"
    }
  ],
  "pagination": {
    "cursor": "text",
    "limit": 1
  }
}

Get Digital Assets Changelog

get

Get a log of digital assets changes for the specified timeframe, ordered chronologically. Option is to get by specified item type and id.

Query parameters
itemIdstring · uuidOptional

Unique item identification number in UUID format, for which changelogs are added

ChangelogItemTypestring · enumOptional

optional filtering by changelog item type

Possible values:
limitinteger · min: 1Required

Maximum number of items to return

Default: 20
cursorstringOptional

String value used for pagination

orderDirectionstring · enumOptional

order direction

Default: ASCPossible values:
startDatestring · date-timeOptional

The left boundary of [startDateTime - endDateTime] changelog entries date-time range

Example: 2019-04-12T23:20:50.52Z
endDatestring · date-timeOptional

The right boundary of [startDateTime - endDateTime] changelog entries date-time range

Example: 2019-05-12T23:20:50.52Z
Responses
200

OK

application/json
get
GET /digital-changelog HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Accept: */*

{
  "data": [
    {
      "itemType": "ORDER",
      "entryId": "123e4567-e89b-12d3-a456-426614174000",
      "itemId": "123e4567-e89b-12d3-a456-426614174000",
      "createdOn": "2025-09-14T05:06:08.345Z",
      "changes": [
        {
          "type": "REPLACE",
          "path": "/legalEntity/contact/email",
          "oldValue": "[email protected]",
          "value": "[email protected]"
        }
      ],
      "source": "PARTNER_SYSTEM"
    }
  ],
  "pagination": {
    "cursor": "text",
    "limit": 1
  }
}

Get Products Changelog

get

Get a log of products changes for the specified timeframe, ordered chronologically. Option is to get by specified item type and id.

Query parameters
itemIdstring · uuidOptional

Unique item identification number in UUID format, for which changelogs are added

ChangelogItemTypestring · enumOptional

optional filtering by changelog item type

Possible values:
limitinteger · min: 1Required

Maximum number of items to return

Default: 20
cursorstringOptional

String value used for pagination

orderDirectionstring · enumOptional

order direction

Default: ASCPossible values:
startDatestring · date-timeOptional

The left boundary of [startDateTime - endDateTime] changelog entries date-time range

Example: 2019-04-12T23:20:50.52Z
endDatestring · date-timeOptional

The right boundary of [startDateTime - endDateTime] changelog entries date-time range

Example: 2019-05-12T23:20:50.52Z
Responses
200

OK

application/json
get
GET /products-changelog HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Accept: */*

{
  "data": [
    {
      "itemType": "CUSTOMER_PRODUCT",
      "entryId": "123e4567-e89b-12d3-a456-426614174000",
      "itemId": "123e4567-e89b-12d3-a456-426614174000",
      "createdOn": "2025-09-14T05:06:08.345Z",
      "changes": [
        {
          "type": "REPLACE",
          "path": "/legalEntity/contact/email",
          "oldValue": "[email protected]",
          "value": "[email protected]"
        }
      ],
      "source": "PARTNER_SYSTEM"
    }
  ],
  "pagination": {
    "cursor": "text",
    "limit": 1
  }
}

Get Documents Changelog

get

Get a log of documents changes for the specified timeframe, ordered chronologically. Option is to get by specified item type and id.

Query parameters
itemIdstring · uuidOptional

Unique item identification number in UUID format, for which changelogs are added

ChangelogItemTypestring · enumOptional

optional filtering by changelog item type

Possible values:
limitinteger · min: 1Required

Maximum number of items to return

Default: 20
cursorstringOptional

String value used for pagination

orderDirectionstring · enumOptional

order direction

Default: ASCPossible values:
startDatestring · date-timeOptional

The left boundary of [startDateTime - endDateTime] changelog entries date-time range

Example: 2019-04-12T23:20:50.52Z
endDatestring · date-timeOptional

The right boundary of [startDateTime - endDateTime] changelog entries date-time range

Example: 2019-05-12T23:20:50.52Z
Responses
200

OK

application/json
get
GET /documents-changelog HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Accept: */*

{
  "data": [
    {
      "itemType": "CUSTOMER_DOCUMENT",
      "entryId": "123e4567-e89b-12d3-a456-426614174000",
      "itemId": "123e4567-e89b-12d3-a456-426614174000",
      "createdOn": "2025-09-14T05:06:08.345Z",
      "changes": [
        {
          "type": "REPLACE",
          "path": "/legalEntity/contact/email",
          "oldValue": "[email protected]",
          "value": "[email protected]"
        }
      ],
      "source": "PARTNER_SYSTEM"
    }
  ],
  "pagination": {
    "cursor": "text",
    "limit": 1
  }
}

Last updated