Sign in

v4

latestSwagger 2.02026-07-13109102258.7 KB
Glossary

Get a specific glossary term by its GUID. Recommend using 'excludeRelationshipTypes=AtlasGlossarySemanticAssignment' to get term and using 'GET /catalog/api/atlas/v2/glossary/terms/{termGuid}/assignedEntities' to get term assignment separately.

get/atlas/v2/glossary/term/{termGuid}

Path parameters

termGuidstring required

The globally unique identifier for glossary term.

Query parameters

includeTermHierarchyboolean

Whether include term hierarchy

excludeRelationshipTypesstring[]

An array of relationship types which need to be excluded.

Response

OK. If glossary term exists for given GUID.

guidstring

The GUID of the object.

longDescriptionstring

The long version description.

namestring

The name of the glossary object.

qualifiedNamestring

The qualified name of the glossary object.

shortDescriptionstring

The short version of description.

lastModifiedTSstring

ETag for concurrency control.

createTimeinteger

The created time of the record.

createdBystring

The user who created the record.

updateTimeinteger

The update time of the record.

updatedBystring

The user who updated the record.

abbreviationstring

The abbreviation of the term.

templateNameobject[]
status'Draft' | 'Approved' | 'Alert' | 'Expired'

Status of the AtlasGlossaryTerm

nickNamestring

The nick name of the term.

contactsobject

The dictionary of contacts for terms. Key could be Expert or Steward.

attributesTermCustomAttributes

The custom attributes of the term, which is map<string,map<string,object>>. The key of the first layer map is term template name.

examplesstring[]

An array of examples.

usagestring

The usage of the term.