PurviewGlossaries.GetCategoryTermsAsync 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 terms associated with the specific category.

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

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

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

Parameters

categoryGuid: String

The globally unique identifier of the category.

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.

context: RequestContext

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

Returns

Task<Response>

Exceptions

ArgumentNullException

categoryGuid is null.

ArgumentException

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

Remarks

Schema for Response Body:

{
              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