curl --request GET \
--url https://platform.kodexa.ai/api/document-external-data \
--header 'x-api-key: <api-key>'{
"content": [
{
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"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>"
},
"externalData": {},
"id": "<string>",
"key": "<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
}Returns a paginated list of Document External Data. Document external data stores external references attached to document families.
curl --request GET \
--url https://platform.kodexa.ai/api/document-external-data \
--header 'x-api-key: <api-key>'{
"content": [
{
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"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>"
},
"externalData": {},
"id": "<string>",
"key": "<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
}API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.
Page number (1-indexed). Defaults to 1.
Number of items per page (1-1000). Defaults to 20, maximum 1000.
Sort expression as field,direction. Direction is asc or desc. Multiple sort fields can be specified by repeating the parameter.
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
Full-text search query matching against the entity's searchable fields.
Page of DocumentExternalData
Paginated response containing DocumentExternalData items.
Array of DocumentExternalData items on this page.
Show child attributes
Whether this is the first page.
Whether this is the last page.
Current page number (0-indexed).
Number of items on the current page.
Pagination metadata.
Show child attributes
Page size (number of items per page).
Sort metadata.
Show child attributes
Total number of items across all pages.
Total number of pages.