Skip to main content
POST
/
api
/
exceptions
Create DataException
curl --request POST \
  --url https://platform.kodexa.ai/api/exceptions \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "changeSequence": 123,
  "closingComment": "<string>",
  "createdOn": "2023-11-07T05:31:56Z",
  "dataAttribute": {
    "booleanValue": true,
    "changeSequence": 123,
    "confidence": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "dataFeatures": {},
    "dataObject": {
      "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>"
    },
    "dateValue": "2023-11-07T05:31:56Z",
    "decimalValue": 123,
    "deleted": true,
    "id": "<string>",
    "ownerUri": "<string>",
    "path": "<string>",
    "stringValue": "<string>",
    "tag": "<string>",
    "tagId": "<string>",
    "truncated": true,
    "typeAtCreation": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>",
    "value": "<string>"
  },
  "dataObject": {
    "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>"
  },
  "exceptionDetails": "<string>",
  "exceptionType": "<string>",
  "id": "<string>",
  "message": "<string>",
  "open": true,
  "path": "<string>",
  "severity": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>"
}
'
{
  "changeSequence": 123,
  "closingComment": "<string>",
  "createdOn": "2023-11-07T05:31:56Z",
  "dataAttribute": {
    "booleanValue": true,
    "changeSequence": 123,
    "confidence": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "dataFeatures": {},
    "dataObject": {
      "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>"
    },
    "dateValue": "2023-11-07T05:31:56Z",
    "decimalValue": 123,
    "deleted": true,
    "id": "<string>",
    "ownerUri": "<string>",
    "path": "<string>",
    "stringValue": "<string>",
    "tag": "<string>",
    "tagId": "<string>",
    "truncated": true,
    "typeAtCreation": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>",
    "value": "<string>"
  },
  "dataObject": {
    "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>"
  },
  "exceptionDetails": "<string>",
  "exceptionType": "<string>",
  "id": "<string>",
  "message": "<string>",
  "open": true,
  "path": "<string>",
  "severity": "<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.

Body

application/json

A data exception records an error that occurred during document data extraction.

​
changeSequence
integer<int32>
​
closingComment
string
​
createdOn
string<date-time>
​
dataAttribute
object
​
dataObject
object
​
exceptionDetails
string
​
exceptionType
string
​
id
string
​
message
string
​
open
boolean
​
path
string
​
severity
string
​
updatedOn
string<date-time>
​
uuid
string

Response

Created DataException

A data exception records an error that occurred during document data extraction.

​
changeSequence
integer<int32>
​
closingComment
string
​
createdOn
string<date-time>
​
dataAttribute
object
​
dataObject
object
​
exceptionDetails
string
​
exceptionType
string
​
id
string
​
message
string
​
open
boolean
​
path
string
​
severity
string
​
updatedOn
string<date-time>
​
uuid
string