Update a Glossary

Update glossary properties using JSON Patch

PATCH /v1/glossaries/{id}

PATCH /v1/glossaries/{id}

Python

from metadata.sdk import configure
from metadata.sdk.entities import Glossaries

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# Retrieve, modify, and update
glossary = Glossaries.retrieve("c2940a98-f147-6g46-cdef-31f0c4406dc3")
glossary.description = "Updated: Comprehensive business terminology dictionary"
glossary.mutuallyExclusive = True
updated = Glossaries.update(glossary)

print(f"Updated to version {updated.version}")

Response

{
  "id": "c2940a98-f147-6g46-cdef-31f0c4406dc3",
  "name": "BusinessGlossary",
  "fullyQualifiedName": "BusinessGlossary",
  "displayName": "Business Glossary",
  "description": "Updated: Comprehensive business terminology dictionary",
  "version": 0.2,
  "updatedAt": 1769984330261,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/glossaries/c2940a98-f147-6g46-cdef-31f0c4406dc3",
  "deleted": false,
  "owners": [],
  "reviewers": [],
  "tags": [],
  "mutuallyExclusive": true
}

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.

Show properties

id · string

UUID of the owner entity.

type · string

Type of owner entity (e.g., user, team).

reviewers · array

Updated list of reviewer references.

Show properties

id · string

UUID of the user.

type · string

Type of entity (always user).

tags · array

Updated classification tags.

Show properties

tagFQN · string · required

Fully qualified name of the tag.

labelType · string

Type of label (e.g., Manual, Derived, Propagated).

state · string

State of the tag (e.g., Suggested, Confirmed).

domain · string

Updated domain FQN.

PATCH /v1/glossaries/{id}

Python

from metadata.sdk import configure
from metadata.sdk.entities import Glossaries

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# Retrieve, modify, and update
glossary = Glossaries.retrieve("c2940a98-f147-6g46-cdef-31f0c4406dc3")
glossary.description = "Updated: Comprehensive business terminology dictionary"
glossary.mutuallyExclusive = True
updated = Glossaries.update(glossary)

print(f"Updated to version {updated.version}")

Response

{
  "id": "c2940a98-f147-6g46-cdef-31f0c4406dc3",
  "name": "BusinessGlossary",
  "fullyQualifiedName": "BusinessGlossary",
  "displayName": "Business Glossary",
  "description": "Updated: Comprehensive business terminology dictionary",
  "version": 0.2,
  "updatedAt": 1769984330261,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/glossaries/c2940a98-f147-6g46-cdef-31f0c4406dc3",
  "deleted": false,
  "owners": [],
  "reviewers": [],
  "tags": [],
  "mutuallyExclusive": true
}

---

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

Code	Error Type	Description
400	BAD_REQUEST	Invalid JSON patch or malformed request
401	UNAUTHORIZED	Invalid or missing authentication token
403	FORBIDDEN	User lacks permission to update this glossary
404	NOT_FOUND	Glossary with given ID or FQN does not exist
409	CONFLICT	Concurrent modification detected