PurviewGlossaries.GetGlossaryTermHeaders Method

Definition

Get term headers belonging to a specific glossary.

public virtual Azure.Response GetGlossaryTermHeaders (string glossaryGuid, int? limit = default, int? offset = default, string sort = default, Azure.RequestContext context = default);
abstract member GetGlossaryTermHeaders : string * Nullable<int> * Nullable<int> * string * Azure.RequestContext -> Azure.Response
override this.GetGlossaryTermHeaders : string * Nullable<int> * Nullable<int> * string * Azure.RequestContext -> Azure.Response
Public Overridable Function GetGlossaryTermHeaders (glossaryGuid 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 Response

Parameters

glossaryGuid
String

The globally unique identifier for glossary.

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

Response

Exceptions

glossaryGuid is null.

glossaryGuid 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