Skip to main content
POST
Create Taxonomies

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