Save Database Taxonomy Term

Insert a single term into a taxonomy.

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

This endpoint creates the database taxonomy term and returns its id.

Insert a single term into a taxonomy

post

Authorizations

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

TaxonomyIdstringRequired

Taxonomy id to insert the term into, from get_database_taxonomies.

Body

Insert a single term into a 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.

databaseIntegrationIdstring · nullableOptional

Optional database integration id. When omitted, the project's default database integration is used.

documentstringRequired

The term to insert, as a MongoDB extended-JSON document string (a raw JSON object). Supported term fields: name (string, or a {lang:value} map — required); description; order (integer sort position, lower shows first — omit for unordered); parentId (id of the single parent term); multiParents ("additional categories": array of {taxonomyId, parentId}). The server stamps taxonomyId/taxonomyName automatically — do not include them. Example: {"name":"France","order":1}.

Responses

200

OK

application/json

idstring · nullableOptional

statusstring · nullableOptional

post/{version}/database/taxonomies/{TaxonomyId}/terms

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

{
  "correlationId": "text",
  "cultureCode": "text",
  "timeZoneId": "text",
  "env": "text",
  "projectId": "text",
  "databaseIntegrationId": "text",
  "document": "text"
}

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 Term in the SDK reference, with examples in every language.