Sign in

v4

latestSwagger 2.02026-07-13109102258.7 KB
Glossary

Get terms by glossary name. Note this API has been deprecated. Please use 'GET /catalog/api/glossary/{glossaryGuid}/terms' instead.

get/glossary/name/{glossaryName}/terms

Path parameters

glossaryNamestring required

The name of the glossary.

Query parameters

limitinteger

The page size - by default there is no paging.

offsetinteger

The offset for pagination purpose.

includeTermHierarchyboolean

Whether include term hierarchy

extInfoboolean

Whether include extended information like contact display name and attribute values

api-versionstring required

Version of Purview APIs

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.