Azure Purview Data Map is a data governance solution that helps organizations discover, classify, and manage all their data assets across on-premises, multicloud, and SaaS environments. The Data Map allows users to create a holistic view of their data landscape, including structured and unstructured data, so they can understand where their data resides, who has access to it, and how it is being used.
swagger: '2.0'
info:
title: Microsoft Azure Azure Analytics Purview Data Map
version: '2023-09-01'
description: >-
Purview Data Map Service is a fully managed cloud service whose users can
discover the data sources they need and understand the data sources they
find.
At the same time, Data Map helps organizations get more value from their
existing investments. This spec defines REST API of Purview Data Map
Service.
x-typespec-generated:
- emitter: '@azure-tools/typespec-autorest'
schemes:
- https
x-ms-parameterized-host:
hostTemplate: '{endpoint}/datamap/api'
useSchemePrefix: false
parameters:
- name: endpoint
in: path
required: true
type: string
produces:
- application/json
consumes:
- application/json
security:
- OAuth2Auth:
- https://purview.azure.net/.default
securityDefinitions:
OAuth2Auth:
type: oauth2
flow: implicit
authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
scopes:
https://purview.azure.net/.default: ''
tags:
- name: Atlas
- name: Entity
- name: Lineage
- name: Search
- name: Types
paths:
/atlas/v2/entity:
post:
operationId: microsoftAzureEntityCreateorupdate
description: >-
Create or update an entity.<br>Existing entity is matched using its
unique guid if<br>supplied or by its unique attributes eg:
qualifiedName.<br>Map and array of<br>collections are not well
supported. E.g., array>, array>.<br>For each contact type, the maximum
number of contacts is 20.
parameters:
- $ref: '#/parameters/AtlasApiVersionParameter'
- name: businessAttributeUpdateBehavior
in: query
description: >-
Used to define the update behavior for business attributes when
updating
entities.
required: false
type: string
enum:
- ignore
- replace
- merge
x-ms-enum:
name: BusinessAttributeUpdateBehavior
modelAsString: true
values:
- name: Ignore
value: ignore
description: Ignore the business attribute payload for update.
- name: Replace
value: replace
description: Replace all the business attributes using the payload.
- name: Merge
value: merge
description: >-
Merge the business attributes. Business attributes will not be
updated if not provided.
- name: collectionId
in: query
description: >-
The collection where entities will be moved to. Only specify a value
if you
need to move an entity to another collection.
required: false
type: string
- name: body
in: body
required: true
schema:
$ref: '#/definitions/AtlasEntityWithExtInfo'
responses:
'200':
description: The request has succeeded.
schema:
$ref: '#/definitions/EntityMutationResult'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/AtlasErrorResponse'
x-ms-examples:
Entity_AddCustomAttribute:
$ref: ./examples/Entity_AddCustomAttribute.json
Entity_Create:
$ref: ./examples/Entity_Create.json
Entity_Update:
$ref: ./examples/Entity_Update.json
summary: Microsoft Azure Post Atlas Entity
tags:
- Atlas
/atlas/v2/entity/bulk:
get:
operationId: microsoftAzureEntityListbyguids
description: List entities in bulk identified by its GUIDs.
parameters:
- $ref: '#/parameters/AtlasApiVersionParameter'
- name: guid
in: query
description: An array of GUIDs of entities to list.
required: true
type: array
items:
type: string
collectionFormat: multi
- name: minExtInfo
in: query
description: Whether to return minimal information for referred entities.
required: false
type: boolean
- name: ignoreRelationships
in: query
description: Whether to ignore relationship attributes.
required: false
type: boolean
responses:
'200':
description: The request has succeeded.
schema:
$ref: '#/definitions/AtlasEntitiesWithExtInfo'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/AtlasErrorResponse'
x-ms-examples:
Entity_ListByGuids:
$ref: ./examples/Entity_ListByGuids.json
summary: Microsoft Azure Get Atlas Entity Bulk
tags:
- Atlas
post:
operationId: microsoftAzureEntityBulkcreateorupdate
description: >-
Create or update entities in bulk.<br>Existing entity is matched using
its unique<br>guid if supplied or by its unique attributes eg:
qualifiedName.<br>Map and array<br>of collections are not well
supported. E.g., array>,<br>array>.<br>For each contact type, the
maximum number of contacts<br>is 20.
parameters:
- $ref: '#/parameters/AtlasApiVersionParameter'
- name: collectionId
in: query
description: >-
The collection where entities will be moved to. Only specify a value
if you
need to move an entity to another collection.
required: false
type: string
- name: businessAttributeUpdateBehavior
in: query
description: >-
Used to define the update behavior for business attributes when
updating
entities.
required: false
type: string
enum:
- ignore
- replace
- merge
x-ms-enum:
name: BusinessAttributeUpdateBehavior
modelAsString: true
values:
- name: Ignore
value: ignore
description: Ignore the business attribute payload for update.
- name: Replace
value: replace
description: Replace all the business attributes using the payload.
- name: Merge
value: merge
description: >-
Merge the business attributes. Business attributes will not be
updated if not provided.
- name: body
in: body
required: true
schema:
$ref: '#/definitions/AtlasEntitiesWithExtInfo'
responses:
'200':
description: The request has succeeded.
schema:
$ref: '#/definitions/EntityMutationResult'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/AtlasErrorResponse'
x-ms-examples:
Entity_BulkCreateOrUpdate:
$ref: ./examples/Entity_BulkCreateOrUpdate.json
summary: Microsoft Azure Post Atlas Entity Bulk
tags:
- Atlas
delete:
operationId: microsoftAzureEntityBulkdelete
description: >-
Delete a list of entities in bulk identified by their GUIDs or
unique<br>attributes.
parameters:
- name: guid
in: query
description: An array of GUIDs of entities to delete.
required: true
type: array
items:
type: string
collectionFormat: multi
responses:
'200':
description: The request has succeeded.
schema:
$ref: '#/definitions/EntityMutationResult'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/AtlasErrorResponse'
x-ms-examples:
Entity_BulkDelete:
$ref: ./examples/Entity_BulkDelete.json
summary: Microsoft Azure Delete Atlas Entity Bulk
tags:
- Atlas
/atlas/v2/entity/bulk/classification:
post:
operationId: microsoftAzureEntityAddclassification
description: Associate a classification to multiple entities in bulk.
parameters:
- name: body
in: body
required: true
schema:
$ref: '#/definitions/ClassificationAssociateOptions'
responses:
'204':
description: >-
There is no content to send for this request, but the headers may be
useful.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/AtlasErrorResponse'
x-ms-examples:
Entity_AddClassificationToEntityByGuids:
$ref: ./examples/Entity_AddClassificationToEntityByGuids.json
summary: Microsoft Azure Post Atlas Entity Bulk Classification
tags:
- Atlas
/atlas/v2/entity/bulk/setClassifications:
post:
operationId: microsoftAzureEntityBulksetclassifications
description: Set classifications on entities in bulk.
parameters:
- name: body
in: body
required: true
schema:
$ref: '#/definitions/AtlasEntityHeaders'
responses:
'200':
description: The request has succeeded.
schema:
type: array
items:
type: string
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/AtlasErrorResponse'
x-ms-examples:
Entity_BulkSetClassifications:
$ref: ./examples/Entity_BulkSetClassifications.json
summary: Microsoft Azure Post Atlas Entity Bulk Setclassifications
tags:
- Atlas
/atlas/v2/entity/bulk/uniqueAttribute/type/{typeName}:
get:
operationId: microsoftAzureEntityListbyuniqueattributes
description: >-
Bulk API to retrieve list of entities identified by its unique
attributes.<br>In<br>addition to the typeName path parameter, attribute
key-value pair(s) can be<br>provided in the
following<br>format<br><br>typeName=\&attr_1:\=\&attr_2:\=\&attr_3:\=\<br><br>NOTE:<br>The
attrName should be an unique attribute for the given entity-type.<br>The
REST<br>request would look something like
this<br><br>GET<br>/v2/entity/bulk/uniqueAttribute/type/hive_db?attr_1:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1<br><br>Note:<br>at
least one unique attribute must be provided.
parameters:
- name: typeName
in: path
description: The name of the type.
required: true
type: string
- name: minExtInfo
in: query
description: Whether to return minimal information for referred entities.
required: false
type: boolean
- name: ignoreRelationships
in: query
description: Whether to ignore relationship attributes.
required: false
type: boolean
- name: attr_N:qualifiedName
in: query
description: >-
Qualified name of an entity. E.g. to find 2 entities you can set
attrs_1:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1. (This
is only an
example. qualifiedName can be changed to other unique attributes)
required: false
type: string
responses:
'200':
description: The request has succeeded.
schema:
$ref: '#/definitions/AtlasEntitiesWithExtInfo'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/AtlasErrorResponse'
x-ms-examples:
Entity_ListByUniqueAttributes:
$ref: ./examples/Entity_ListByUniqueAttributes.json
summary: Microsoft Azure Get Atlas Entity Bulk Uniqueattribute Type Typename
tags:
- Atlas
/atlas/v2/entity/businessmetadata/import:
post:
operationId: microsoftAzureEntityImportbusinessmetadata
description: Upload the file for creating Business Metadata in BULK
consumes:
- multipart/form-data
parameters:
- $ref: '#/parameters/BusinessMetadataOptions'
responses:
'200':
description: The request has succeeded.
schema:
$ref: '#/definitions/BulkImportResult'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/AtlasErrorResponse'
x-ms-examples:
Entity_ImportBusinessMetadata:
$ref: ./examples/Entity_ImportBusinessMetadata.json
summary: Microsoft Azure Post Atlas Entity Businessmetadata Import
tags:
- Atlas
/atlas/v2/entity/businessmetadata/import/template:
get:
operationId: microsoftAzureEntityGetsamplebusinessmetadatatemplate
description: Get the sample Template for uploading/creating bulk BusinessMetaData
produces:
- application/octet-stream
- application/json
parameters: []
responses:
'200':
description: The request has succeeded.
schema:
type: file
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/AtlasErrorResponse'
x-ms-examples:
Entity_GetSampleBusinessMetadataTemplate:
$ref: ./examples/Entity_GetSampleBusinessMetadataTemplate.json
summary: Microsoft Azure Get Atlas Entity Businessmetadata Import Template
tags:
- Atlas
/atlas/v2/entity/guid/{guid}:
get:
operationId: microsoftAzureEntityGet
description: Get complete definition of an entity given its GUID.
parameters:
- name: guid
in: path
description: The globally unique identifier of the entity.
required: true
type: string
- name: minExtInfo
in: query
description: Whether to return minimal information for referred entities.
required: false
type: boolean
- name: ignoreRelationships
in: query
description: Whether to ignore relationship attributes.
required: false
type: boolean
responses:
'200':
description: The request has succeeded.
schema:
$ref: '#/definitions/AtlasEntityWithExtInfo'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/AtlasErrorResponse'
x-ms-examples:
Entity_Get:
$ref: ./examples/Entity_Get.json
summary: Microsoft Azure Get Atlas Entity Guid Guid
tags:
- Atlas
put:
operationId: microsoftAzureEntityPartialupdateattributebyguid
description: >-
Update entity partially - create or update entity attribute identified
by its<br>GUID.<br>Supports only primitive attribute type and entity
references.<br>It does not support updating complex types like arrays,
and maps.<br>Null updates are not possible.
parameters:
- name: guid
in: path
description: The globally unique identifier of the entity.
required: true
type: string
- name: name
in: query
description: The name of the attribute.
required: true
type: string
- name: body
in: body
description: The value of the attribute.
required: true
schema: {}
responses:
'200':
description: The request has succeeded.
schema:
$ref: '#/definitions/EntityMutationResult'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/AtlasErrorResponse'
x-ms-examples:
Entity_PartialUpdateAttributeByGuid:
$ref: ./examples/Entity_PartialUpdateAttributeByGuid.json
summary: Microsoft Azure Put Atlas Entity Guid Guid
tags:
- Atlas
delete:
operationId: microsoftAzureEntityDelete
description: Delete an entity identified by its GUID.
parameters:
- name: guid
in: path
description: The globally unique identifier of the entity.
required: true
type: string
responses:
'200':
description: The request has succeeded.
schema:
$ref: '#/definitions/EntityMutationResult'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/AtlasErrorResponse'
x-ms-examples:
Entity_Delete:
$ref: ./examples/Entity_Delete.json
summary: Microsoft Azure Delete Atlas Entity Guid Guid
tags:
- Atlas
/atlas/v2/entity/guid/{guid}/businessmetadata:
post:
operationId: microsoftAzureEntityAddorupdatebusinessmetadata
description: Add business metadata to an entity.
parameters:
- name: guid
in: path
description: The globally unique identifier of the entity.
required: true
type: string
- name: isOverwrite
in: query
description: >-
Whether to overwrite the existing business metadata on the entity or
not,
default is false.
required: false
type: boolean
x-ms-client-name: overwrite
- name: body
in: body
description: BusinessMetadata payload
required: true
schema:
type: object
additionalProperties:
additionalProperties: {}
type: object
responses:
'204':
description: >-
There is no content to send for this request, but the headers may be
useful.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/AtlasErrorResponse'
x-ms-examples:
Entity_AddOrUpdate_BusinessMetadata:
$ref: ./examples/Entity_AddOrUpdate_BusinessMetadata.json
summary: Microsoft Azure Post Atlas Entity Guid Guid Businessmetadata
tags:
- Atlas
delete:
operationId: microsoftAzureEntityRemovebusinessmetadata
description: Remove business metadata from an entity.
parameters:
- name: guid
in: path
description: The globally unique identifier of the entity.
required: true
type: string
- name: body
in: body
description: Business metadata payload
required: true
schema:
type: object
additionalProperties:
additionalProperties: {}
type: object
responses:
'204':
description: >-
There is no content to send for this request, but the headers may be
useful.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/AtlasErrorResponse'
x-ms-examples:
Entity_RemoveBusinessMetadata:
$ref: ./examples/Entity_RemoveBusinessMetadata.json
summary: Microsoft Azure Delete Atlas Entity Guid Guid Businessmetadata
tags:
- Atlas
/atlas/v2/entity/guid/{guid}/businessmetadata/{businessMetadataName}:
post:
operationId: microsoftAzureEntityAddorupdatebusinessmetadataattributes
description: Add or update business metadata attributes.
parameters:
- name: businessMetadataName
in: path
description: BusinessMetadata name
required: true
type: string
- name: guid
in: path
description: The globally unique identifier of the entity.
required: true
type: string
- name: body
in: body
description: Business metadata attribute payload
required: true
schema:
type: object
additionalProperties: {}
responses:
'204':
description: >-
There is no content to send for this request, but the headers may be
useful.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/AtlasErrorResponse'
x-ms-examples:
Entity_AddOrUpdate_BusinessAttribute:
$ref: ./examples/Entity_AddOrUpdate_BusinessAttribute.json
summary: Microsoft Azure Post Atlas Entity Guid Guid Businessmetadata Businessmetadataname
tags:
- Atlas
delete:
operationId: microsoftAzureEntityRemovebusinessmetadataattributes
description: Delete business metadata attributes from an entity.
parameters:
- name: businessMetadataName
in: path
description: BusinessMetadata name
required: true
type: string
- name: guid
in: path
description: The globally unique identifier of the entity.
required: true
type: string
- name: body
in: body
description: Business metadata attribute payload
required: true
schema:
type: object
additionalProperties: {}
responses:
'204':
description: >-
There is no content to send for this request, but the headers may be
useful.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/AtlasErrorResponse'
x-ms-examples:
Entity_RemoveBusinessAttribute:
$ref: ./examples/Entity_RemoveBusinessAttribute.json
summary: Microsoft Azure Delete Atlas Entity Guid Guid Businessmetadata Businessmetadataname
tags:
- Atlas
/atlas/v2/entity/guid/{guid}/classification/{classificationName}:
get:
operationId: microsoftAzureEntityGetclassification
description: Get classification for a given entity represented by a GUID.
parameters:
- name: guid
in: path
description: The globally unique identifier of the entity.
required: true
type: string
- name: classificationName
in: path
description: The name of the classification.
required: true
type: string
responses:
'200':
description: The request has succeeded.
schema:
$ref: '#/definitions/AtlasClassification'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/AtlasErrorResponse'
x-ms-examples:
Entity_GetClassification:
$ref: ./examples/Entity_GetClassification.json
summary: Microsoft Azure Get Atlas Entity Guid Guid Classification Classificationname
tags:
- Atlas
delete:
operationId: microsoftAzureEntityRemoveclassification
description: >-
Delete a given classification from an existing entity represented by a
GUID.
parameters:
- name: guid
in: path
description: The globally unique identifier of the entity.
required: true
type: string
- name: classificationName
in: path
description: The name of the classification.
required: true
type: string
responses:
'204':
description: >-
There is no content to send for this request, but the headers may be
useful.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/AtlasErrorResponse'
x-ms-examples:
Entity_RemoveClassification:
$ref: ./examples/Entity_RemoveClassification.json
summary: Microsoft Azure Delete Atlas Entity Guid Guid Classification Classificationname
tags:
- Atlas
/atlas/v2/entity/guid/{guid}/classifications:
get:
operationId: microsoftAzureEntityGetclassifications
description: List classifications for a given entity represented by a GUID.
parameters:
- name: guid
in: path
description: The globally unique identifier of the entity.
required: true
type: string
responses:
'200':
description: The request has succeeded.
schema:
$ref: '#/definitions/AtlasClassifications'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/AtlasErrorResponse'
x-ms-examples:
Entity_GetClassifications:
$ref: ./examples/Entity_GetClassifications.json
summary: Microsoft Azure Get Atlas Entity Guid Guid Classifications
tags:
- Atlas
put:
operationId: microsoftAzureEntityUpdateclassifications
description: Update classifications to an existing entity represented by a guid.
parameters:
- name: guid
in: path
description: The globally unique identifier of the entity.
required: true
type: string
- name: body
in: body
description: An array of classifications to be updated.
required: true
schema:
type: array
items:
$ref: '#/definitions/AtlasClassification'
x-ms-identifiers: []
responses:
'204':
description: >-
There is no content to send for this request, but the headers may be
useful.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/AtlasErrorResponse'
x-ms-examples:
Entity_UpdateClassifications:
$ref: ./examples/Entity_UpdateClassifications.json
summary: Microsoft Azure Put Atlas Entity Guid Guid Classifications
tags:
- Atlas
post:
operationId: microsoftAzureEntityAddclassifications
description: Add classifications to an existing entity represented by a GUID.
parameters:
- name: guid
in: path
description: The globally unique identifier of the entity.
required: true
type: string
- name: body
in: body
description: An array of classifications to be added.
required: true
schema:
type: array
items:
$ref: '#/definitions/AtlasClassification'
x-ms-identifiers: []
responses:
'204':
description: >-
There is no content to send for this request, but the headers may be
useful.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/AtlasErrorResponse'
x-ms-examples:
Entity_AddClassifications:
$ref: ./examples/Entity_AddClassifications.json
summary: Microsoft Azure Post Atlas Entity Guid Guid Classifications
tags:
- Atlas
/atlas/v2/entity/guid/{guid}/header:
get:
operationId: microsoftAzureEntityGetheader
description: Get entity header given its GUID.
parameters:
- name: guid
in: path
description: The globally unique identifier of the entity.
required: true
type: string
responses:
'200':
description: The request has succeeded.
schema:
$ref: '#/definitions/AtlasEntityHeader'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/AtlasErrorResponse'
x-ms-examples:
Entity_GetHeader:
$ref: ./examples/Entity_GetHeader.json
summary: Microsoft Azure Get Atlas Entity Guid Guid Header
tags:
- Atlas
/atlas/v2/entity/guid/{guid}/labels:
put:
operationId: microsoftAzureEntityAddlabel
description: Add given labels to a given entity.
parameters:
- name: guid
in: path
description: The globally unique identifier of the entity.
required: true
type: string
- name: body
in: body
description: set of labels to be added
required: false
schema:
type: array
items:
type: string
responses:
'204':
description: >-
There is no content to send for this request, but the headers may be
useful.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/AtlasErrorResponse'
x-ms-examples:
Entity_AddLabel:
$ref: ./examples/Entity_AddLabel.json
summary: Microsoft Azure Put Atlas Entity Guid Guid Labels
tags:
- Atlas
post:
operationId: microsoftAzureEntitySetlabels
description: Set labels to a given entity.
parameters:
- name: guid
in: path
description: The globally unique identifier of the entity.
required: true
type: string
- name: body
in: body
description: set of labels to be set to the entity
required: false
schema:
type: array
items:
type: string
responses:
'204':
description: >-
There is no content to send for this request, but the headers may be
useful.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/AtlasErrorResponse'
x-ms-examples:
Entity_SetLabels:
$ref: ./examples/Entity_SetLabels.json
summary: Microsoft Azure Post Atlas Entity Guid Guid Labels
tags:
- Atlas
delete:
operationId: microsoftAzureEntityRemovelabels
description: Delete given labels to a given entity.
parameters:
- name: guid
in: path
description: The globally unique identifier of the entity.
required: true
type: string
- name: body
in: body
description: set of labels to be deleted
required: false
schema:
type: array
items:
type: string
responses:
'204':
description: >-
There is no content to send for this request, but the headers may be
useful.
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/AtlasErrorResponse'
x-ms-examples:
Entity_RemoveLabels:
$ref: ./examples/Entity_RemoveLabels.json
summary: Microsoft Azure Delete Atlas Entity Guid Guid Labels
tags:
- Atlas
/atlas/v2/entity/uniqueAttribute/type/{typeName}:
get:
operationId: microsoftAzureEntityGetbyuniqueattributes
description: >-
Get complete definition of an entity given its type and unique
attribute.<br><br>In<br>addition to the typeName path parameter,
attribute key-value pair(s) can be<br>provided in the following
format:<br>attr:\=.<br><br>NOTE: The<br>attrName and attrValue should be
unique across entities, eg.<br>qualifiedName.<br><br>The REST request
would look something like
this:<br>GET<br>/v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
parameters:
- name: typeName
in: path
description: The name of the type.
required: true
type: string
- name: minExtInfo
in: query
description: Whether to return minimal information for referred entities.
required: false
type: boolean
- name: ignoreRelationships
in: query
description: Whether to ignore relationship attributes.
required: false
type: boolean
- name: attr:qualifiedName
in: query
description: >-
The qualified name of the entity. (This is only an example.
qualifiedName can
be changed to other unique attributes)
required: false
type: str
# --- truncated at 32 KB (206 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/azure-analytics-purview-data-map-openapi-original.yml