Skip to main content
GET
/
api
/
data-objects
List DataObjects
curl --request GET \
  --url https://platform.kodexa.ai/api/data-objects \
  --header 'x-api-key: <api-key>'
{
  "content": [
    {
      "cellIndex": 123,
      "changeSequence": 123,
      "createdOn": "2023-11-07T05:31:56Z",
      "dateTime": "2023-11-07T05:31:56Z",
      "deleted": true,
      "documentFamily": {
        "activeAssistant": "aSDinaTvuI8gbWludGxpZnk=",
        "changeSequence": 123,
        "created": "2023-11-07T05:31:56Z",
        "createdOn": "2023-11-07T05:31:56Z",
        "deleteUserEmail": "<string>",
        "deleted": true,
        "deletedDate": "2023-11-07T05:31:56Z",
        "documentStatus": "<string>",
        "documentTaxonValidations": [
          {
            "taxonPath": "<string>",
            "taxonomyRef": "<string>",
            "validation": {
              "conditional": true,
              "conditionalFormula": "<string>",
              "description": "<string>",
              "detailFormula": "<string>",
              "disabled": true,
              "exceptionId": "<string>",
              "messageFormula": "<string>",
              "name": "<string>",
              "overridable": true,
              "ruleFormula": "<string>",
              "supportArticleId": "<string>"
            }
          }
        ],
        "executionTargets": {
          "instances": [
            {
              "actor": {
                "actorId": "<string>",
                "actorType": "<string>"
              },
              "contentObjectId": "<string>",
              "documentFamilyId": "<string>",
              "labelsToApply": [
                "<string>"
              ],
              "ref": "<string>",
              "taxonomyRefs": [
                "<string>"
              ],
              "type": "<string>"
            }
          ]
        },
        "id": "<string>",
        "labelStatistics": {
          "averageLabelConfidence": {},
          "labelCounts": {},
          "maxLabelConfidence": {},
          "minLabelConfidence": {}
        },
        "locked": true,
        "metadata": {},
        "metadataSource": {},
        "modified": "2023-11-07T05:31:56Z",
        "numberOfContentExceptions": 123,
        "numberOfInsights": 123,
        "numberOfNotes": 123,
        "originalPath": "<string>",
        "path": "<string>",
        "pendingProcessing": true,
        "size": 123,
        "storeRef": "<string>",
        "summary": "<string>",
        "updatedOn": "2023-11-07T05:31:56Z",
        "uuid": "<string>"
      },
      "documentFamilyId": "<string>",
      "groupUuid": "<string>",
      "id": "<string>",
      "lineage": {
        "attributeValidations": {},
        "contentObjectId": "<string>",
        "documentFamilyId": "<string>",
        "executionId": "<string>",
        "storeRef": "<string>",
        "validations": [
          {
            "conditional": true,
            "conditionalFormula": "<string>",
            "description": "<string>",
            "detailFormula": "<string>",
            "disabled": true,
            "exceptionId": "<string>",
            "messageFormula": "<string>",
            "name": "<string>",
            "overridable": true,
            "ruleFormula": "<string>",
            "supportArticleId": "<string>"
          }
        ]
      },
      "path": "<string>",
      "sourceOrdering": "<string>",
      "storeRef": "<string>",
      "taxonomyRef": "<string>",
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "<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
}

Authorizations

​
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

Page of DataObject

Paginated response containing DataObject items.

​
content
object[]

Array of DataObject items on this page.

​
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.

​
size
integer<int32>

Page size (number of items per page).

​
sort
object

Sort metadata.

​
totalElements
integer<int64>

Total number of items across all pages.

​
totalPages
integer<int32>

Total number of pages.