PurviewTypes.GetTypeDefinitionHeaders 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:: PurviewTypes.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.

List all type definitions returned as a list of minimal information header.

public virtual Azure.Response GetTypeDefinitionHeaders (bool? includeTermTemplate = default, string type = default, Azure.RequestContext context = default);

abstract member GetTypeDefinitionHeaders : Nullable<bool> * string * Azure.RequestContext -> Azure.Response
override this.GetTypeDefinitionHeaders : Nullable<bool> * string * Azure.RequestContext -> Azure.Response

Public Overridable Function GetTypeDefinitionHeaders (Optional includeTermTemplate As Nullable(Of Boolean) = Nothing, Optional type As String = Nothing, Optional context As RequestContext = Nothing) As Response

Parameters

includeTermTemplate: Nullable<Boolean>

Whether include termtemplatedef when return all typedefs. This is always true when search filter type=term_template

type: String

context: RequestContext

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

Returns

Response

Remarks

Schema for Response Body:

{
              category: "PRIMITIVE" | "OBJECT_ID_TYPE" | "ENUM" | "STRUCT" | "CLASSIFICATION" | "ENTITY" | "ARRAY" | "MAP" | "RELATIONSHIP" | "TERM_TEMPLATE",
              guid: string,
              name: string
            }

Schema for Response Error:

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

Applies to

Share via