Glossary - List Category Terms

Reference

Service:: Purview

API Version:: 2023-09-01

Get all terms associated with the specific category.

GET {endpoint}/datamap/api/atlas/v2/glossary/category/{categoryId}/terms

With optional parameters:

GET {endpoint}/datamap/api/atlas/v2/glossary/category/{categoryId}/terms?limit={limit}&offset={offset}&sort={sort}

URI Parameters

Name	In	Required	Type	Description
categoryId	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	AtlasRelatedTermHeader[]	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_ListCategoryTerms

Sample Request

HTTP

GET {endpoint}/datamap/api/atlas/v2/glossary/category/ed7458f0-9463-48a5-b5c6-4f785fb34e12/terms?limit=-1&offset=0&sort=ASC

Sample Response

Status code:: 200

[
  {
    "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea",
    "relationGuid": "6aebf5ac-0c83-40c0-98bf-958fe9c99007",
    "displayText": "ExampleTerm1"
  }
]

Definitions

Name	Description
AtlasErrorResponse	An error response from the service
AtlasRelatedTermHeader	The header of the related term.
AtlasTermRelationshipStatus	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	AtlasTermRelationshipStatus	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

Share via