Glossary - List Related Terms
Get all related terms for a specific term by its GUID. Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed.
GET {endpoint}/datamap/api/atlas/v2/glossary/terms/{termId}/related
GET {endpoint}/datamap/api/atlas/v2/glossary/terms/{termId}/related?api-version=2023-09-01&limit={limit}&offset={offset}&sort={sort}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
endpoint
|
path | True |
string |
|
term
|
path | True |
string |
The globally unique identifier for glossary term. |
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_ListRelatedTerms
Sample request
GET {endpoint}/datamap/api/atlas/v2/glossary/terms/54688d39-b298-4104-9e80-f2a16f44aaea/related?api-version=2023-09-01&limit=-1&offset=0&sort=ASC
Sample response
{
"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"
}
]
}
Definitions
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. |