Skip to main content
POST
/
api
/
data-attributes
Create DataAttribute
curl --request POST \
  --url https://platform.kodexa.ai/api/data-attributes \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "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>"
}
'
{
  "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>"
}

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 attribute represents an extracted data field from a document.

​
booleanValue
boolean | null
​
changeSequence
integer<int32>
​
confidence
number<float> | null
​
createdOn
string<date-time>
​
dataFeatures
object
​
dataObject
object
​
dateValue
string<date-time> | null
​
decimalValue
number<double> | null
​
deleted
boolean
​
id
string
​
ownerUri
string
​
path
string
​
stringValue
string
​
tag
string
​
tagId
string
​
truncated
boolean
​
typeAtCreation
string
​
updatedOn
string<date-time>
​
uuid
string
​
value
string

Response

Created DataAttribute

A data attribute represents an extracted data field from a document.

​
booleanValue
boolean | null
​
changeSequence
integer<int32>
​
confidence
number<float> | null
​
createdOn
string<date-time>
​
dataFeatures
object
​
dataObject
object
​
dateValue
string<date-time> | null
​
decimalValue
number<double> | null
​
deleted
boolean
​
id
string
​
ownerUri
string
​
path
string
​
stringValue
string
​
tag
string
​
tagId
string
​
truncated
boolean
​
typeAtCreation
string
​
updatedOn
string<date-time>
​
uuid
string
​
value
string