Skip to main content
POST
POST /v1/glossaries

Create a Glossary

Create a new glossary for organizing business terminology.

Body Parameters

string
required
Name of the glossary. Must be unique.
string
Human-readable display name for the glossary.
string
Description of the glossary in Markdown format.
array
Array of owner references (users or teams) to assign to the glossary.
array
Array of user references who can review glossary term changes.
array
Array of classification tags to apply to the glossary.
string
Fully qualified name of the domain to assign for governance purposes.
boolean
default:"false"
If true, only one term from this glossary can be applied to an entity at a time.
POST /v1/glossaries

Returns

Returns the created glossary object with all specified properties and system-generated fields.

Response

string
Unique identifier for the glossary (UUID format).
string
Glossary name.
string
Fully qualified name of the glossary.
string
Human-readable display name.
string
Description of the glossary in Markdown format.
boolean
Whether terms in this glossary are mutually exclusive.
array
List of owners assigned to the glossary.
array
List of reviewers for glossary term changes.
array
Classification tags applied to the glossary.
number
Version number for the entity (starts at 0.1).

Create or Update (PUT)

Use PUT /v1/glossaries instead of POST to perform an upsert. If a glossary with the same fullyQualifiedName already exists, it will be updated; otherwise, a new glossary is created. The request body is the same as POST.
PUT will not return a 409 conflict error if the entity already exists — it will update the existing entity instead.

Error Handling