PurviewGlossaries.GetGlossaryCategory(String, RequestContext) Method

Reference

Definition

Namespace:: Azure.Analytics.Purview.Catalog

Assembly:: Azure.Analytics.Purview.Catalog.dll

Package:: Azure.Analytics.Purview.Catalog v1.0.0-beta.4

Source:: PurviewGlossaries.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Get specific glossary category by its GUID.

public virtual Azure.Response GetGlossaryCategory (string categoryGuid, Azure.RequestContext context = default);

abstract member GetGlossaryCategory : string * Azure.RequestContext -> Azure.Response
override this.GetGlossaryCategory : string * Azure.RequestContext -> Azure.Response

Public Overridable Function GetGlossaryCategory (categoryGuid As String, Optional context As RequestContext = Nothing) As Response

Parameters

categoryGuid: String

The globally unique identifier of the category.

context: RequestContext

The request context, which can override default behaviors on the request on a per-call basis.

Returns

Response

Exceptions

ArgumentNullException

categoryGuid is null.

ArgumentException

categoryGuid is an empty string, and was expected to be non-empty.

Remarks

Schema for Response Body:

{
              classifications: [
                {
                  attributes: Dictionary<string, AnyObject>,
                  typeName: string,
                  lastModifiedTS: string,
                  entityGuid: string,
                  entityStatus: "ACTIVE" | "DELETED",
                  removePropagationsOnEntityDelete: boolean,
                  validityPeriods: [
                    {
                      endTime: string,
                      startTime: string,
                      timeZone: string
                    }
                  ],
                  source: string,
                  sourceDetails: Dictionary<string, AnyObject>
                }
              ],
              longDescription: string,
              name: string,
              qualifiedName: string,
              shortDescription: string,
              lastModifiedTS: string,
              guid: string,
              anchor: {
                displayText: string,
                glossaryGuid: string,
                relationGuid: string
              },
              childrenCategories: [
                {
                  categoryGuid: string,
                  description: string,
                  displayText: string,
                  parentCategoryGuid: string,
                  relationGuid: string
                }
              ],
              parentCategory: AtlasRelatedCategoryHeader,
              terms: [
                {
                  description: string,
                  displayText: string,
                  expression: string,
                  relationGuid: string,
                  source: string,
                  status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER",
                  steward: string,
                  termGuid: string
                }
              ]
            }

Schema for Response Error:

{
              requestId: string,
              errorCode: string,
              errorMessage: string
            }

Applies to

Dela via