Sign in

v4

latestSwagger 2.02026-07-13109102258.7 KB
Glossary

Get terms belonging to a specific glossary. Recommend using limit/offset to get pagination result.

get/atlas/v2/glossary/{glossaryGuid}/terms

Path parameters

glossaryGuidstring required

The globally unique identifier for glossary.

Query parameters

includeTermHierarchyboolean

Whether include term hierarchy

limitinteger

The page size - by default there is no paging.

offsetinteger

The offset for pagination purpose.

sortstring

The sort order, ASC (default) or DESC.

Response

OK. An array of glossary terms for the given glossary or an empty list.

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.