Save Database Taxonomy

Creates or updates a database taxonomy.

A taxonomy is a hierarchical set of terms (categories, tags) you can attach to records.

This endpoint creates the database taxonomy and returns its id.

Creates or updates a database taxonomy

post

Authorizations

Bearer

HTTPRequired

JWT Bearer Authorization

Path parameters

versionstring · nullableRequired

The CodeMash API version used to fetch data from the API. If not specified, the last version will be used. E.g.: v3

Body

multipart/form-dataapplication/json

Creates or updates a database taxonomy

correlationIdstring · nullableOptional

CorrelationId for each request

cultureCodestring · nullableOptional

Specify culture code when your response from the API should be localised. E.g.: en

timeZoneIdstring · nullableOptional

TimeZone

envstring · nullableOptional

Target environment for this request (e.g. TEST, STAGING). Optional — when omitted the request runs against PROD. Can be passed in a header as norbix-env.

projectIdstringRequired

ID of your project. Can be passed in a header as norbix-project-id.

dependenciesstring[] · nullableOptional

Optional list of other taxonomy ids this taxonomy depends on for multi-parent terms. Omit for a self-contained taxonomy.

descriptionstring · nullableOptional

Optional free-text description of the taxonomy.

parentIdstring · nullableOptional

Optional parent taxonomy id. The child taxonomy points to its parent — e.g. set the Countries taxonomy's parentId to the Regions taxonomy id so each country term can be parented by a region term. Omit for a root taxonomy.

taxonomyNamestringRequired

Human-entered taxonomy title (e.g. "Countries"); a slug is derived server-side.

termsMetaDataSchemastring · nullableOptional

Optional raw JSON string (Norbix data meta-schema) describing custom meta fields for terms in this taxonomy. Omit to leave the taxonomy structural-only.

termsMetaVisualSchemastring · nullableOptional

Optional raw JSON string (Norbix UI/visual meta-schema) describing the term meta edit form.

viewIdstring · nullableOptional

Empty to create a new taxonomy; set to an existing taxonomy id (from get_database_taxonomies) to update it.

Responses

200

OK

application/json

idstring · nullableOptional

statusstring · nullableOptional

post/{version}/database/taxonomies

HTTPcURLJavaScriptPython

POST /{version}/database/taxonomies HTTP/1.1
Host: hub.norbix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 258

{
  "correlationId": "text",
  "cultureCode": "text",
  "timeZoneId": "text",
  "env": "text",
  "projectId": "text",
  "dependencies": [
    "text"
  ],
  "description": "text",
  "parentId": "text",
  "taxonomyName": "text",
  "termsMetaDataSchema": "text",
  "termsMetaVisualSchema": "text",
  "viewId": "text"
}

multipart/form-dataapplication/json

200

OK

{
  "responseStatus": {
    "isSuccess": true
  },
  "id": "text",
  "status": "text"
}

In the dashboard

Manage this visually in Norbix Cloud — see Database.

Use it from code

Every Norbix SDK exposes this endpoint as a method — see Save Database Taxonomy in the SDK reference, with examples in every language.