Condividi tramite


PurviewGlossaries.GetRelatedCategories Method

Definition

Get all related categories (parent and children). Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed.

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

Exceptions

categoryGuid is null.

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

Remarks

Schema for Response Body:

{
              categoryGuid: string,
              description: string,
              displayText: string,
              parentCategoryGuid: string,
              relationGuid: string
            }

Schema for Response Error:

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

Applies to