Skip to main content
POST
/
api
/
taxonomies
cURL
curl --request POST \
  --url http://localhost/api/taxonomies \
  --header 'Content-Type: application/json' \
  --data '{
  "taxonomies": {},
  "taxon": {
    "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>"
  },
  "taxonPath": "<string>"
}'
{
  "prompt": "<string>",
  "suggestion": "<string>"
}

Body

application/json
taxonomies
object
taxon
object

A taxon is an individual label within a taxonomy

taxonPath
string

Response

OK

prompt
string
suggestion
string
I