PurviewGlossaries.GetGlossariesAsync 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 all glossaries registered with Atlas.

public virtual System.Threading.Tasks.Task<Azure.Response> GetGlossariesAsync (int? limit = default, int? offset = default, string sort = default, bool? ignoreTermsAndCategories = default, Azure.RequestContext context = default);

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

Public Overridable Function GetGlossariesAsync (Optional limit As Nullable(Of Integer) = Nothing, Optional offset As Nullable(Of Integer) = Nothing, Optional sort As String = Nothing, Optional ignoreTermsAndCategories As Nullable(Of Boolean) = Nothing, Optional context As RequestContext = Nothing) As Task(Of Response)

Parameters

limit: Nullable<Int32>

The page size - by default there is no paging.

offset: Nullable<Int32>

The offset for pagination purpose.

sort: String

The sort order, ASC (default) or DESC.

ignoreTermsAndCategories: Nullable<Boolean>

Whether ignore terms and categories.

context: RequestContext

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

Returns

Task<Response>

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,
              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
            }

Schema for Response Error:

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

Applies to

Dela via