List Linked Deltas

Returns a paginated list of Linked Deltas. Linked deltas represent changes between document versions.

GET /api/linked-deltas

List Linked Deltas

cURL

curl --request GET \
  --url https://platform.kodexa.ai/api/linked-deltas \
  --header 'x-api-key: <api-key>'

200

{
  "content": [
    {
      "actorUri": "<string>",
      "changeSequence": 123,
      "createdOn": "2023-11-07T05:31:56Z",
      "deltaHash": "<string>",
      "errorMessage": "<string>",
      "id": "<string>",
      "retryCount": 123,
      "state": "<string>",
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "<string>",
      "batchId": "<string>"
    }
  ],
  "first": true,
  "last": true,
  "number": 123,
  "numberOfElements": 123,
  "pageable": {
    "offset": 123,
    "pageNumber": 123,
    "pageSize": 123,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 123,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 123,
  "totalPages": 123
}

A linked delta is one saved set of changes queued against a document’s stored contents. Every item in the response reports how far that save got in state, with errorMessage and retryCount carrying the detail.

Delta states

• PENDING — queued, waiting to be applied. A save that hit a transient error returns to PENDING for another attempt, with retryCount incremented and errorMessage holding the last error. A save that a full-document write replaced — one still being applied, or one already applied while that write was in progress — is also requeued, so it re-applies on top of the new contents.
• APPLYING — claimed and being applied to the document.
• APPLIED — every operation in the save landed, and the result was stored.
• APPLIED_PARTIAL — some operations referenced a parent or object the document no longer has, so they could never land. Those operations were dropped, the remaining ones were applied, and the result was stored. errorMessage summarizes what was dropped.
• FAILED — nothing in the save could be applied, or the attempts were exhausted. errorMessage carries the reason, and none of the changes were stored.
• SUPERSEDED — a save that had failed and was then replaced by a full-document write. It records that the earlier failure no longer reflects the stored document.

APPLIED_PARTIAL is a success state — the document was written. Treat it alongside APPLIED when checking whether a save landed, and read errorMessage to see which changes were dropped. Only FAILED means nothing was stored.

To review the saves that landed only in part, filter the list on the state — for example filter=state=='APPLIED_PARTIAL'.

Authorizations

x-api-keybearerAuth

x-api-key · string · header · required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Query Parameters

page · integer<int32>

Page number (1-indexed). Defaults to 1.

pageSize · integer<int32>

Number of items per page (1-1000). Defaults to 20, maximum 1000.

sort · string

Sort expression as field,direction. Direction is asc or desc. Multiple sort fields can be specified by repeating the parameter.

filter · string

RSQL/FIQL filter expression. Supported operators: == (equals), != (not equals), =like= (contains), =in= (in list), > / >= / < / <= (comparison), =isnull=true (is null), =isnull=false (is not null). Combine with ; (AND) or , (OR). Example: name=='Acme Corp';status==active

query · string

Full-text search query matching against the entity's searchable fields.

Response

200

application/json

Page of LinkedDelta

Paginated response containing LinkedDelta items.

content · object[]

Array of LinkedDelta items on this page.

Show child attributes

first · boolean

Whether this is the first page.

last · boolean

Whether this is the last page.

number · integer<int32>

Current page number (0-indexed).

numberOfElements · integer<int32>

Number of items on the current page.

pageable · object

Pagination metadata.

Show child attributes

size · integer<int32>

Page size (number of items per page).

sort · object

Sort metadata.

Show child attributes

totalElements · integer<int64>

Total number of items across all pages.

totalPages · integer<int32>

Total number of pages.