Entity - Get By Unique Attributes

Service:

Purview

API Version:

2023-09-01

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:<attrName>=.

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.

GET {endpoint}/datamap/api/atlas/v2/entity/uniqueAttribute/type/{typeName}

With optional parameters:

GET {endpoint}/datamap/api/atlas/v2/entity/uniqueAttribute/type/{typeName}?minExtInfo={minExtInfo}&ignoreRelationships={ignoreRelationships}&attr:qualifiedName={attr:qualifiedName}

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string
typeName	path	True	string	The name of the type.
attr:qualifiedName	query		string	The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes)
ignoreRelationships	query		boolean	Whether to ignore relationship attributes.
minExtInfo	query		boolean	Whether to return minimal information for referred entities.

Responses

Name	Type	Description
200 OK	AtlasEntityWithExtInfo	The request has succeeded.
Other Status Codes	AtlasErrorResponse	An unexpected error response.

Security

OAuth2Auth

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
https://purview.azure.net/.default

Examples

Entity_GetByUniqueAttributes

Sample Request

HTTP

GET {endpoint}/datamap/api/atlas/v2/entity/uniqueAttribute/type/azure_storage_account?minExtInfo=True&attr:qualifiedName=https://exampleaccount.core.windows.net

Sample Response

Status code:

200

{
  "entity": {
    "createTime": 1605703532110,
    "createdBy": "8c062c84-5d25-449f-a990-9d8ab70b8ec7",
    "guid": "e0ba3f20-f3b5-4d52-b769-ed35a02df60a",
    "relationshipAttributes": {
      "services": [],
      "meanings": []
    },
    "status": "ACTIVE",
    "updateTime": 1605703532110,
    "updatedBy": "8c062c84-5d25-449f-a990-9d8ab70b8ec7",
    "lastModifiedTS": "2",
    "version": 0,
    "attributes": {
      "owner": "ExampleOwner",
      "qualifiedName": "https://exampleaccount.core.windows.net",
      "createTime": 0,
      "name": "ExampleNewName"
    },
    "typeName": "azure_storage_account"
  },
  "referredEntities": {}
}

Definitions

Name	Description
AtlasClassification	An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity.
AtlasEntity	An instance of an entity - like hive_table, hive_database.
AtlasEntityWithExtInfo	An instance of an entity along with extended info - like hive_table, hive_database.
AtlasErrorResponse	An error response from the service
AtlasTermAssignmentHeader	The header for term assignment.
AtlasTermAssignmentStatus	Status for term assignment
EntityStatus	Status - can be active or deleted
TimeBoundary	Captures time-boundary details

AtlasClassification

An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity.

Name	Type	Description
attributes		The attributes of the struct.
entityGuid	string	The GUID of the entity.
entityStatus	EntityStatus	Status of the entity - can be active or deleted. Deleted entities are not removed.
lastModifiedTS	string	ETag for concurrency control.
removePropagationsOnEntityDelete	boolean	Determines if propagations will be removed on entity deletion.
typeName	string	The name of the type.
validityPeriods	TimeBoundary[]	An array of time boundaries indicating validity periods.

AtlasEntity

An instance of an entity - like hive_table, hive_database.

Name	Type	Description
attributes		The attributes of the struct.
businessAttributes		Business attributes
classifications	AtlasClassification[]	An array of classifications.
collectionId	string	The collection ID of the entity.
contacts	object	The dictionary of contacts for entities. Key could be Expert or Owner.
createTime	integer	The created time of the record.
createdBy	string	The user who created the record.
customAttributes	object	Custom Attribute
guid	string	The GUID of the entity.
homeId	string	The home ID of the entity.
isIncomplete	boolean	Whether it is a shell entity
labels	string[]	labels
lastModifiedTS	string	ETag for concurrency control.
meanings	AtlasTermAssignmentHeader[]	An array of term assignment headers indicating the meanings of the entity.
provenanceType	integer	Used to record the provenance of an instance of an entity or relationship.
proxy	boolean	Determines if there's a proxy.
relationshipAttributes		The attributes of relationship.
status	EntityStatus	Status of the entity - can be active or deleted. Deleted entities are not removed.
typeName	string	The name of the type.
updateTime	integer	The update time of the record.
updatedBy	string	The user who updated the record.
version	integer	The version of the entity.

AtlasEntityWithExtInfo

An instance of an entity along with extended info - like hive_table, hive_database.

Name	Type	Description
entity	AtlasEntity	An instance of an entity - like hive_table, hive_database.
referredEntities	<string,  AtlasEntity>	The referred entities.

AtlasErrorResponse

An error response from the service

Name	Type	Description
errorCode	string	The error code.
errorMessage	string	The error message.
requestId	string	The request ID.

AtlasTermAssignmentHeader

The header for term assignment.

Name	Type	Description
confidence	integer	The confidence of the term assignment.
createdBy	string	The user who created the record.
description	string	The description of the term assignment.
displayText	string	The display text.
expression	string	The expression of the term assignment.
relationGuid	string	The GUID of the relationship.
status	AtlasTermAssignmentStatus	The status of terms assignment.
steward	string	The steward of the term.
termGuid	string	The GUID of the term.

AtlasTermAssignmentStatus

Status for term assignment

Name	Type	Description
DEPRECATED	string	The status is deprecated.
DISCOVERED	string	The status is discovered.
IMPORTED	string	The status is imported.
OBSOLETE	string	The status is obsolete.
OTHER	string	Other status.
PROPOSED	string	The status is proposed.
VALIDATED	string	The status is validated.

EntityStatus

Status - can be active or deleted

Name	Type	Description
ACTIVE	string	The status is active.
DELETED	string	The status is deleted.

TimeBoundary

Captures time-boundary details

Name	Type	Description
endTime	string	The end of the time boundary.
startTime	string	The start of the time boundary.
timeZone	string	The timezone of the time boundary.