Entity - Import Business Metadata

Reference

Service:: Purview

API Version:: 2023-09-01

Upload the file for creating Business Metadata in BULK

POST {endpoint}/datamap/api/atlas/v2/entity/businessmetadata/import

URI Parameters

Name	In	Required	Type	Description
file	formData	True	file	InputStream of file
endpoint	path	True	string

Responses

Name	Type	Description
200 OK	BulkImportResult	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_ImportBusinessMetadata

Sample Request

HTTP

POST {endpoint}/datamap/api/atlas/v2/entity/businessmetadata/import

Sample Response

Status code:: 200

{
  "successImportInfoList": [
    {
      "parentObjectName": "24a77100-1b3a-4c37-884e-7d4f591f5a64",
      "childObjectName": "{myBizType1={bizAttr1=Awesome Attribute 1}}",
      "importStatus": "SUCCESS",
      "remarks": ""
    }
  ]
}

Definitions

Name	Description
AtlasErrorResponse	An error response from the service
BulkImportResult	Bulk import result
ImportInfo	ImportInfo
ImportStatus	Status for import

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.

BulkImportResult

Bulk import result

Name	Type	Description
failedImportInfoList	ImportInfo[]	failed importInfoList
successImportInfoList	ImportInfo[]	successful importInfoList

ImportInfo

Name	Type	Description
childObjectName	string	childObjectName
importStatus	ImportStatus	importStatus
parentObjectName	string	parentObjectName
remarks	string	remarks

ImportStatus

Status for import

Name	Type	Description
FAILED	string	Failed
SUCCESS	string	Success

Share via