Entity - Delete By Unique Attribute

Service:: Purview

API Version:: 2023-09-01

Delete an entity identified by its type and unique attributes. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:<attrName>=<attrValue>. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName.

The REST request would look something like this: DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.

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

With optional parameters:

DELETE {endpoint}/datamap/api/atlas/v2/entity/uniqueAttribute/type/{typeName}?attr:qualifiedName={attr:qualifiedName}

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string (uri)
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)

Responses

Name	Type	Description
200 OK	EntityMutationResult	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_DeleteByUniqueAttribute

Sample request

HTTP

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

Sample response

Status code:: 200

{
  "mutatedEntities": {
    "DELETE": [
      {
        "classificationNames": [],
        "displayText": "Example Name",
        "guid": "e0ba3f20-f3b5-4d52-b769-ed35a02df60a",
        "meaningNames": [],
        "meanings": [],
        "status": "ACTIVE",
        "lastModifiedTS": "1",
        "attributes": {
          "owner": "ExampleOwner",
          "createTime": 0,
          "qualifiedName": "https://exampleaccount.core.windows.net",
          "name": "ExampleName"
        },
        "typeName": "azure_storage_account"
      }
    ]
  }
}

Definitions

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

AtlasClassification

Object

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.

AtlasEntityHeader

Object

An instance of an entity - like hive_table, hive_database.

Name	Type	Description
attributes		The attributes of the struct.
classificationNames	string[]	An array of classification names.
classifications	AtlasClassification[]	An array of classifications.
displayText	string	The display text.
guid	string	The GUID of the record.
isIncomplete	boolean	Whether it is a shell entity
labels	string[]	labels
lastModifiedTS	string	ETag for concurrency control.
meaningNames	string[]	An array of meanings.
meanings	AtlasTermAssignmentHeader[]	An array of term assignment headers.
status	EntityStatus	Status of the entity - can be active or deleted. Deleted entities are not removed.
typeName	string	The name of the type.

AtlasErrorResponse

Object

An error response from the service

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

AtlasTermAssignmentHeader

Object

The header for term assignment.

Name	Type	Description
confidence	integer (int32)	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 (uuid)	The GUID of the relationship.
status	AtlasTermAssignmentStatus	The status of terms assignment.
steward	string	The steward of the term.
termGuid	string (uuid)	The GUID of the term.

AtlasTermAssignmentStatus

Enumeration

Status for term assignment

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

EntityMutationResult

Object

The mutation response result of entity.

Name	Type	Description
guidAssignments	object	A map of GUID assignments with entities.
mutatedEntities	object	The entity headers of mutated entities.
partialUpdatedEntities	AtlasEntityHeader[]	An array of entity headers that partially updated.

EntityStatus

Enumeration

Status - can be active or deleted

Value	Description
ACTIVE	The status is active.
DELETED	The status is deleted.

TimeBoundary

Object

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.