PurviewEntities.GetHeaderAsync(String, RequestContext) Method

Definition

Namespace:

Azure.Analytics.Purview.Catalog

Assembly:

Azure.Analytics.Purview.Catalog.dll

Package:

Azure.Analytics.Purview.Catalog v1.0.0-beta.4

Source:

PurviewEntities.cs

Get entity header given its GUID.

public virtual System.Threading.Tasks.Task<Azure.Response> GetHeaderAsync (string guid, Azure.RequestContext context = default);

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

Public Overridable Function GetHeaderAsync (guid As String, Optional context As RequestContext = Nothing) As Task(Of Response)

Parameters

guid

String

The globally unique identifier of the entity.

context

RequestContext

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

Returns

Task<Response>

Exceptions

ArgumentNullException

guid is null.

ArgumentException

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

Remarks

Schema for Response Body:

{
              attributes: Dictionary<string, AnyObject>,
              typeName: string,
              lastModifiedTS: string,
              classificationNames: [string],
              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>
                }
              ],
              displayText: string,
              guid: string,
              isIncomplete: boolean,
              labels: [string],
              meaningNames: [string],
              meanings: [
                {
                  confidence: number,
                  createdBy: string,
                  description: string,
                  displayText: string,
                  expression: string,
                  relationGuid: string,
                  source: string,
                  status: "DISCOVERED" | "PROPOSED" | "IMPORTED" | "VALIDATED" | "DEPRECATED" | "OBSOLETE" | "OTHER",
                  steward: string,
                  termGuid: string
                }
              ],
              status: "ACTIVE" | "DELETED"
            }

Schema for Response Error:

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