Skip to main content
PUT
/
api
/
taxonomies
/
{organizationSlug}
/
{slug}
/
{version}
cURL
curl --request PUT \
  --url http://localhost/api/taxonomies/{organizationSlug}/{slug}/{version} \
  --header 'Content-Type: application/json' \
  --data '{
  "ref": "<string>",
  "template": true,
  "orgSlug": "<string>",
  "slug": "<string>",
  "type": "<string>",
  "name": "<string>",
  "description": "<string>",
  "version": "<string>",
  "get_id": "<string>",
  "publicAccess": true,
  "imageUrl": "<string>",
  "icon": "<string>",
  "overviewMarkdown": "<string>",
  "provider": "<string>",
  "providerUrl": "<string>",
  "providerImageUrl": "<string>",
  "deleteProtection": true,
  "checksum": "<string>",
  "deprecated": true,
  "extensionPackRef": "<string>",
  "taxonomyType": "CONTENT",
  "enabled": true,
  "externalDataTaxonomyRefs": [
    "<string>"
  ],
  "taxons": [
    {
      "id": "<string>",
      "label": "<string>",
      "order": 123,
      "generateName": true,
      "group": true,
      "name": "<string>",
      "selectWeight": 123,
      "externalName": "<string>",
      "valuePath": "VALUE_OR_ALL_CONTENT",
      "metadataValue": "FILENAME",
      "dataPath": "<string>",
      "expression": "<string>",
      "enableFallbackExpression": true,
      "fallbackExpression": "<string>",
      "enableSerializationExpression": true,
      "serializationExpression": "<string>",
      "nullable": true,
      "nullValue": "<string>",
      "denormalizeToChildren": true,
      "notUserLabelled": true,
      "description": "<string>",
      "overviewMarkdown": "<string>",
      "semanticDefinition": "<string>",
      "synonyms": [
        "<string>"
      ],
      "lexicalRelations": [
        {
          "type": "SYNONYM",
          "value": "<string>",
          "weight": 123
        }
      ],
      "additionContexts": [
        {
          "type": "RECORD_DEFINITION",
          "context": "<string>",
          "weight": 123,
          "negative": true
        }
      ],
      "guideProperties": {
        "guidanceKey": true,
        "guidanceKeyExpression": "<string>",
        "useGuidanceForClassification": true,
        "ifPresentRequired": true
      },
      "enabled": true,
      "color": "<string>",
      "children": [
        {}
      ],
      "options": [
        {
          "groupOptions": [
            {}
          ],
          "properties": {},
          "tabName": "<string>",
          "name": "<string>",
          "aliases": [
            "<string>"
          ],
          "label": "<string>",
          "falseLabel": "<string>",
          "hint": "<string>",
          "required": true,
          "type": "<string>",
          "subType": "<string>",
          "listType": "<string>",
          "displayProperties": {},
          "listLabel": "<string>",
          "listDescription": "<string>",
          "featureFlag": "<string>",
          "default": {},
          "description": "<string>",
          "supportArticle": "<string>",
          "overviewMarkdown": "<string>",
          "showIf": "<string>",
          "developerOnly": true,
          "showOnPopup": true,
          "possibleValues": [
            {
              "label": "<string>",
              "value": {},
              "description": "<string>"
            }
          ]
        }
      ],
      "nodeTypes": [
        "<string>"
      ],
      "taxonType": "STRING",
      "selectionOptions": [
        {
          "label": "<string>",
          "id": "<string>",
          "description": "<string>",
          "isConditional": true,
          "conditionalFormula": "<string>",
          "lexicalRelations": [
            {
              "type": "SYNONYM",
              "value": "<string>",
              "weight": 123
            }
          ]
        }
      ],
      "typeFeatures": {},
      "properties": {},
      "conditionalFormats": [
        {
          "type": "<string>",
          "condition": "<string>",
          "properties": {}
        }
      ],
      "validationRules": [
        {
          "name": "<string>",
          "disabled": true,
          "description": "<string>",
          "conditional": true,
          "conditionalFormula": "<string>",
          "ruleFormula": "<string>",
          "messageFormula": "<string>",
          "detailFormula": "<string>",
          "exceptionId": "<string>",
          "supportArticleId": "<string>",
          "overridable": true
        }
      ],
      "cardinality": "ONCE_PER_DOCUMENT",
      "path": "<string>",
      "multiValue": true,
      "userEditable": true,
      "usePostExpression": true,
      "postExpression": "<string>"
    }
  ],
  "totalTaxons": 123
}'
{
  "ref": "<string>",
  "template": true,
  "orgSlug": "<string>",
  "slug": "<string>",
  "type": "<string>",
  "name": "<string>",
  "description": "<string>",
  "version": "<string>",
  "get_id": "<string>",
  "publicAccess": true,
  "imageUrl": "<string>",
  "icon": "<string>",
  "overviewMarkdown": "<string>",
  "provider": "<string>",
  "providerUrl": "<string>",
  "providerImageUrl": "<string>",
  "deleteProtection": true,
  "checksum": "<string>",
  "deprecated": true,
  "extensionPackRef": "<string>",
  "taxonomyType": "CONTENT",
  "enabled": true,
  "externalDataTaxonomyRefs": [
    "<string>"
  ],
  "taxons": [
    {
      "id": "<string>",
      "label": "<string>",
      "order": 123,
      "generateName": true,
      "group": true,
      "name": "<string>",
      "selectWeight": 123,
      "externalName": "<string>",
      "valuePath": "VALUE_OR_ALL_CONTENT",
      "metadataValue": "FILENAME",
      "dataPath": "<string>",
      "expression": "<string>",
      "enableFallbackExpression": true,
      "fallbackExpression": "<string>",
      "enableSerializationExpression": true,
      "serializationExpression": "<string>",
      "nullable": true,
      "nullValue": "<string>",
      "denormalizeToChildren": true,
      "notUserLabelled": true,
      "description": "<string>",
      "overviewMarkdown": "<string>",
      "semanticDefinition": "<string>",
      "synonyms": [
        "<string>"
      ],
      "lexicalRelations": [
        {
          "type": "SYNONYM",
          "value": "<string>",
          "weight": 123
        }
      ],
      "additionContexts": [
        {
          "type": "RECORD_DEFINITION",
          "context": "<string>",
          "weight": 123,
          "negative": true
        }
      ],
      "guideProperties": {
        "guidanceKey": true,
        "guidanceKeyExpression": "<string>",
        "useGuidanceForClassification": true,
        "ifPresentRequired": true
      },
      "enabled": true,
      "color": "<string>",
      "children": [
        {}
      ],
      "options": [
        {
          "groupOptions": [
            {}
          ],
          "properties": {},
          "tabName": "<string>",
          "name": "<string>",
          "aliases": [
            "<string>"
          ],
          "label": "<string>",
          "falseLabel": "<string>",
          "hint": "<string>",
          "required": true,
          "type": "<string>",
          "subType": "<string>",
          "listType": "<string>",
          "displayProperties": {},
          "listLabel": "<string>",
          "listDescription": "<string>",
          "featureFlag": "<string>",
          "default": {},
          "description": "<string>",
          "supportArticle": "<string>",
          "overviewMarkdown": "<string>",
          "showIf": "<string>",
          "developerOnly": true,
          "showOnPopup": true,
          "possibleValues": [
            {
              "label": "<string>",
              "value": {},
              "description": "<string>"
            }
          ]
        }
      ],
      "nodeTypes": [
        "<string>"
      ],
      "taxonType": "STRING",
      "selectionOptions": [
        {
          "label": "<string>",
          "id": "<string>",
          "description": "<string>",
          "isConditional": true,
          "conditionalFormula": "<string>",
          "lexicalRelations": [
            {
              "type": "SYNONYM",
              "value": "<string>",
              "weight": 123
            }
          ]
        }
      ],
      "typeFeatures": {},
      "properties": {},
      "conditionalFormats": [
        {
          "type": "<string>",
          "condition": "<string>",
          "properties": {}
        }
      ],
      "validationRules": [
        {
          "name": "<string>",
          "disabled": true,
          "description": "<string>",
          "conditional": true,
          "conditionalFormula": "<string>",
          "ruleFormula": "<string>",
          "messageFormula": "<string>",
          "detailFormula": "<string>",
          "exceptionId": "<string>",
          "supportArticleId": "<string>",
          "overridable": true
        }
      ],
      "cardinality": "ONCE_PER_DOCUMENT",
      "path": "<string>",
      "multiValue": true,
      "userEditable": true,
      "usePostExpression": true,
      "postExpression": "<string>"
    }
  ],
  "totalTaxons": 123
}

Path Parameters

​
organizationSlug
string
required
​
slug
string
required
​
version
string
required

Body

application/json

A taxonomy is a hierarchical structure of taxons that can be used to classify content for extraction

​
orgSlug
string
required

The slug of the organization that owns this metadata object

​
slug
string
required

The slug used when referencing this metadata object

​
type
string
required

The type of metadata object The metadata object type

​
name
string
required

The name of the object

​
version
string
required

The version of the object

​
ref
string

The reference to the metadata object

​
template
boolean

Is this component a template that can be used to create new components

​
description
string

The description of the object

​
get_id
string

An internal identifier (not for public use)

​
publicAccess
boolean

Is the metadata object publicly accessible by other organizations

​
imageUrl
string

URL of image when presenting this object in a UI

​
icon
string

Material Icon name to use in the UI

​
overviewMarkdown
string

Markdown that is used to present the overview of the object

​
provider
string

The details of the of provider

​
providerUrl
string

The link to the provider website

​
providerImageUrl
string

The link to the model image

​
deleteProtection
boolean

Delete protection status

​
checksum
string

The checksum of the metadata, calculated by the platform and used to determine if the metadata has changed

​
deprecated
boolean

The resource is marked for deprecation

​
extensionPackRef
string

The reference to the extension pack (if the metadata object was created by an extension pack)

​
taxonomyType
enum<string>

The type of taxonomy

Available options:
CONTENT,
CLASSIFICATION,
PROCESSING,
MODEL
​
enabled
boolean

Is the taxonomy enabled (effects display in the UI)

​
externalDataTaxonomyRefs
string[]

A list of references to taxonomies that will represent the external data

A list of references to taxonomies that will represent the external data

​
taxons
object[]

The hierarchical structure of taxon's in this taxonomy

​
totalTaxons
integer

The total number of taxons in the taxonomy

Response

OK

A taxonomy is a hierarchical structure of taxons that can be used to classify content for extraction

​
orgSlug
string
required

The slug of the organization that owns this metadata object

​
slug
string
required

The slug used when referencing this metadata object

​
type
string
required

The type of metadata object The metadata object type

​
name
string
required

The name of the object

​
version
string
required

The version of the object

​
ref
string

The reference to the metadata object

​
template
boolean

Is this component a template that can be used to create new components

​
description
string

The description of the object

​
get_id
string

An internal identifier (not for public use)

​
publicAccess
boolean

Is the metadata object publicly accessible by other organizations

​
imageUrl
string

URL of image when presenting this object in a UI

​
icon
string

Material Icon name to use in the UI

​
overviewMarkdown
string

Markdown that is used to present the overview of the object

​
provider
string

The details of the of provider

​
providerUrl
string

The link to the provider website

​
providerImageUrl
string

The link to the model image

​
deleteProtection
boolean

Delete protection status

​
checksum
string

The checksum of the metadata, calculated by the platform and used to determine if the metadata has changed

​
deprecated
boolean

The resource is marked for deprecation

​
extensionPackRef
string

The reference to the extension pack (if the metadata object was created by an extension pack)

​
taxonomyType
enum<string>

The type of taxonomy

Available options:
CONTENT,
CLASSIFICATION,
PROCESSING,
MODEL
​
enabled
boolean

Is the taxonomy enabled (effects display in the UI)

​
externalDataTaxonomyRefs
string[]

A list of references to taxonomies that will represent the external data

A list of references to taxonomies that will represent the external data

​
taxons
object[]

The hierarchical structure of taxon's in this taxonomy

​
totalTaxons
integer

The total number of taxons in the taxonomy

⌘I