PurviewEntities.GetByUniqueAttributesAsync 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 complete definition of an entity given its type and unique attribute. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:&lt;attrName>=<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: GET /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.

public virtual System.Threading.Tasks.Task<Azure.Response> GetByUniqueAttributesAsync (string typeName, bool? minExtInfo = default, bool? ignoreRelationships = default, string attrQualifiedName = default, Azure.RequestContext context = default);

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

Public Overridable Function GetByUniqueAttributesAsync (typeName As String, Optional minExtInfo As Nullable(Of Boolean) = Nothing, Optional ignoreRelationships As Nullable(Of Boolean) = Nothing, Optional attrQualifiedName As String = Nothing, Optional context As RequestContext = Nothing) As Task(Of Response)

Parameters

typeName

String

The name of the type.

minExtInfo

Nullable<Boolean>

Whether to return minimal information for referred entities.

ignoreRelationships

Nullable<Boolean>

Whether to ignore relationship attributes.

attrQualifiedName

String

The qualified name 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

typeName is null.

ArgumentException

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

Remarks

Schema for Response Body:

{
              referredEntities: Dictionary<string, AtlasEntity>,
              entity: {
                attributes: Dictionary<string, AnyObject>,
                typeName: string,
                lastModifiedTS: string,
                businessAttributes: Dictionary<string, AnyObject>,
                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>
                  }
                ],
                createTime: number,
                createdBy: string,
                customAttributes: Dictionary<string, string>,
                guid: string,
                homeId: string,
                isIncomplete: boolean,
                labels: [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
                  }
                ],
                provenanceType: number,
                proxy: boolean,
                relationshipAttributes: Dictionary<string, AnyObject>,
                status: "ACTIVE" | "DELETED",
                updateTime: number,
                updatedBy: string,
                version: number,
                source: string,
                sourceDetails: Dictionary<string, AnyObject>,
                contacts: Dictionary<string, ContactBasic[]>
              }
            }

Schema for Response Error:

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