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:

Fully Qualified Name

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

API Endpoints

Bulk Add and Remove Glossary Terms on Assets

Use these endpoints to apply or remove the glossary term on many assets in one request: The request body takes an assets array of entity references (id and type) and an optional dryRun flag.

Reading the Result

Each asset is authorized and saved on its own. An asset the caller cannot edit does not fail the whole request with 403. It comes back as a failed row with the reason, and the other assets are still updated.
  • status: success when every asset was updated, partialSuccess when some were and some were not, and failure when none were.
  • numberOfRowsProcessed, numberOfRowsPassed, numberOfRowsFailed: Counts of assets in the request, updated, and not updated.
  • successRequest: One entry per updated asset.
  • failedRequest: One entry per asset that was not updated. Each has the request (the asset reference) and a message with the reason, for example that the caller lacks permission to edit it.
Clients must read status and failedRequest, not only the HTTP status code. A response of 200 does not mean every asset was updated.
The domain and data product assets/add and assets/remove endpoints are different: they still return 403 when the caller lacks permission.