PurviewEntities.GetHeader(String, RequestContext) 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:: PurviewEntities.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 entity header given its GUID.

public virtual Azure.Response GetHeader (string guid, Azure.RequestContext context = default);

abstract member GetHeader : string * Azure.RequestContext -> Azure.Response
override this.GetHeader : string * Azure.RequestContext -> Azure.Response

Public Overridable Function GetHeader (guid As String, Optional context As RequestContext = Nothing) As 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

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
            }

Applies to

Share via