Skip to main content
PATCH
/
v1
/
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}")

{
  "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": []
}

Documentation Index

Fetch the complete documentation index at: https://docs.getcollate.io/llms.txt

Use this file to discover all available pages before exploring further.

​
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

​
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.
​
fqn
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.
​
description
string
Updated description in Markdown format.
​
displayName
string
Updated display name.
​
synonyms
array
Updated list of synonym strings.
​
relatedTerms
array
Updated list of related term FQNs.
​
owners
array
Updated list of owner references.
​
tags
array
Updated classification tags.
​
style
object
Updated visual styling.
​
domain
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}")

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

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

​
Error Handling

CodeError TypeDescription
400BAD_REQUESTInvalid JSON patch or malformed request
401UNAUTHORIZEDInvalid or missing authentication token
403FORBIDDENUser lacks permission to update this glossary term
404NOT_FOUNDGlossary term with given ID or FQN does not exist
409CONFLICTConcurrent modification detected