Glossary - List Related Categories
Get all related categories (parent and children). 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/category/{categoryId}/related
GET {endpoint}/datamap/api/atlas/v2/glossary/category/{categoryId}/related?limit={limit}&offset={offset}&sort={sort}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
category
|
path | True |
string |
The globally unique identifier of the category. |
endpoint
|
path | True |
string |
|
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_ListRelatedCategories
Sample request
GET {endpoint}/datamap/api/atlas/v2/glossary/category/ed7458f0-9463-48a5-b5c6-4f785fb34e12/related?limit=-1&offset=0&sort=ASC
Sample response
{
"parent": [
{
"categoryGuid": "6c8233cd-f6dc-6ef7-5597-b18ab590f2fc",
"relationGuid": "25cf5e46-c551-4ed4-8919-505c29ae311d"
}
],
"children": [
{
"categoryGuid": "abc6ac1b-5700-9c70-3f5a-60a519150035",
"parentCategoryGuid": "3243ea0a-9492-47e1-392e-a84e64980af9",
"relationGuid": "12d41563-2fd9-4be5-9eb9-9908f811a8f2",
"displayText": "ExampleCategory4"
}
]
}
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. |