Entity - Add Classifications By Unique Attribute

Reference

Service:: Purview

API Version:: 2023-09-01

Add classification to the entity identified by its type and unique attributes.

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

With optional parameters:

POST {endpoint}/datamap/api/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications?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)

Request Body

Name	Type	Description
body	AtlasClassification[]	An array of classification to be added.

Responses

Name	Type	Description
204 No Content		There is no content to send for this request, but the headers may be useful.
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_AddClassificationsByUniqueAttribute

Sample request

HTTP

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

[
  {
    "typeName": "MICROSOFT.FINANCIAL.US.ABA_ROUTING_NUMBER"
  },
  {
    "typeName": "MICROSOFT.FINANCIAL.CREDIT_CARD_NUMBER"
  }
]

Sample response

Status code:: 204

Definitions

Name	Description
AtlasClassification	An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity.
AtlasErrorResponse	An error response from the service
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.

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.

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.

Share via