Share via

Entity - Add Label

  • Reference
Service:
Purview
API Version:
2023-09-01

Add given labels to a given entity.

PUT {endpoint}/datamap/api/atlas/v2/entity/guid/{guid}/labels

URI Parameters

Name In Required Type Description
endpoint
 path True

string

guid
 path True

string

The globally unique identifier of the entity.

Request Body

Name Type Description
body

string[]

set of labels 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_AddLabel

Sample request

PUT {endpoint}/datamap/api/atlas/v2/entity/guid/02c373fe-2823-4be3-97fa-55180a9faa06/labels

[
  "label1",
  "label2"
]

Sample response

Status code:
204

Definitions

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.