Share via

Entity - Add Or Update Business Metadata

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

Add business metadata to an entity.

POST {endpoint}/datamap/api/atlas/v2/entity/guid/{guid}/businessmetadata
With optional parameters: 
POST {endpoint}/datamap/api/atlas/v2/entity/guid/{guid}/businessmetadata?isOverwrite={isOverwrite}

URI Parameters

Name In Required Type Description
endpoint
 path True

string

guid
 path True

string

The globally unique identifier of the entity.
isOverwrite
 query

boolean

Whether to overwrite the existing business metadata on the entity or not, default is false.

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_AddOrUpdate_BusinessMetadata

Sample Request

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

{
  "myBizMetadata1": {
    "bizAttr1": "myBizMetaData1.bizAttr1"
  }
}

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.