PATCH /v1/glossaries/{id}

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

configure(
    host="https://your-company.getcollate.io/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}")

import static org.openmetadata.sdk.fluent.Glossaries.*;

// Retrieve, modify, and update
var glossary = Glossaries.retrieve("c2940a98-f147-6g46-cdef-31f0c4406dc3");
glossary.setDescription("Updated: Comprehensive business terminology dictionary");
var updated = Glossaries.update(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
}

PATCH

glossaries

{id}

PATCH /v1/glossaries/{id}

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

configure(
    host="https://your-company.getcollate.io/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}")

import static org.openmetadata.sdk.fluent.Glossaries.*;

// Retrieve, modify, and update
var glossary = Glossaries.retrieve("c2940a98-f147-6g46-cdef-31f0c4406dc3");
glossary.setDescription("Updated: Comprehensive business terminology dictionary");
var updated = Glossaries.update(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

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

Update by ID

string

required

UUID of the glossary to update.

Update by Name

Use PATCH /v1/glossaries/name/{fqn} to update by fully qualified name.

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.

string

Updated description in Markdown format.

string

Updated display name.

boolean

Updated mutually exclusive setting.

array

Updated list of owner references.

Show properties

string

UUID of the owner entity.

string

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

array

Updated list of reviewer references.

Show properties

string

UUID of the user.

string

Type of entity (always user).

array

Updated classification tags.

Show properties

string

required

Fully qualified name of the tag.

string

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

string

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

string

Updated domain FQN.

PATCH /v1/glossaries/{id}

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

configure(
    host="https://your-company.getcollate.io/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}")

import static org.openmetadata.sdk.fluent.Glossaries.*;

// Retrieve, modify, and update
var glossary = Glossaries.retrieve("c2940a98-f147-6g46-cdef-31f0c4406dc3");
glossary.setDescription("Updated: Comprehensive business terminology dictionary");
var updated = Glossaries.update(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 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

Retrieve a Glossary

Delete a Glossary

⌘I

​Update a Glossary

​Update by ID

​Update by Name

​Body Parameters

​Returns

​Response

​Error Handling

Update a Glossary

Update by ID

Update by Name

Body Parameters

Returns

Response

Error Handling