Skip to main content
PUT
/
api
/
document-external-data
/
{id}
Update DocumentExternalData
curl --request PUT \
  --url https://platform.kodexa.ai/api/document-external-data/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "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>"
}
'
{
  "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>"
}

Authorizations

​
x-api-key
string
header
required

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

Path Parameters

​
id
string<uuid>
required

Unique identifier (UUID) of the resource.

Body

application/json

Document external data represents external references attached to a document family.

​
changeSequence
integer<int32>
​
createdOn
string<date-time>
​
documentFamily
object
​
externalData
object
​
id
string
​
key
string
​
updatedOn
string<date-time>
​
uuid
string

Response

Updated DocumentExternalData

Document external data represents external references attached to a document family.

​
changeSequence
integer<int32>
​
createdOn
string<date-time>
​
documentFamily
object
​
externalData
object
​
id
string
​
key
string
​
updatedOn
string<date-time>
​
uuid
string