Skip to main content
GET
https://sandbox.getcollate.io/api
/
v1
/
glossaryTerms
/
{id}
/
versions
GET /v1/glossaryTerms/{id}/versions
from metadata.sdk import configure
from metadata.sdk.entities import GlossaryTerms

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

# List all versions
versions = GlossaryTerms.get_versions("d3a50b09-g258-7h57-defg-42g1d5517ed4")
for v in versions:
    print(f"Version {v.version}: {v.description}")

# Get a specific version
term_v1 = GlossaryTerms.get_specific_version(
    "d3a50b09-g258-7h57-defg-42g1d5517ed4",
    "0.1"
)
print(f"Original description: {term_v1.description}")

{
  "entityType": "glossaryTerm",
  "versions": [
    "{\"id\":\"d3a50b09-g258-7h57-defg-42g1d5517ed4\",\"name\":\"Revenue\",\"fullyQualifiedName\":\"BusinessGlossary.Revenue\",\"version\":0.2,\"description\":\"Updated description\",\"synonyms\":[\"Income\",\"Earnings\",\"Sales\",\"Turnover\"]}",
    "{\"id\":\"d3a50b09-g258-7h57-defg-42g1d5517ed4\",\"name\":\"Revenue\",\"fullyQualifiedName\":\"BusinessGlossary.Revenue\",\"version\":0.1,\"description\":\"Total income generated from business operations\",\"synonyms\":[\"Income\",\"Earnings\",\"Sales\"]}"
  ]
}

​
Glossary Term Versions

Every change to a glossary term entity creates a new version. Use these endpoints to view the version history and retrieve specific versions.

​
List Versions

​
id
string
required
UUID of the glossary term.

​
Get Specific Version

Use GET /v1/glossaryTerms/{id}/versions/{version} to retrieve a specific version.
​
id
string
required
UUID of the glossary term.
​
version
string
required
Version number to retrieve (e.g., 0.2).
GET /v1/glossaryTerms/{id}/versions
from metadata.sdk import configure
from metadata.sdk.entities import GlossaryTerms

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

# List all versions
versions = GlossaryTerms.get_versions("d3a50b09-g258-7h57-defg-42g1d5517ed4")
for v in versions:
    print(f"Version {v.version}: {v.description}")

# Get a specific version
term_v1 = GlossaryTerms.get_specific_version(
    "d3a50b09-g258-7h57-defg-42g1d5517ed4",
    "0.1"
)
print(f"Original description: {term_v1.description}")

{
  "entityType": "glossaryTerm",
  "versions": [
    "{\"id\":\"d3a50b09-g258-7h57-defg-42g1d5517ed4\",\"name\":\"Revenue\",\"fullyQualifiedName\":\"BusinessGlossary.Revenue\",\"version\":0.2,\"description\":\"Updated description\",\"synonyms\":[\"Income\",\"Earnings\",\"Sales\",\"Turnover\"]}",
    "{\"id\":\"d3a50b09-g258-7h57-defg-42g1d5517ed4\",\"name\":\"Revenue\",\"fullyQualifiedName\":\"BusinessGlossary.Revenue\",\"version\":0.1,\"description\":\"Total income generated from business operations\",\"synonyms\":[\"Income\",\"Earnings\",\"Sales\"]}"
  ]
}

​
Returns

List versions returns an object with entityType and a versions array of serialized entity snapshots (newest first). Get specific version returns the full glossary term object as it existed at that version.

​
Error Handling

CodeError TypeDescription
401UNAUTHORIZEDInvalid or missing authentication token
404NOT_FOUNDGlossary term or version does not exist