Glossary - List Categories Headers

Reference

Service:: Purview

API Version:: 2023-09-01

Get the category headers belonging to a specific glossary. Recommend using limit/offset to get pagination result.

GET {endpoint}/datamap/api/atlas/v2/glossary/{glossaryId}/categories/headers

With optional parameters:

GET {endpoint}/datamap/api/atlas/v2/glossary/{glossaryId}/categories/headers?limit={limit}&offset={offset}&sort={sort}

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string
glossaryId	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	AtlasRelatedCategoryHeader[]	The request has succeeded.
Other Status Codes	AtlasErrorResponse	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_ListCategoriesHeaders

Sample Request

HTTP

GET {endpoint}/datamap/api/atlas/v2/glossary/c018ddaf-7c21-4b37-a838-dae5f110c3d8/categories/headers?limit=-1&offset=0&sort=ASC

Sample Response

Status code:: 200

[
  {
    "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
    "parentCategoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a",
    "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0",
    "displayText": "ExampleCategory1"
  },
  {
    "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a",
    "relationGuid": "94071e56-fd3e-4441-93ff-1834f818482d",
    "displayText": "ExampleCategory2"
  },
  {
    "categoryGuid": "0d6766f6-f4b6-435b-bda2-d3edc358998e",
    "parentCategoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
    "relationGuid": "26a486a4-a8e2-483c-8a84-3b88e909f8d2",
    "displayText": "ExampleCategory3"
  }
]

Definitions

Name	Description
AtlasErrorResponse	An error response from the service
AtlasRelatedCategoryHeader	The header of the related category.

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.

AtlasRelatedCategoryHeader

The header of the related category.

Name	Type	Description
categoryGuid	string	The GUID of the category.
description	string	The description of the category header.
displayText	string	The display text.
parentCategoryGuid	string	The GUID of the parent category.
relationGuid	string	The GUID of the relationship.

Share via