Glossary - List Terms
Get terms belonging to a specific glossary. Recommend using limit/offset to get pagination result.
GET {endpoint}/datamap/api/atlas/v2/glossary/{glossaryId}/terms
GET {endpoint}/datamap/api/atlas/v2/glossary/{glossaryId}/terms?api-version=2023-09-01&limit={limit}&offset={offset}&sort={sort}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
endpoint
|
path | True |
string |
|
glossary
|
path | True |
string |
The globally unique identifier for glossary. |
api-version
|
query |
string |
The API version to use for this operation. |
|
limit
|
query |
integer int32 |
The page size - by default there is no paging. |
|
offset
|
query |
integer int32 |
The offset for pagination purpose. |
|
sort
|
query |
string |
The sort order, ASC (default) or DESC. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
The request has succeeded. |
|
Other Status Codes |
An unexpected error response. |
Security
OAuth2Auth
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
https://purview.azure.net/.default |
Examples
Glossary_ListTerms
Sample request
GET {endpoint}/datamap/api/atlas/v2/glossary/c018ddaf-7c21-4b37-a838-dae5f110c3d8/terms?api-version=2023-09-01&limit=-1&offset=0&sort=ASC
Sample response
[
{
"guid": "54688d39-b298-4104-9e80-f2a16f44aaea",
"qualifiedName": "ExampleTerm1@Glossary",
"name": "ExampleTerm1",
"shortDescription": "Example Short Description",
"lastModifiedTS": "1",
"abbreviation": "T1",
"createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
"updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
"createTime": 1606287247276,
"updateTime": 1606287247276,
"status": "Approved",
"anchor": {
"glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
"relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0"
},
"seeAlso": [
{
"termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008",
"relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01",
"displayText": "ExampleTerm2"
}
],
"synonyms": [
{
"termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008",
"relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c",
"displayText": "ExampleTerm2"
}
],
"contacts": {
"Expert": [
{
"id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
"info": "Example Expert Info"
}
],
"Steward": [
{
"id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
"info": "Example Steward Info"
}
]
},
"resources": [
{
"displayName": "Example Display Name",
"url": "Example Url"
}
]
},
{
"guid": "952c7ba4-4c89-42d8-a05a-7d2161be7008",
"qualifiedName": "ExampleTerm2@Glossary",
"name": "ExampleTerm2",
"shortDescription": "Example Short Description",
"lastModifiedTS": "1",
"abbreviation": "T2",
"createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
"updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
"createTime": 1606287312495,
"updateTime": 1606287312495,
"status": "Approved",
"anchor": {
"glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
"relationGuid": "9385640b-e6be-437d-a6b9-62d11c14a189"
},
"seeAlso": [
{
"termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea",
"relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01",
"displayText": "ExampleTerm1"
}
],
"synonyms": [
{
"termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea",
"relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c",
"displayText": "ExampleTerm1"
}
],
"resources": [
{
"displayName": "Example Display Name",
"url": "Example Url"
}
]
}
]
Definitions
Name | Description |
---|---|
Atlas |
An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity. |
Atlas |
An error response from the service |
Atlas |
The glossary header with basic information. |
Atlas |
The glossary term. |
Atlas |
Reference to an object-instance of AtlasEntity type used in relationship attribute values |
Atlas |
The header of the related term. |
Atlas |
Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. |
Atlas |
The basic information for term categorization. |
Atlas |
Status for atlas term relationship |
Entity |
Status - can be active or deleted |
Purview |
PurviewObjectId |
Resource |
ResourceLink |
Status |
Status for atlas relationship |
Term |
Status for term |
Time |
Captures time-boundary details |
AtlasClassification
An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity.
Name | Type | Description |
---|---|---|
attributes |
|
The attributes of the struct. |
entityGuid |
string |
The GUID of the entity. |
entityStatus |
Status of the entity - can be active or deleted. Deleted entities are not removed. |
|
lastModifiedTS |
string |
ETag for concurrency control. |
removePropagationsOnEntityDelete |
boolean |
Determines if propagations will be removed on entity deletion. |
typeName |
string |
The name of the type. |
validityPeriods |
An array of time boundaries indicating validity periods. |
AtlasErrorResponse
An error response from the service
Name | Type | Description |
---|---|---|
errorCode |
string |
The error code. |
errorMessage |
string |
The error message. |
requestId |
string |
The request ID. |
AtlasGlossaryHeader
The glossary header with basic information.
Name | Type | Description |
---|---|---|
displayText |
string |
The display text. |
glossaryGuid |
string |
The GUID of the glossary. |
relationGuid |
string |
The GUID of the relationship. |
AtlasGlossaryTerm
The glossary term.
Name | Type | Description |
---|---|---|
abbreviation |
string |
The abbreviation of the term. |
anchor |
The glossary header with basic information. |
|
antonyms |
An array of related term headers as antonyms. |
|
assignedEntities |
An array of related object IDs. |
|
attributes |
object |
The custom attributes of the term, which is map<string,map<string,object>>. The key of the first layer map is term template name. |
categories |
An array of term categorization headers. |
|
classifications |
An array of classifications. |
|
classifies |
An array of related term headers. |
|
contacts |
object |
The dictionary of contacts for terms. Key could be Expert or Steward. |
createTime |
integer |
The created time of the record. |
createdBy |
string |
The user who created the record. |
examples |
string[] |
An array of examples. |
guid |
string |
The GUID of the object. |
hierarchyInfo |
The hierarchy information of the term. |
|
isA |
An array of related term headers indicating the is-a relationship. |
|
lastModifiedTS |
string |
ETag for concurrency control. |
longDescription |
string |
The long version description. |
name |
string |
The name of the glossary object. |
nickName |
string |
The nick name of the term. |
preferredTerms |
An array of preferred related term headers. |
|
preferredToTerms |
An array of related term headers that are preferred to. |
|
qualifiedName |
string |
The qualified name of the glossary object. |
replacedBy |
An array of related term headers that are replaced by. |
|
replacementTerms |
An array of related term headers for replacement. |
|
resources |
An array of resource link for term |
|
seeAlso |
An array of related term headers for see also. |
|
shortDescription |
string |
The short version of description. |
status |
Status of the AtlasGlossaryTerm |
|
synonyms |
An array of related term headers as synonyms. |
|
templateName |
Template |
The name of the template. |
translatedTerms |
An array of translated related term headers. |
|
translationTerms |
An array of related term headers for translation. |
|
updateTime |
integer |
The update time of the record. |
updatedBy |
string |
The user who updated the record. |
usage |
string |
The usage of the term. |
validValues |
An array of related term headers as valid values. |
|
validValuesFor |
An array of related term headers as valid values for other records. |
AtlasRelatedObjectId
Reference to an object-instance of AtlasEntity type used in relationship attribute values
Name | Type | Description |
---|---|---|
displayText |
string |
The display text. |
entityStatus |
Status of the entity - can be active or deleted. Deleted entities are not removed. |
|
guid |
string |
The GUID of the object. |
relationshipAttributes |
Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification. |
|
relationshipGuid |
string |
The GUID of the relationship. |
relationshipStatus |
The enum of relationship status. |
|
relationshipType |
string |
Relationship type |
typeName |
string |
The name of the type. |
uniqueAttributes |
|
The unique attributes of the object. |
AtlasRelatedTermHeader
The header of the related term.
Name | Type | Description |
---|---|---|
description |
string |
The description of the related term. |
displayText |
string |
The display text. |
expression |
string |
The expression of the term. |
relationGuid |
string |
The GUID of the relationship. |
status |
The status of term relationship. |
|
steward |
string |
The steward of the term. |
termGuid |
string |
The GUID of the term. |
AtlasStruct
Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.
Name | Type | Description |
---|---|---|
attributes |
|
The attributes of the struct. |
lastModifiedTS |
string |
ETag for concurrency control. |
typeName |
string |
The name of the type. |
AtlasTermCategorizationHeader
The basic information for term categorization.
Name | Type | Description |
---|---|---|
categoryGuid |
string |
The GUID of the category. |
description |
string |
The description of the record. |
displayText |
string |
The display text. |
relationGuid |
string |
The GUID of the relationship. |
status |
The status of term relationship. |
AtlasTermRelationshipStatus
Status for atlas term relationship
Name | Type | Description |
---|---|---|
ACTIVE |
string |
active |
DEPRECATED |
string |
deprecated |
DRAFT |
string |
draft |
OBSOLETE |
string |
obsolete |
OTHER |
string |
other |
EntityStatus
Status - can be active or deleted
Name | Type | Description |
---|---|---|
ACTIVE |
string |
The status is active. |
DELETED |
string |
The status is deleted. |
PurviewObjectId
PurviewObjectId
Name | Type | Description |
---|---|---|
displayText |
string |
Display text |
guid |
string |
The GUID of the object. |
itemPath |
string |
Item path |
name |
string |
Name |
properties |
|
Dictionary of |
resourceId |
string |
Resource Id |
typeName |
string |
The name of the type. |
uniqueAttributes |
|
The unique attributes of the object. |
ResourceLink
ResourceLink
Name | Type | Description |
---|---|---|
displayName |
string |
Display name for url. |
url |
string |
web url. http or https |
StatusAtlasRelationship
Status for atlas relationship
Name | Type | Description |
---|---|---|
ACTIVE |
string |
active |
DELETED |
string |
deleted |
TermStatus
Status for term
Name | Type | Description |
---|---|---|
Alert |
string |
alert |
Approved |
string |
approved |
Draft |
string |
draft |
Expired |
string |
expired |
TimeBoundary
Captures time-boundary details
Name | Type | Description |
---|---|---|
endTime |
string |
The end of the time boundary. |
startTime |
string |
The start of the time boundary. |
timeZone |
string |
The timezone of the time boundary. |