pyapacheatlas.core.glossary.glossaryclient.PurviewGlossaryClient.get_glossary#

PurviewGlossaryClient.get_glossary(name='Glossary', guid=None, detailed=False)#

Retrieve the specified glossary by name or guid along with the term headers (AtlasRelatedTermHeader: including displayText and termGuid). Providing the glossary name only will result in a lookup of all glossaries and returns the term headers (accessible via “terms” key) for all glossaries. Use detailed = True to return the full detail of terms (AtlasGlossaryTerm) accessible via “termInfo” key.

Parameters

  • name (str) – The name of the glossary to use, defaults to “Glossary”. Not required if using the guid parameter.

  • guid (str) – The unique guid of your glossary. Not required if using the name parameter.

  • detailed (bool) – Set to true if you want to pull back all terms and not just headers.

Returns

The requested glossary with the term headers (AtlasGlossary) or with detailed terms (AtlasGlossaryExtInfo).

Return type

list(dict)