PUT /v1/glossaries

curl -X PUT "{base_url}/api/v1/glossaries" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "BusinessGlossary",
    "displayName": "Business Glossary",
    "description": "Standard business terminology for the organization",
    "mutuallyExclusive": false,
    "owners": [],
    "reviewers": []
  }'

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.root}")

// client is an initialized OpenMetadataClient.
var glossaryId = "c2940a98-f147-6g46-cdef-31f0c4406dc3";
var glossary = client.glossaries().get(glossaryId);
glossary.setDescription("Updated: Comprehensive business terminology dictionary");

var updated = client.glossaries().update(glossaryId, glossary);

# Update by ID
curl -X PATCH "{base_url}/api/v1/glossaries/c2940a98-f147-6g46-cdef-31f0c4406dc3" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Comprehensive business terminology dictionary"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/glossaries/name/BusinessGlossary" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Comprehensive business terminology dictionary"}
  ]'

{
  "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
}

PUT

glossaries

PUT /v1/glossaries

curl -X PUT "{base_url}/api/v1/glossaries" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "BusinessGlossary",
    "displayName": "Business Glossary",
    "description": "Standard business terminology for the organization",
    "mutuallyExclusive": false,
    "owners": [],
    "reviewers": []
  }'

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.root}")

// client is an initialized OpenMetadataClient.
var glossaryId = "c2940a98-f147-6g46-cdef-31f0c4406dc3";
var glossary = client.glossaries().get(glossaryId);
glossary.setDescription("Updated: Comprehensive business terminology dictionary");

var updated = client.glossaries().update(glossaryId, glossary);

# Update by ID
curl -X PATCH "{base_url}/api/v1/glossaries/c2940a98-f147-6g46-cdef-31f0c4406dc3" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Comprehensive business terminology dictionary"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/glossaries/name/BusinessGlossary" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Comprehensive business terminology dictionary"}
  ]'

{
  "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

Create a glossary or update it if it already exists, using PUT /v1/glossaries with the full request body. Send the complete definition, not just the fields you want to change. To change only some fields, use PATCH with a JSON Patch array and the application/json-patch+json content type, as shown in the PATCH examples below.

Body Parameters

string

required

Name of the glossary. Must be unique.

string

Human-readable display name for the glossary.

string

required

Description of the glossary in Markdown format.

array

Array of owner references (users or teams) to assign to the glossary.

Show properties

string

UUID of the owner entity.

string

Type of owner entity, for example user, team.

string

Name of the owner entity.

array

Array of user references who can review glossary term changes.

Show properties

string

UUID of the user.

string

Type of entity (always user).

string

Name of the user.

array

Array of classification tags to apply to the glossary.

Show properties

string

required

Fully qualified name of the tag.

string

Type of label, for example Manual, Derived, Propagated.

string

State of the tag, for example Suggested, Confirmed.

array

Fully qualified names of the domains 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.

PUT /v1/glossaries

curl -X PUT "{base_url}/api/v1/glossaries" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "BusinessGlossary",
    "displayName": "Business Glossary",
    "description": "Standard business terminology for the organization",
    "mutuallyExclusive": false,
    "owners": [],
    "reviewers": []
  }'

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.root}")

// client is an initialized OpenMetadataClient.
var glossaryId = "c2940a98-f147-6g46-cdef-31f0c4406dc3";
var glossary = client.glossaries().get(glossaryId);
glossary.setDescription("Updated: Comprehensive business terminology dictionary");

var updated = client.glossaries().update(glossaryId, glossary);

# Update by ID
curl -X PATCH "{base_url}/api/v1/glossaries/c2940a98-f147-6g46-cdef-31f0c4406dc3" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Comprehensive business terminology dictionary"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/glossaries/name/BusinessGlossary" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Comprehensive business terminology dictionary"}
  ]'

{
  "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

string

Unique identifier for the glossary (UUID format).

string

Glossary name.

string

Fully qualified name of the glossary.

string

Updated description.

number

Incremented version number.

Error Handling

Code	Error Type	Description
`400`	`BAD_REQUEST`	Invalid or malformed request body
`401`	`UNAUTHORIZED`	Invalid or missing authentication token
`403`	`FORBIDDEN`	User lacks permission to update this glossary
`409`	`CONFLICT`	Concurrent modification detected

API Reference

Data Assets

AI Assets

AI SDK

SDK

Discovery

Lineage

Data Contracts

Teams And Users

Data Governance

Data Quality

Alerts

Incidents

Main Concepts

Update a Glossary

Update a Glossary

Body Parameters

Returns

Response

Error Handling