Skip to main content
POST
/
api
/
data-definitions
Create Taxonomies
curl --request POST \
  --url https://platform.kodexa.ai/api/data-definitions \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "deprecated": true,
  "extensionPackRef": "<string>",
  "id": "d3456789-01ab-cdef-2345-678901abcdef",
  "metadata": {
    "taxons": [
      {
        "additionContexts": [
          "<string>"
        ],
        "cardinality": "<string>",
        "children": "<array>",
        "color": "<string>",
        "conditionalFormats": [
          {
            "background": "<string>",
            "color": "<string>",
            "formula": "<string>",
            "icon": "<string>",
            "name": "<string>",
            "style": "<string>"
          }
        ],
        "dataPath": "<string>",
        "denormalizeToChildren": true,
        "description": "<string>",
        "enableFallbackExpression": true,
        "enableSerializationExpression": true,
        "enabled": true,
        "expression": "<string>",
        "externalName": "<string>",
        "fallbackExpression": "<string>",
        "generateName": true,
        "group": true,
        "guideProperties": {
          "overviewMarkdown": "<string>"
        },
        "id": "<string>",
        "label": "<string>",
        "lexicalRelations": [
          {
            "type": "<string>",
            "value": "<string>"
          }
        ],
        "metadataValue": "<string>",
        "multiValue": true,
        "name": "<string>",
        "naturalKeys": [
          {
            "name": "<string>"
          }
        ],
        "nodeTypes": [
          "<string>"
        ],
        "notUserLabelled": true,
        "nullValue": "<string>",
        "nullable": true,
        "options": [
          {
            "aliases": [
              "<string>"
            ],
            "default": {},
            "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>",
            "name": "<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>",
            "type": "<string>"
          }
        ],
        "order": 123,
        "overviewMarkdown": "<string>",
        "path": "<string>",
        "postExpression": "<string>",
        "properties": {
          "alignment": "<string>",
          "visible": true,
          "width": 123
        },
        "selectWeight": 123,
        "selectionOptions": [
          {
            "conditionalFormula": "<string>",
            "description": "<string>",
            "disabled": "<string>",
            "id": "<string>",
            "isConditional": true,
            "label": "<string>",
            "lexicalRelations": [
              {
                "type": "<string>",
                "value": "<string>"
              }
            ]
          }
        ],
        "semanticDefinition": "<string>",
        "serializationExpression": "<string>",
        "synonyms": [
          "<string>"
        ],
        "taxonType": "<string>",
        "typeFeatures": {
          "currencyCode": "<string>",
          "dateFormat": "<string>",
          "decimalPlaces": 123,
          "formulaExpression": "<string>"
        },
        "usePostExpression": 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>"
          }
        ],
        "valuePath": "<string>"
      }
    ]
  },
  "name": "Invoice Taxonomy",
  "publicAccess": true,
  "slug": "invoice-taxonomy",
  "template": true,
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>",
  "version": "1.0.0"
}
'
{
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "deprecated": true,
  "extensionPackRef": "<string>",
  "id": "d3456789-01ab-cdef-2345-678901abcdef",
  "metadata": {
    "taxons": [
      {
        "additionContexts": [
          "<string>"
        ],
        "cardinality": "<string>",
        "children": "<array>",
        "color": "<string>",
        "conditionalFormats": [
          {
            "background": "<string>",
            "color": "<string>",
            "formula": "<string>",
            "icon": "<string>",
            "name": "<string>",
            "style": "<string>"
          }
        ],
        "dataPath": "<string>",
        "denormalizeToChildren": true,
        "description": "<string>",
        "enableFallbackExpression": true,
        "enableSerializationExpression": true,
        "enabled": true,
        "expression": "<string>",
        "externalName": "<string>",
        "fallbackExpression": "<string>",
        "generateName": true,
        "group": true,
        "guideProperties": {
          "overviewMarkdown": "<string>"
        },
        "id": "<string>",
        "label": "<string>",
        "lexicalRelations": [
          {
            "type": "<string>",
            "value": "<string>"
          }
        ],
        "metadataValue": "<string>",
        "multiValue": true,
        "name": "<string>",
        "naturalKeys": [
          {
            "name": "<string>"
          }
        ],
        "nodeTypes": [
          "<string>"
        ],
        "notUserLabelled": true,
        "nullValue": "<string>",
        "nullable": true,
        "options": [
          {
            "aliases": [
              "<string>"
            ],
            "default": {},
            "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>",
            "name": "<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>",
            "type": "<string>"
          }
        ],
        "order": 123,
        "overviewMarkdown": "<string>",
        "path": "<string>",
        "postExpression": "<string>",
        "properties": {
          "alignment": "<string>",
          "visible": true,
          "width": 123
        },
        "selectWeight": 123,
        "selectionOptions": [
          {
            "conditionalFormula": "<string>",
            "description": "<string>",
            "disabled": "<string>",
            "id": "<string>",
            "isConditional": true,
            "label": "<string>",
            "lexicalRelations": [
              {
                "type": "<string>",
                "value": "<string>"
              }
            ]
          }
        ],
        "semanticDefinition": "<string>",
        "serializationExpression": "<string>",
        "synonyms": [
          "<string>"
        ],
        "taxonType": "<string>",
        "typeFeatures": {
          "currencyCode": "<string>",
          "dateFormat": "<string>",
          "decimalPlaces": 123,
          "formulaExpression": "<string>"
        },
        "usePostExpression": 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>"
          }
        ],
        "valuePath": "<string>"
      }
    ]
  },
  "name": "Invoice Taxonomy",
  "publicAccess": true,
  "slug": "invoice-taxonomy",
  "template": true,
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>",
  "version": "1.0.0"
}

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

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

​
changeSequence
integer<int32>

Optimistic locking version number.

​
createdOn
string<date-time>

Timestamp when the taxonomy was created.

​
deprecated
boolean

Whether this taxonomy is deprecated.

​
extensionPackRef
string

Reference to the extension pack.

​
id
string

Unique identifier (UUID) for the taxonomy.

Example:

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

​
metadata
object
​
name
string

Display name of the taxonomy.

Example:

"Invoice Taxonomy"

​
publicAccess
boolean

Whether the taxonomy is publicly accessible.

​
slug
string

URL-friendly identifier for the taxonomy.

Example:

"invoice-taxonomy"

​
template
boolean

Whether this taxonomy is a template.

​
updatedOn
string<date-time>

Timestamp when the taxonomy was last updated.

​
uuid
string

Secondary UUID identifier.

​
version
string

Semantic version string.

Example:

"1.0.0"

Response

Created Taxonomies

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

​
changeSequence
integer<int32>

Optimistic locking version number.

​
createdOn
string<date-time>

Timestamp when the taxonomy was created.

​
deprecated
boolean

Whether this taxonomy is deprecated.

​
extensionPackRef
string

Reference to the extension pack.

​
id
string

Unique identifier (UUID) for the taxonomy.

Example:

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

​
metadata
object
​
name
string

Display name of the taxonomy.

Example:

"Invoice Taxonomy"

​
publicAccess
boolean

Whether the taxonomy is publicly accessible.

​
slug
string

URL-friendly identifier for the taxonomy.

Example:

"invoice-taxonomy"

​
template
boolean

Whether this taxonomy is a template.

​
updatedOn
string<date-time>

Timestamp when the taxonomy was last updated.

​
uuid
string

Secondary UUID identifier.

​
version
string

Semantic version string.

Example:

"1.0.0"