Skip to main content

​
Glossary Terms

A Glossary Term is a specific business term defined within a glossary. Terms can be hierarchically nested and support synonyms, related terms, and rich metadata.
Entity schema follows the OpenMetadata Standard.

​
Entity Hierarchy

Glossary Terms belong to a Glossary and can be nested: 
Glossary
├── GlossaryTerm (top-level)
│   ├── GlossaryTerm (child)
│   └── GlossaryTerm (child)
└── GlossaryTerm (top-level)

​
Fully Qualified Name

The FQN format for a glossary term is: 
glossary.termName
For nested terms: 
glossary.parent.child
For example: BusinessGlossary.Revenue or BusinessGlossary.Revenue.GrossRevenue

​
API Endpoints

MethodEndpointDescription
PUT/v1/glossaryTermsCreate or update a glossary term
POST/v1/glossaryTermsCreate a glossary term (POST variant)
GET/v1/glossaryTermsList glossary terms
GET/v1/glossaryTerms/{id}Get by ID
GET/v1/glossaryTerms/name/{fqn}Get by FQN
PATCH/v1/glossaryTerms/{id}Update by ID
PATCH/v1/glossaryTerms/name/{fqn}Update by name
DELETE/v1/glossaryTerms/{id}Delete by ID
DELETE/v1/glossaryTerms/name/{fqn}Delete by name
PUT/v1/glossaryTerms/restoreRestore soft-deleted glossary term
GET/v1/glossaryTerms/{id}/versionsList versions
GET/v1/glossaryTerms/{id}/versions/{version}Get specific version