Glossary - List Term Headers
Get term headers belonging to a specific glossary. Recommend using limit/offset to get pagination result.
GET {endpoint}/datamap/api/atlas/v2/glossary/{glossaryId}/terms/headers
GET {endpoint}/datamap/api/atlas/v2/glossary/{glossaryId}/terms/headers?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. |
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_ListTermHeaders
Sample request
GET {endpoint}/datamap/api/atlas/v2/glossary/c018ddaf-7c21-4b37-a838-dae5f110c3d8/terms/headers?limit=-1&offset=0&sort=ASC
Sample response
[
{
"termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea",
"relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0",
"displayText": "ExampleTerm1"
},
{
"termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008",
"relationGuid": "9385640b-e6be-437d-a6b9-62d11c14a189",
"displayText": "ExampleTerm2"
}
]
Definitions
Name | Description |
---|---|
Atlas |
An error response from the service |
Atlas |
The header of the related term. |
Atlas |
Status for atlas term relationship |
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. |
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. |
AtlasTermRelationshipStatus
Status for atlas term relationship
Name | Type | Description |
---|---|---|
ACTIVE |
string |
active |
DEPRECATED |
string |
deprecated |
DRAFT |
string |
draft |
OBSOLETE |
string |
obsolete |
OTHER |
string |
other |