Skip to content

pvw glossary readDetailed

Command Reference > glossary > readDetailed

Description

Retrieve glossary term or category.

Syntax

pvw glossary readDetailed --glossaryGuid=<val> [--includeTermHierarchy]

Required Arguments

  • --glossaryGuid: glossaryGuid parameter

Optional Arguments

  • --purviewName: Microsoft Purview account name. (string)
  • --categoryGuid: The globally unique identifier of the category. (string)
  • --glossaryName: The name of the glossary. (string)
  • --limit: The page size - by default there is no paging [default: 1000]. (integer)
  • --offset: Offset for pagination purpose [default: 0]. (integer)
  • --operationGuid: The globally unique identifier for async operation/job. (string)
  • --payloadFile: File path to a valid JSON document. (string)
  • --sort: ASC or DESC [default: ASC]. (string)
  • --termGuid: The globally unique identifier for glossary term. (string)

API Mapping

Catalog Data Plane > Glossary > Readdetailed 

 https://{accountName}.purview.azure.com/catalog/api/atlas/v2/glossary/readDetailed

Examples

DESCRIBE_EXAMPLE. 

EXAMPLE_COMMAND

Example payload. 

PASTE_JSON_HERE