Entity - Get Sample Business Metadata Template

Service:

Purview

API Version:

2023-09-01

Get the sample Template for uploading/creating bulk BusinessMetaData

GET {endpoint}/datamap/api/atlas/v2/entity/businessmetadata/import/template

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string

Responses

Name	Type	Description
200 OK	file	The request has succeeded. Media Types: "application/octet-stream", "application/json"
Other Status Codes	AtlasErrorResponse	An unexpected error response. Media Types: "application/octet-stream", "application/json"

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_GetSampleBusinessMetadataTemplate

Sample request

HTTP

GET {endpoint}/datamap/api/atlas/v2/entity/businessmetadata/import/template

Sample response

Status code:

200

"EntityType,EntityUniqueAttributeValue,BusinessAttributeName,BusinessAttributeValue,EntityUniqueAttributeName[optional]"

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.