PATCH /v1/glossaryTerms/{id}

from metadata.sdk import configure
from metadata.sdk.entities import GlossaryTerms

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

# Retrieve, modify, and update
term = GlossaryTerms.retrieve("d3a50b09-g258-7h57-defg-42g1d5517ed4")
term.description = "Updated: Total income from all business operations before deductions"
term.synonyms = ["Income", "Earnings", "Sales", "Turnover"]
updated = GlossaryTerms.update(term)

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

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

// Retrieve, modify, and update
var term = GlossaryTerms.retrieve("d3a50b09-g258-7h57-defg-42g1d5517ed4");
term.setDescription("Updated: Total income from all business operations before deductions");
var updated = GlossaryTerms.update(term);

# Update by ID
curl -X PATCH "{base_url}/api/v1/glossaryTerms/d3a50b09-g258-7h57-defg-42g1d5517ed4" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Total income from all business operations before deductions"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/glossaryTerms/name/BusinessGlossary.Revenue" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Total income from all business operations before deductions"}
  ]'

{
  "id": "d3a50b09-g258-7h57-defg-42g1d5517ed4",
  "name": "Revenue",
  "fullyQualifiedName": "BusinessGlossary.Revenue",
  "displayName": "Revenue",
  "description": "Updated: Total income from all business operations before deductions",
  "synonyms": ["Income", "Earnings", "Sales", "Turnover"],
  "glossary": {
    "id": "c2940a98-f147-6g46-cdef-31f0c4406dc3",
    "type": "glossary",
    "name": "BusinessGlossary",
    "fullyQualifiedName": "BusinessGlossary",
    "deleted": false
  },
  "version": 0.2,
  "updatedAt": 1769984330261,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/glossaryTerms/d3a50b09-g258-7h57-defg-42g1d5517ed4",
  "deleted": false,
  "owners": [],
  "tags": [],
  "children": [],
  "relatedTerms": []
}

PATCH

glossaryTerms

{id}

PATCH /v1/glossaryTerms/{id}

from metadata.sdk import configure
from metadata.sdk.entities import GlossaryTerms

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

# Retrieve, modify, and update
term = GlossaryTerms.retrieve("d3a50b09-g258-7h57-defg-42g1d5517ed4")
term.description = "Updated: Total income from all business operations before deductions"
term.synonyms = ["Income", "Earnings", "Sales", "Turnover"]
updated = GlossaryTerms.update(term)

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

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

// Retrieve, modify, and update
var term = GlossaryTerms.retrieve("d3a50b09-g258-7h57-defg-42g1d5517ed4");
term.setDescription("Updated: Total income from all business operations before deductions");
var updated = GlossaryTerms.update(term);

# Update by ID
curl -X PATCH "{base_url}/api/v1/glossaryTerms/d3a50b09-g258-7h57-defg-42g1d5517ed4" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Total income from all business operations before deductions"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/glossaryTerms/name/BusinessGlossary.Revenue" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Total income from all business operations before deductions"}
  ]'

{
  "id": "d3a50b09-g258-7h57-defg-42g1d5517ed4",
  "name": "Revenue",
  "fullyQualifiedName": "BusinessGlossary.Revenue",
  "displayName": "Revenue",
  "description": "Updated: Total income from all business operations before deductions",
  "synonyms": ["Income", "Earnings", "Sales", "Turnover"],
  "glossary": {
    "id": "c2940a98-f147-6g46-cdef-31f0c4406dc3",
    "type": "glossary",
    "name": "BusinessGlossary",
    "fullyQualifiedName": "BusinessGlossary",
    "deleted": false
  },
  "version": 0.2,
  "updatedAt": 1769984330261,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/glossaryTerms/d3a50b09-g258-7h57-defg-42g1d5517ed4",
  "deleted": false,
  "owners": [],
  "tags": [],
  "children": [],
  "relatedTerms": []
}

Update a Glossary Term

Update a glossary term’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 term to update.

Update by Name

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

string

required

Fully qualified name of the glossary term (e.g., BusinessGlossary.Revenue).

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.

array

Updated list of synonym strings.

Updated list of related term FQNs.

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 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).

object

Updated visual styling.

Show properties

string

Hex color code (e.g., #FF5733).

string

URL to a custom icon.

string

Updated domain FQN.

PATCH /v1/glossaryTerms/{id}

from metadata.sdk import configure
from metadata.sdk.entities import GlossaryTerms

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

# Retrieve, modify, and update
term = GlossaryTerms.retrieve("d3a50b09-g258-7h57-defg-42g1d5517ed4")
term.description = "Updated: Total income from all business operations before deductions"
term.synonyms = ["Income", "Earnings", "Sales", "Turnover"]
updated = GlossaryTerms.update(term)

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

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

// Retrieve, modify, and update
var term = GlossaryTerms.retrieve("d3a50b09-g258-7h57-defg-42g1d5517ed4");
term.setDescription("Updated: Total income from all business operations before deductions");
var updated = GlossaryTerms.update(term);

# Update by ID
curl -X PATCH "{base_url}/api/v1/glossaryTerms/d3a50b09-g258-7h57-defg-42g1d5517ed4" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Total income from all business operations before deductions"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/glossaryTerms/name/BusinessGlossary.Revenue" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Total income from all business operations before deductions"}
  ]'

{
  "id": "d3a50b09-g258-7h57-defg-42g1d5517ed4",
  "name": "Revenue",
  "fullyQualifiedName": "BusinessGlossary.Revenue",
  "displayName": "Revenue",
  "description": "Updated: Total income from all business operations before deductions",
  "synonyms": ["Income", "Earnings", "Sales", "Turnover"],
  "glossary": {
    "id": "c2940a98-f147-6g46-cdef-31f0c4406dc3",
    "type": "glossary",
    "name": "BusinessGlossary",
    "fullyQualifiedName": "BusinessGlossary",
    "deleted": false
  },
  "version": 0.2,
  "updatedAt": 1769984330261,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/glossaryTerms/d3a50b09-g258-7h57-defg-42g1d5517ed4",
  "deleted": false,
  "owners": [],
  "tags": [],
  "children": [],
  "relatedTerms": []
}

Returns

Returns the updated glossary term object with the new version number.

Response

string

Unique identifier for the glossary term (UUID format).

string

Glossary term name.

string

Fully qualified name of the glossary term.

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 term
`404`	`NOT_FOUND`	Glossary term with given ID or FQN does not exist
`409`	`CONFLICT`	Concurrent modification detected

⌘I

​Update a Glossary Term

​Update by ID

​Update by Name

​Body Parameters

​Returns

​Response

​Error Handling

Update a Glossary Term

Update by ID

Update by Name

Body Parameters

Returns

Response

Error Handling