Update Taxonomies

Updates an existing Taxonomies. Data definitions (taxonomies) define document structure and extraction rules.

PUT /api/data-definitions/{id}

Update Taxonomies

cURL

curl --request PUT \
  --url https://platform.kodexa.ai/api/data-definitions/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "changeSequence": 123,
  "deprecated": true,
  "extensionPackRef": "<string>",
  "metadata": {
    "checksum": "<string>",
    "deleteProtection": true,
    "description": "<string>",
    "enabled": true,
    "externalDataTaxonomyRefs": [
      "<string>"
    ],
    "icon": "<string>",
    "imageUrl": "<string>",
    "overviewMarkdown": "<string>",
    "provider": "<string>",
    "providerImageUrl": "<string>",
    "providerUrl": "<string>",
    "taxonomyType": "<string>",
    "taxons": [
      {
        "externalName": "<string>",
        "name": "<string>",
        "additionContexts": [
          {
            "context": "<string>"
          }
        ],
        "children": "<array>",
        "color": "<string>",
        "conditionalFormats": [
          {
            "background": "<string>",
            "color": "<string>",
            "condition": "<string>",
            "formula": "<string>",
            "icon": "<string>",
            "name": "<string>",
            "properties": {},
            "style": "<string>",
            "type": "<string>"
          }
        ],
        "dataPath": "<string>",
        "description": "<string>",
        "enabled": true,
        "eventSubscriptions": [
          {
            "dependsOn": [
              "<string>"
            ],
            "disabled": true,
            "name": "<string>",
            "on": "<string>",
            "script": "<string>"
          }
        ],
        "generateName": true,
        "group": true,
        "id": "<string>",
        "label": "<string>",
        "lexicalRelations": [
          {
            "type": "<string>",
            "value": "<string>",
            "weight": 123
          }
        ],
        "multiValue": true,
        "nodeTypes": [
          "<string>"
        ],
        "notUserLabelled": true,
        "nullValue": "<string>",
        "nullable": true,
        "options": [
          {
            "name": "<string>",
            "type": "<string>",
            "aliases": [
              "<string>"
            ],
            "default": null,
            "description": "<string>",
            "developerOnly": true,
            "displayProperties": {
              "columns": 123,
              "rows": 123,
              "width": 123
            },
            "falseLabel": "<string>",
            "featureFlag": "<string>",
            "groupOptions": "<array>",
            "hint": "<string>",
            "label": "<string>",
            "listDescription": "<string>",
            "listLabel": "<string>",
            "listType": "<string>",
            "overviewMarkdown": "<string>",
            "possibleValues": [
              {
                "description": "<string>",
                "label": "<string>",
                "value": "<string>"
              }
            ],
            "properties": {
              "color": "<string>",
              "icon": "<string>"
            },
            "required": true,
            "showIf": "<string>",
            "showOnPopup": true,
            "subType": "<string>",
            "supportArticle": "<string>",
            "tabName": "<string>"
          }
        ],
        "order": 123,
        "overviewMarkdown": "<string>",
        "path": "<string>",
        "properties": {
          "alignment": "<string>",
          "visible": true,
          "width": 123
        },
        "selectionOptionFormula": "<string>",
        "selectionOptions": [
          {
            "conditionalFormula": "<string>",
            "description": "<string>",
            "disabled": "<string>",
            "hint": "<string>",
            "hintMarkdown": true,
            "id": "<string>",
            "isConditional": true,
            "label": "<string>",
            "lexicalRelations": [
              {
                "type": "<string>",
                "value": "<string>",
                "weight": 123
              }
            ],
            "value": "<string>"
          }
        ],
        "semanticDefinition": "<string>",
        "synonyms": [
          "<string>"
        ],
        "typeFeatures": {
          "allowTemplating": true,
          "cardinality": "<string>",
          "chunkingStrategy": "<string>",
          "classificationContent": "<string>",
          "classificationStrategy": "<string>",
          "contextHeadLines": 123,
          "contextTailLines": 123,
          "currencyCode": "<string>",
          "dateFormat": "<string>",
          "decimalPlaces": 123,
          "embedded": true,
          "enableAiFallback": true,
          "enableLineFallback": true,
          "enablePlanningThinkingMode": true,
          "enableStructureReview": true,
          "enableStructureReviewThinkingMode": true,
          "enableThinkingMode": true,
          "expected": true,
          "extractionModel": "<string>",
          "formulaExpression": "<string>",
          "hierarchyMaxLinesPerCall": 123,
          "hierarchyWindowOverlap": 123,
          "ignoreNonWords": true,
          "imageWidth": 123,
          "includeDataElementsInClassificationPrompt": true,
          "includeExplanation": true,
          "includeImages": true,
          "instanceBoundaryThreshold": 123,
          "labelDocument": true,
          "markdown": true,
          "maxChildLines": 123,
          "maxPagesFromRerank": 123,
          "maxTextRows": 123,
          "merge": true,
          "mergeInstances": true,
          "mergeInstructions": "<string>",
          "mergeWithAI": true,
          "nPages": 123,
          "normalizeDateInExport": true,
          "overrideExtractionModel": true,
          "planningModel": "<string>",
          "promptStrategy": "<string>",
          "raiseExceptionOnAiFallback": true,
          "raiseExceptionOnFallback": true,
          "rerank": true,
          "restrictClassification": true,
          "serializeGroupAsObject": true,
          "skipExtraction": true,
          "stringExtract": "<string>",
          "stringReplace": "<string>",
          "structureReview": "<string>",
          "summarize": true,
          "tagPage": true
        },
        "useSelectionOptionFormula": true,
        "userEditable": true,
        "validationRules": [
          {
            "conditional": true,
            "conditionalFormula": "<string>",
            "description": "<string>",
            "detailFormula": "<string>",
            "disabled": true,
            "exceptionId": "<string>",
            "messageFormula": "<string>",
            "name": "<string>",
            "overridable": true,
            "ruleFormula": "<string>",
            "supportArticleId": "<string>"
          }
        ]
      }
    ]
  },
  "name": "Invoice Taxonomy",
  "orgSlug": "<string>",
  "organization": {
    "id": "<string>"
  },
  "publicAccess": true,
  "ref": "<string>",
  "slug": "invoice-taxonomy",
  "template": true,
  "type": "<string>",
  "uri": "<string>",
  "yamlSource": "<string>"
}
'

200

{
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "deleted": true,
  "deprecated": true,
  "id": "d3456789-01ab-cdef-2345-678901abcdef",
  "metadata": {
    "checksum": "<string>",
    "deleteProtection": true,
    "description": "<string>",
    "enabled": true,
    "externalDataTaxonomyRefs": [
      "<string>"
    ],
    "icon": "<string>",
    "imageUrl": "<string>",
    "overviewMarkdown": "<string>",
    "provider": "<string>",
    "providerImageUrl": "<string>",
    "providerUrl": "<string>",
    "taxonomyType": "<string>",
    "taxons": [
      {
        "externalName": "<string>",
        "name": "<string>",
        "valuePath": "VALUE_OR_ALL_CONTENT",
        "additionContexts": [
          {
            "context": "<string>",
            "type": "RECORD_DEFINITION"
          }
        ],
        "cardinality": "ONCE_PER_DOCUMENT",
        "children": "<array>",
        "color": "<string>",
        "conditionalFormats": [
          {
            "background": "<string>",
            "color": "<string>",
            "condition": "<string>",
            "formula": "<string>",
            "icon": "<string>",
            "name": "<string>",
            "properties": {},
            "style": "<string>",
            "type": "<string>"
          }
        ],
        "dataPath": "<string>",
        "description": "<string>",
        "enabled": true,
        "eventSubscriptions": [
          {
            "dependsOn": [
              "<string>"
            ],
            "disabled": true,
            "name": "<string>",
            "on": "<string>",
            "script": "<string>"
          }
        ],
        "generateName": true,
        "group": true,
        "id": "<string>",
        "label": "<string>",
        "lexicalRelations": [
          {
            "type": "<string>",
            "value": "<string>",
            "weight": 123
          }
        ],
        "metadataValue": "FILENAME",
        "multiValue": true,
        "nodeTypes": [
          "<string>"
        ],
        "notUserLabelled": true,
        "nullValue": "<string>",
        "nullable": true,
        "options": [
          {
            "name": "<string>",
            "type": "<string>",
            "aliases": [
              "<string>"
            ],
            "default": null,
            "description": "<string>",
            "developerOnly": true,
            "displayProperties": {
              "columns": 123,
              "rows": 123,
              "width": 123
            },
            "falseLabel": "<string>",
            "featureFlag": "<string>",
            "groupOptions": "<array>",
            "hint": "<string>",
            "label": "<string>",
            "listDescription": "<string>",
            "listLabel": "<string>",
            "listType": "<string>",
            "overviewMarkdown": "<string>",
            "possibleValues": [
              {
                "description": "<string>",
                "label": "<string>",
                "value": "<string>"
              }
            ],
            "properties": {
              "color": "<string>",
              "icon": "<string>"
            },
            "required": true,
            "showIf": "<string>",
            "showOnPopup": true,
            "subType": "<string>",
            "supportArticle": "<string>",
            "tabName": "<string>"
          }
        ],
        "order": 123,
        "overviewMarkdown": "<string>",
        "path": "<string>",
        "properties": {
          "alignment": "<string>",
          "visible": true,
          "width": 123
        },
        "selectionOptionFormula": "<string>",
        "selectionOptions": [
          {
            "conditionalFormula": "<string>",
            "description": "<string>",
            "disabled": "<string>",
            "hint": "<string>",
            "hintMarkdown": true,
            "id": "<string>",
            "isConditional": true,
            "label": "<string>",
            "lexicalRelations": [
              {
                "type": "<string>",
                "value": "<string>",
                "weight": 123
              }
            ],
            "value": "<string>"
          }
        ],
        "semanticDefinition": "<string>",
        "synonyms": [
          "<string>"
        ],
        "taxonType": "STRING",
        "typeFeatures": {
          "allowTemplating": true,
          "cardinality": "<string>",
          "chunkingStrategy": "<string>",
          "classificationContent": "<string>",
          "classificationStrategy": "<string>",
          "contextHeadLines": 123,
          "contextTailLines": 123,
          "currencyCode": "<string>",
          "dateFormat": "<string>",
          "decimalPlaces": 123,
          "embedded": true,
          "enableAiFallback": true,
          "enableLineFallback": true,
          "enablePlanningThinkingMode": true,
          "enableStructureReview": true,
          "enableStructureReviewThinkingMode": true,
          "enableThinkingMode": true,
          "expected": true,
          "extractionModel": "<string>",
          "formulaExpression": "<string>",
          "hierarchyMaxLinesPerCall": 123,
          "hierarchyWindowOverlap": 123,
          "ignoreNonWords": true,
          "imageWidth": 123,
          "includeDataElementsInClassificationPrompt": true,
          "includeExplanation": true,
          "includeImages": true,
          "instanceBoundaryThreshold": 123,
          "labelDocument": true,
          "markdown": true,
          "maxChildLines": 123,
          "maxPagesFromRerank": 123,
          "maxTextRows": 123,
          "merge": true,
          "mergeInstances": true,
          "mergeInstructions": "<string>",
          "mergeWithAI": true,
          "nPages": 123,
          "normalizeDateInExport": true,
          "overrideExtractionModel": true,
          "planningModel": "<string>",
          "promptStrategy": "<string>",
          "raiseExceptionOnAiFallback": true,
          "raiseExceptionOnFallback": true,
          "rerank": true,
          "restrictClassification": true,
          "serializeGroupAsObject": true,
          "skipExtraction": true,
          "stringExtract": "<string>",
          "stringReplace": "<string>",
          "structureReview": "<string>",
          "summarize": true,
          "tagPage": true
        },
        "useSelectionOptionFormula": true,
        "userEditable": true,
        "validationRules": [
          {
            "conditional": true,
            "conditionalFormula": "<string>",
            "description": "<string>",
            "detailFormula": "<string>",
            "disabled": true,
            "exceptionId": "<string>",
            "messageFormula": "<string>",
            "name": "<string>",
            "overridable": true,
            "ruleFormula": "<string>",
            "supportArticleId": "<string>"
          }
        ]
      }
    ]
  },
  "name": "Invoice Taxonomy",
  "organizationId": "<string>",
  "publicAccess": true,
  "slug": "invoice-taxonomy",
  "template": true,
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>",
  "deleteUserEmail": "<string>",
  "deleteUserId": "<string>",
  "deletedDate": "2023-11-07T05:31:56Z",
  "extensionPackRef": "<string>",
  "orgSlug": "<string>",
  "organization": {
    "id": "<string>"
  },
  "ref": "<string>",
  "type": "<string>",
  "uri": "<string>",
  "yamlSource": "<string>"
}

Authorizations

x-api-keybearerAuth

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

Taxonomy metadata defines document structure and extraction rules (data definitions).

changeSequence · integer<int32>

Optimistic locking version number.

deprecated · boolean

Whether this taxonomy is deprecated.

extensionPackRef · string

metadata · object

Show child attributes

name · string

Display name of the taxonomy.

Example:

"Invoice Taxonomy"

orgSlug · string

organization · object | null

Show child attributes

publicAccess · boolean

Whether the taxonomy is publicly accessible.

ref · string

slug · string

URL-friendly identifier for the taxonomy.

Example:

"invoice-taxonomy"

template · boolean

Whether this taxonomy is a template.

type · string

uri · string

Computed resource URI (scheme://orgSlug/slug), present on serialized responses.

yamlSource · string | null

Response

200

application/json

Updated Taxonomies

Taxonomy metadata defines document structure and extraction rules (data definitions).

changeSequence · integer<int32> · required

Optimistic locking version number.

createdOn · string<date-time> · required

Timestamp when the taxonomy was created.

deleted · boolean · required

deprecated · boolean · required

Whether this taxonomy is deprecated.

id · string · required

Unique identifier (UUID) for the taxonomy.

Example:

"d3456789-01ab-cdef-2345-678901abcdef"

metadata · object · required

Show child attributes

name · string · required

Display name of the taxonomy.

Example:

"Invoice Taxonomy"

organizationId · string · required

publicAccess · boolean · required

Whether the taxonomy is publicly accessible.

slug · string · required

URL-friendly identifier for the taxonomy.

Example:

"invoice-taxonomy"

template · boolean · required

Whether this taxonomy is a template.

updatedOn · string<date-time> · required

Timestamp when the taxonomy was last updated.

uuid · string · required

Secondary UUID identifier.

deleteUserEmail · string | null

deleteUserId · string | null

deletedDate · string<date-time> | null

extensionPackRef · string

orgSlug · string

organization · object | null

Show child attributes

ref · string

type · string

uri · string

Computed resource URI (scheme://orgSlug/slug), present on serialized responses.

yamlSource · string | null