Skip to main content
PATCH
PATCH /v1/glossaries/{id}

Update a Glossary

Update a glossary’s properties using JSON Merge Patch. You can update by ID or by fully qualified name.

Update by ID

id
string
required
UUID of the glossary to update.

Update by Name

Use PATCH /v1/glossaries/name/{fqn} to update by fully qualified name.
fqn
string
required
Fully qualified name of the glossary (e.g., BusinessGlossary).

Body Parameters

Send a JSON object with the fields to update. Only provided fields are changed.
description
string
Updated description in Markdown format.
displayName
string
Updated display name.
mutuallyExclusive
boolean
Updated mutually exclusive setting.
owners
array
Updated list of owner references.
reviewers
array
Updated list of reviewer references.
tags
array
Updated classification tags.
domain
string
Updated domain FQN.
PATCH /v1/glossaries/{id}

Returns

Returns the updated glossary object with the new version number.

Response

id
string
Unique identifier for the glossary (UUID format).
name
string
Glossary name.
fullyQualifiedName
string
Fully qualified name of the glossary.
description
string
Updated description.
version
number
Incremented version number.

Error Handling