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",
  "deleteUserEmail": "<string>",
  "deleteUserId": "<string>",
  "deleted": true,
  "deletedDate": "2023-11-07T05:31:56Z",
  "deprecated": true,
  "extensionPackRef": "<string>",
  "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": [
      {
        "additionContexts": [
          "<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>"
          }
        ],
        "externalName": "<string>",
        "generateName": true,
        "group": true,
        "id": "<string>",
        "label": "<string>",
        "lexicalRelations": [
          {
            "type": "<string>",
            "value": "<string>",
            "weight": 123
          }
        ],
        "multiValue": true,
        "name": "<string>",
        "nodeTypes": [
          "<string>"
        ],
        "notUserLabelled": true,
        "nullValue": "<string>",
        "nullable": true,
        "options": [
          {
            "aliases": [
              "<string>"
            ],
            "default": "<unknown>",
            "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>",
        "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,
          "merge": true,
          "mergeInstances": true,
          "mergeInstructions": "<string>",
          "mergeWithAI": true,
          "nPages": 123,
          "overrideExtractionModel": true,
          "planningModel": "<string>",
          "promptStrategy": "<string>",
          "raiseExceptionOnAiFallback": true,
          "raiseExceptionOnFallback": true,
          "rerank": true,
          "restrictClassification": true,
          "skipExtraction": true,
          "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,
  "type": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>",
  "yamlSource": "<string>"
}
'
import requests

url = "https://platform.kodexa.ai/api/data-definitions"

payload = {
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"deleteUserEmail": "<string>",
"deleteUserId": "<string>",
"deleted": True,
"deletedDate": "2023-11-07T05:31:56Z",
"deprecated": True,
"extensionPackRef": "<string>",
"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": [
{
"additionContexts": ["<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>"
}
],
"externalName": "<string>",
"generateName": True,
"group": True,
"id": "<string>",
"label": "<string>",
"lexicalRelations": [
{
"type": "<string>",
"value": "<string>",
"weight": 123
}
],
"multiValue": True,
"name": "<string>",
"nodeTypes": ["<string>"],
"notUserLabelled": True,
"nullValue": "<string>",
"nullable": True,
"options": [
{
"aliases": ["<string>"],
"default": "<unknown>",
"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>",
"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,
"merge": True,
"mergeInstances": True,
"mergeInstructions": "<string>",
"mergeWithAI": True,
"nPages": 123,
"overrideExtractionModel": True,
"planningModel": "<string>",
"promptStrategy": "<string>",
"raiseExceptionOnAiFallback": True,
"raiseExceptionOnFallback": True,
"rerank": True,
"restrictClassification": True,
"skipExtraction": True,
"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,
"type": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>",
"yamlSource": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
changeSequence: 123,
createdOn: '2023-11-07T05:31:56Z',
deleteUserEmail: '<string>',
deleteUserId: '<string>',
deleted: true,
deletedDate: '2023-11-07T05:31:56Z',
deprecated: true,
extensionPackRef: '<string>',
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: [
{
additionContexts: ['<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>'
}
],
externalName: '<string>',
generateName: true,
group: true,
id: '<string>',
label: '<string>',
lexicalRelations: [{type: '<string>', value: '<string>', weight: 123}],
multiValue: true,
name: '<string>',
nodeTypes: ['<string>'],
notUserLabelled: true,
nullValue: '<string>',
nullable: true,
options: [
{
aliases: ['<string>'],
default: '<unknown>',
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>',
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,
merge: true,
mergeInstances: true,
mergeInstructions: '<string>',
mergeWithAI: true,
nPages: 123,
overrideExtractionModel: true,
planningModel: '<string>',
promptStrategy: '<string>',
raiseExceptionOnAiFallback: true,
raiseExceptionOnFallback: true,
rerank: true,
restrictClassification: true,
skipExtraction: true,
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,
type: '<string>',
updatedOn: '2023-11-07T05:31:56Z',
uuid: '<string>',
yamlSource: '<string>'
})
};

fetch('https://platform.kodexa.ai/api/data-definitions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://platform.kodexa.ai/api/data-definitions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'changeSequence' => 123,
'createdOn' => '2023-11-07T05:31:56Z',
'deleteUserEmail' => '<string>',
'deleteUserId' => '<string>',
'deleted' => true,
'deletedDate' => '2023-11-07T05:31:56Z',
'deprecated' => true,
'extensionPackRef' => '<string>',
'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' => [
[
'additionContexts' => [
'<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>'
]
],
'externalName' => '<string>',
'generateName' => true,
'group' => true,
'id' => '<string>',
'label' => '<string>',
'lexicalRelations' => [
[
'type' => '<string>',
'value' => '<string>',
'weight' => 123
]
],
'multiValue' => true,
'name' => '<string>',
'nodeTypes' => [
'<string>'
],
'notUserLabelled' => true,
'nullValue' => '<string>',
'nullable' => true,
'options' => [
[
'aliases' => [
'<string>'
],
'default' => '<unknown>',
'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>',
'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,
'merge' => true,
'mergeInstances' => true,
'mergeInstructions' => '<string>',
'mergeWithAI' => true,
'nPages' => 123,
'overrideExtractionModel' => true,
'planningModel' => '<string>',
'promptStrategy' => '<string>',
'raiseExceptionOnAiFallback' => true,
'raiseExceptionOnFallback' => true,
'rerank' => true,
'restrictClassification' => true,
'skipExtraction' => true,
'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,
'type' => '<string>',
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '<string>',
'yamlSource' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://platform.kodexa.ai/api/data-definitions"

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

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://platform.kodexa.ai/api/data-definitions")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"deleteUserEmail\": \"<string>\",\n \"deleteUserId\": \"<string>\",\n \"deleted\": true,\n \"deletedDate\": \"2023-11-07T05:31:56Z\",\n \"deprecated\": true,\n \"extensionPackRef\": \"<string>\",\n \"id\": \"d3456789-01ab-cdef-2345-678901abcdef\",\n \"metadata\": {\n \"checksum\": \"<string>\",\n \"deleteProtection\": true,\n \"description\": \"<string>\",\n \"enabled\": true,\n \"externalDataTaxonomyRefs\": [\n \"<string>\"\n ],\n \"icon\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"overviewMarkdown\": \"<string>\",\n \"provider\": \"<string>\",\n \"providerImageUrl\": \"<string>\",\n \"providerUrl\": \"<string>\",\n \"taxonomyType\": \"<string>\",\n \"taxons\": [\n {\n \"additionContexts\": [\n \"<string>\"\n ],\n \"children\": \"<array>\",\n \"color\": \"<string>\",\n \"conditionalFormats\": [\n {\n \"background\": \"<string>\",\n \"color\": \"<string>\",\n \"condition\": \"<string>\",\n \"formula\": \"<string>\",\n \"icon\": \"<string>\",\n \"name\": \"<string>\",\n \"properties\": {},\n \"style\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"dataPath\": \"<string>\",\n \"description\": \"<string>\",\n \"enabled\": true,\n \"eventSubscriptions\": [\n {\n \"dependsOn\": [\n \"<string>\"\n ],\n \"disabled\": true,\n \"name\": \"<string>\",\n \"on\": \"<string>\",\n \"script\": \"<string>\"\n }\n ],\n \"externalName\": \"<string>\",\n \"generateName\": true,\n \"group\": true,\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"lexicalRelations\": [\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\",\n \"weight\": 123\n }\n ],\n \"multiValue\": true,\n \"name\": \"<string>\",\n \"nodeTypes\": [\n \"<string>\"\n ],\n \"notUserLabelled\": true,\n \"nullValue\": \"<string>\",\n \"nullable\": true,\n \"options\": [\n {\n \"aliases\": [\n \"<string>\"\n ],\n \"default\": \"<unknown>\",\n \"description\": \"<string>\",\n \"developerOnly\": true,\n \"displayProperties\": {\n \"columns\": 123,\n \"rows\": 123,\n \"width\": 123\n },\n \"falseLabel\": \"<string>\",\n \"featureFlag\": \"<string>\",\n \"groupOptions\": \"<array>\",\n \"hint\": \"<string>\",\n \"label\": \"<string>\",\n \"listDescription\": \"<string>\",\n \"listLabel\": \"<string>\",\n \"listType\": \"<string>\",\n \"name\": \"<string>\",\n \"overviewMarkdown\": \"<string>\",\n \"possibleValues\": [\n {\n \"description\": \"<string>\",\n \"label\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"properties\": {\n \"color\": \"<string>\",\n \"icon\": \"<string>\"\n },\n \"required\": true,\n \"showIf\": \"<string>\",\n \"showOnPopup\": true,\n \"subType\": \"<string>\",\n \"supportArticle\": \"<string>\",\n \"tabName\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"order\": 123,\n \"overviewMarkdown\": \"<string>\",\n \"path\": \"<string>\",\n \"properties\": {\n \"alignment\": \"<string>\",\n \"visible\": true,\n \"width\": 123\n },\n \"selectionOptionFormula\": \"<string>\",\n \"selectionOptions\": [\n {\n \"conditionalFormula\": \"<string>\",\n \"description\": \"<string>\",\n \"disabled\": \"<string>\",\n \"hint\": \"<string>\",\n \"hintMarkdown\": true,\n \"id\": \"<string>\",\n \"isConditional\": true,\n \"label\": \"<string>\",\n \"lexicalRelations\": [\n {\n \"type\": \"<string>\",\n \"value\": \"<string>\",\n \"weight\": 123\n }\n ],\n \"value\": \"<string>\"\n }\n ],\n \"semanticDefinition\": \"<string>\",\n \"synonyms\": [\n \"<string>\"\n ],\n \"typeFeatures\": {\n \"allowTemplating\": true,\n \"cardinality\": \"<string>\",\n \"chunkingStrategy\": \"<string>\",\n \"classificationContent\": \"<string>\",\n \"classificationStrategy\": \"<string>\",\n \"contextHeadLines\": 123,\n \"contextTailLines\": 123,\n \"currencyCode\": \"<string>\",\n \"dateFormat\": \"<string>\",\n \"decimalPlaces\": 123,\n \"embedded\": true,\n \"enableAiFallback\": true,\n \"enableLineFallback\": true,\n \"enablePlanningThinkingMode\": true,\n \"enableStructureReview\": true,\n \"enableStructureReviewThinkingMode\": true,\n \"enableThinkingMode\": true,\n \"expected\": true,\n \"extractionModel\": \"<string>\",\n \"formulaExpression\": \"<string>\",\n \"hierarchyMaxLinesPerCall\": 123,\n \"hierarchyWindowOverlap\": 123,\n \"ignoreNonWords\": true,\n \"imageWidth\": 123,\n \"includeDataElementsInClassificationPrompt\": true,\n \"includeExplanation\": true,\n \"includeImages\": true,\n \"instanceBoundaryThreshold\": 123,\n \"labelDocument\": true,\n \"markdown\": true,\n \"maxChildLines\": 123,\n \"maxPagesFromRerank\": 123,\n \"merge\": true,\n \"mergeInstances\": true,\n \"mergeInstructions\": \"<string>\",\n \"mergeWithAI\": true,\n \"nPages\": 123,\n \"overrideExtractionModel\": true,\n \"planningModel\": \"<string>\",\n \"promptStrategy\": \"<string>\",\n \"raiseExceptionOnAiFallback\": true,\n \"raiseExceptionOnFallback\": true,\n \"rerank\": true,\n \"restrictClassification\": true,\n \"skipExtraction\": true,\n \"structureReview\": \"<string>\",\n \"summarize\": true,\n \"tagPage\": true\n },\n \"useSelectionOptionFormula\": true,\n \"userEditable\": true,\n \"validationRules\": [\n {\n \"conditional\": true,\n \"conditionalFormula\": \"<string>\",\n \"description\": \"<string>\",\n \"detailFormula\": \"<string>\",\n \"disabled\": true,\n \"exceptionId\": \"<string>\",\n \"messageFormula\": \"<string>\",\n \"name\": \"<string>\",\n \"overridable\": true,\n \"ruleFormula\": \"<string>\",\n \"supportArticleId\": \"<string>\"\n }\n ]\n }\n ]\n },\n \"name\": \"Invoice Taxonomy\",\n \"organizationId\": \"<string>\",\n \"publicAccess\": true,\n \"slug\": \"invoice-taxonomy\",\n \"template\": true,\n \"type\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\",\n \"yamlSource\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://platform.kodexa.ai/api/data-definitions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

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

response = http.request(request)
puts response.read_body
{
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "deleteUserEmail": "<string>",
  "deleteUserId": "<string>",
  "deleted": true,
  "deletedDate": "2023-11-07T05:31:56Z",
  "deprecated": true,
  "extensionPackRef": "<string>",
  "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": [
      {
        "additionContexts": [
          "<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>"
          }
        ],
        "externalName": "<string>",
        "generateName": true,
        "group": true,
        "id": "<string>",
        "label": "<string>",
        "lexicalRelations": [
          {
            "type": "<string>",
            "value": "<string>",
            "weight": 123
          }
        ],
        "multiValue": true,
        "name": "<string>",
        "nodeTypes": [
          "<string>"
        ],
        "notUserLabelled": true,
        "nullValue": "<string>",
        "nullable": true,
        "options": [
          {
            "aliases": [
              "<string>"
            ],
            "default": "<unknown>",
            "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>",
        "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,
          "merge": true,
          "mergeInstances": true,
          "mergeInstructions": "<string>",
          "mergeWithAI": true,
          "nPages": 123,
          "overrideExtractionModel": true,
          "planningModel": "<string>",
          "promptStrategy": "<string>",
          "raiseExceptionOnAiFallback": true,
          "raiseExceptionOnFallback": true,
          "rerank": true,
          "restrictClassification": true,
          "skipExtraction": true,
          "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,
  "type": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>",
  "yamlSource": "<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

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.

deleteUserEmail
string | null
deleteUserId
string | null
deleted
boolean
deletedDate
string<date-time> | null
deprecated
boolean

Whether this taxonomy is deprecated.

extensionPackRef
string
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"

organizationId
string
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.

type
string
updatedOn
string<date-time>

Timestamp when the taxonomy was last updated.

uuid
string

Secondary UUID identifier.

yamlSource
string | null

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.

deleteUserEmail
string | null
deleteUserId
string | null
deleted
boolean
deletedDate
string<date-time> | null
deprecated
boolean

Whether this taxonomy is deprecated.

extensionPackRef
string
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"

organizationId
string
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.

type
string
updatedOn
string<date-time>

Timestamp when the taxonomy was last updated.

uuid
string

Secondary UUID identifier.

yamlSource
string | null