PurviewGlossaries.GetDetailedGlossaryAsync Method

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

Get a specific glossary with detailed information.

public virtual System.Threading.Tasks.Task<Azure.Response> GetDetailedGlossaryAsync (string glossaryGuid, bool? includeTermHierarchy = default, Azure.RequestContext context = default);

abstract member GetDetailedGlossaryAsync : string * Nullable<bool> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetDetailedGlossaryAsync : string * Nullable<bool> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function GetDetailedGlossaryAsync (glossaryGuid As String, Optional includeTermHierarchy As Nullable(Of Boolean) = Nothing, Optional context As RequestContext = Nothing) As Task(Of Response)

Parameters

glossaryGuid

String

The globally unique identifier for glossary.

includeTermHierarchy

Nullable<Boolean>

Whether include term hierarchy.

context

RequestContext

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

Returns

Task<Response>

Exceptions

ArgumentNullException

glossaryGuid is null.

ArgumentException

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

Remarks

Schema for Response Body:

{
              categories: [
                {
                  categoryGuid: string,
                  description: string,
                  displayText: string,
                  parentCategoryGuid: string,
                  relationGuid: string
                }
              ],
              language: string,
              terms: [
                {
                  description: string,
                  displayText: string,
                  expression: string,
                  relationGuid: string,
                  source: string,
                  status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER",
                  steward: string,
                  termGuid: string
                }
              ],
              usage: string,
              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,
              categoryInfo: Dictionary<string, AtlasGlossaryCategory>,
              termInfo: Dictionary<string, AtlasGlossaryTerm>
            }

Schema for Response Error:

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