Microsoft Azure Purview Data Map Service API Document

swagger: '2.0'
info:
  title: Microsoft Azure Purview Data Map Service REST API Document
  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.
  version: 2023-10-01-preview
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
    - $ref: '#/parameters/endpoint'
basePath: /datamap/api
schemes:
  - https
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  azure_auth:
    flow: implicit
    authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
    scopes:
      user_impersonation: impersonate your user account
    type: oauth2
    description: Azure Active Directory OAuth2 Flow.
security:
  - azure_auth:
      - user_impersonation
paths:
  /atlas/v2/entity:
    post:
      tags:
        - Entity
      description: >-
        Create or update an entity.<br>Existing entity is matched using its
        unique guid if supplied or by its unique attributes eg:
        qualifiedName.<br>Map and array of collections are not well supported.
        E.g., array>, array>.<br>For each contact type, the maximum number of
        contacts is 20.
      operationId: microsoftAzureEntityCreateorupdate
      x-ms-examples:
        Entity_Create:
          $ref: ./examples/Entity_Create.json
        Entity_Update:
          $ref: ./examples/Entity_Update.json
        Entity_AddCustomAttribute:
          $ref: ./examples/Entity_AddCustomAttribute.json
      parameters:
        - in: body
          name: entity
          description: Atlas entity with extended information.
          required: true
          schema:
            $ref: '#/definitions/AtlasEntityWithExtInfo'
        - $ref: '#/parameters/businessAttributeUpdateBehavior'
        - $ref: '#/parameters/collectionId'
        - $ref: '#/parameters/atlasAPIVersion'
      responses:
        '200':
          description: Created with EntityMutationResponse.
          schema:
            $ref: '#/definitions/EntityMutationResponse'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Atlas Entity
  /atlas/v2/entity/bulk:
    get:
      tags:
        - Entity
      description: List entities in bulk identified by its GUIDs.
      operationId: microsoftAzureEntityListbyguids
      x-ms-examples:
        Entity_ListByGuids:
          $ref: ./examples/Entity_ListByGuids.json
      parameters:
        - name: guid
          in: query
          description: An array of GUIDs of entities to list.
          required: true
          type: array
          items:
            type: string
          collectionFormat: multi
          x-ms-client-name: guids
        - $ref: '#/parameters/minExtInfo'
        - $ref: '#/parameters/ignoreRelationships'
        - $ref: '#/parameters/atlasAPIVersion'
      responses:
        '200':
          description: OK.
          schema:
            $ref: '#/definitions/AtlasEntitiesWithExtInfo'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Entity Bulk
    post:
      tags:
        - Entity
      description: >-
        Create or update entities in bulk.<br>Existing entity is matched using
        its unique guid if supplied or by its unique attributes eg:
        qualifiedName.<br>Map and array of collections are not well supported.
        E.g., array>, array>.<br>For each contact type, the maximum number of
        contacts is 20.
      operationId: microsoftAzureEntityBulkcreateorupdate
      x-ms-examples:
        Entity_BulkCreateOrUpdate:
          $ref: ./examples/Entity_BulkCreateOrUpdate.json
      parameters:
        - in: body
          name: entities
          description: An array of entities to create or update.
          required: true
          schema:
            $ref: '#/definitions/AtlasEntitiesWithExtInfo'
        - $ref: '#/parameters/collectionId'
        - $ref: '#/parameters/atlasAPIVersion'
        - $ref: '#/parameters/businessAttributeUpdateBehavior'
      responses:
        '200':
          description: Ok.
          schema:
            $ref: '#/definitions/EntityMutationResponse'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Atlas Entity Bulk
    delete:
      tags:
        - Entity
      description: >-
        Delete a list of entities in bulk identified by their GUIDs or unique
        attributes.
      operationId: microsoftAzureEntityBulkdelete
      x-ms-examples:
        Entity_BulkDelete:
          $ref: ./examples/Entity_BulkDelete.json
      parameters:
        - name: guid
          in: query
          description: An array of GUIDs of entities to delete.
          required: true
          type: array
          items:
            type: string
          collectionFormat: multi
          x-ms-client-name: guids
      responses:
        '200':
          description: Deleted with EntityMutationResponse.
          schema:
            $ref: '#/definitions/EntityMutationResponse'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Delete Atlas Entity Bulk
  /atlas/v2/entity/bulk/classification:
    post:
      tags:
        - Entity
      description: Associate a classification to multiple entities in bulk.
      operationId: microsoftAzureEntityAddclassification
      x-ms-examples:
        Entity_AddClassificationToEntityByGuids:
          $ref: ./examples/Entity_AddClassificationToEntityByGuids.json
      parameters:
        - in: body
          name: request
          description: The request to associate a classification to multiple entities.
          required: true
          schema:
            $ref: '#/definitions/ClassificationAssociateRequest'
      responses:
        '204':
          description: No Content.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Atlas Entity Bulk Classification
  /atlas/v2/entity/guid/{guid}:
    get:
      tags:
        - Entity
      operationId: microsoftAzureEntityGet
      x-ms-examples:
        Entity_Get:
          $ref: ./examples/Entity_Get.json
      description: Get complete definition of an entity given its GUID.
      parameters:
        - $ref: '#/parameters/guid'
        - $ref: '#/parameters/minExtInfo'
        - $ref: '#/parameters/ignoreRelationships'
      responses:
        '200':
          description: OK.
          schema:
            $ref: '#/definitions/AtlasEntityWithExtInfo'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Entity Guid Guid
    put:
      tags:
        - Entity
      description: >-
        Update entity partially - create or update entity attribute identified
        by its 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.
      operationId: microsoftAzureEntityPartialupdateattributebyguid
      x-ms-examples:
        Entity_PartialUpdateEntityAttributeByGuid:
          $ref: ./examples/Entity_PartialUpdateAttributeByGuid.json
      parameters:
        - $ref: '#/parameters/guid'
        - name: name
          in: query
          description: The name of the attribute.
          required: true
          type: string
        - in: body
          name: body
          description: The value of the attribute.
          required: true
          schema:
            type: object
      responses:
        '200':
          description: Updated with EntityMutationResponse.
          schema:
            $ref: '#/definitions/EntityMutationResponse'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Put Atlas Entity Guid Guid
    delete:
      tags:
        - Entity
      description: Delete an entity identified by its GUID.
      operationId: microsoftAzureEntityDelete
      x-ms-examples:
        Entity_Delete:
          $ref: ./examples/Entity_Delete.json
      parameters:
        - $ref: '#/parameters/guid'
      responses:
        '200':
          description: Deleted with EntityMutationResponse.
          schema:
            $ref: '#/definitions/EntityMutationResponse'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Delete Atlas Entity Guid Guid
  /atlas/v2/entity/guid/{guid}/classification/{classificationName}:
    get:
      tags:
        - Entity
      description: Get classification for a given entity represented by a GUID.
      operationId: microsoftAzureEntityGetclassification
      x-ms-examples:
        Entity_GetClassification:
          $ref: ./examples/Entity_GetClassification.json
      parameters:
        - $ref: '#/parameters/guid'
        - $ref: '#/parameters/classificationName'
      responses:
        '200':
          description: The classification for the given entity GUID.
          schema:
            $ref: '#/definitions/AtlasClassification'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Entity Guid Guid Classification Classificationname
    delete:
      tags:
        - Entity
      description: >-
        Delete a given classification from an existing entity represented by a
        GUID.
      operationId: microsoftAzureEntityRemoveclassification
      x-ms-examples:
        Entity_RemoveClassification:
          $ref: ./examples/Entity_RemoveClassification.json
      parameters:
        - $ref: '#/parameters/guid'
        - $ref: '#/parameters/classificationName'
      responses:
        '204':
          description: No Content.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Delete Atlas Entity Guid Guid Classification Classificationname
  /atlas/v2/entity/guid/{guid}/classifications:
    get:
      tags:
        - Entity
      description: List classifications for a given entity represented by a GUID.
      operationId: microsoftAzureEntityGetclassifications
      x-ms-examples:
        Entity_GetClassifications:
          $ref: ./examples/Entity_GetClassifications.json
      parameters:
        - $ref: '#/parameters/guid'
      responses:
        '200':
          description: An array of classifications for the given entity GUID.
          schema:
            $ref: '#/definitions/AtlasClassifications'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Entity Guid Guid Classifications
    post:
      tags:
        - Entity
      description: Add classifications to an existing entity represented by a GUID.
      operationId: microsoftAzureEntityAddclassifications
      x-ms-examples:
        Entity_AddClassifications:
          $ref: ./examples/Entity_AddClassifications.json
      parameters:
        - $ref: '#/parameters/guid'
        - in: body
          name: classifications
          description: An array of classifications to be added.
          required: true
          schema:
            type: array
            description: An array of classifications.
            items:
              $ref: '#/definitions/AtlasClassification'
      responses:
        '204':
          description: No Content.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Atlas Entity Guid Guid Classifications
    put:
      tags:
        - Entity
      description: Update classifications to an existing entity represented by a guid.
      operationId: microsoftAzureEntityUpdateclassifications
      x-ms-examples:
        Entity_UpdateClassifications:
          $ref: ./examples/Entity_UpdateClassifications.json
      parameters:
        - $ref: '#/parameters/guid'
        - in: body
          name: classifications
          description: An array of classifications to be updated.
          required: true
          schema:
            type: array
            description: An array of classifications.
            items:
              $ref: '#/definitions/AtlasClassification'
      responses:
        '204':
          description: No Content.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Put Atlas Entity Guid Guid Classifications
  /atlas/v2/entity/uniqueAttribute/type/{typeName}:
    get:
      tags:
        - Entity
      description: >-
        Get complete definition of an entity given its type and unique
        attribute.<br>In addition to the typeName path parameter, attribute
        key-value pair(s) can be provided in the following format:<br>attr:\=.
        <br>NOTE: The attrName and attrValue should be unique across entities,
        eg. qualifiedName.<br>The REST request would look something like
        this:<br>GET
        /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
      operationId: microsoftAzureEntityGetbyuniqueattributes
      x-ms-examples:
        Entity_GetByUniqueAttributes:
          $ref: ./examples/Entity_GetByUniqueAttributes.json
      parameters:
        - $ref: '#/parameters/typeName'
        - $ref: '#/parameters/minExtInfo'
        - $ref: '#/parameters/ignoreRelationships'
        - 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: string
      responses:
        '200':
          description: AtlasEntityWithExtInfo.
          schema:
            $ref: '#/definitions/AtlasEntityWithExtInfo'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Entity Uniqueattribute Type Typename
    put:
      tags:
        - Entity
      description: >-
        Update entity partially - Allow a subset of attributes to be updated
        on<br>an entity which is identified by its type and unique attribute  eg: Referenceable.qualifiedName.<br>Null updates are not possible.<br>In
        addition to the typeName path parameter, attribute key-value pair(s) can
        be provided in the following format:<br>attr:=.<br>NOTE: The attrName
        and attrValue should be unique across entities, eg.
        qualifiedName.<br>The REST request would look something like
        this:<br>PUT
        /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
      operationId: microsoftAzureEntityPartialupdatebyuniqueattributes
      x-ms-examples:
        Entity_PartialUpdateEntityByUniqueAttributes:
          $ref: ./examples/Entity_PartialUpdateByUniqueAttributes.json
      parameters:
        - $ref: '#/parameters/typeName'
        - 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: string
        - in: body
          name: atlasEntityWithExtInfo
          description: Atlas entity with extended information.
          required: true
          schema:
            $ref: '#/definitions/AtlasEntityWithExtInfo'
      responses:
        '200':
          description: Updated with EntityMutationResponse.
          schema:
            $ref: '#/definitions/EntityMutationResponse'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Put Atlas Entity Uniqueattribute Type Typename
    delete:
      tags:
        - Entity
      description: >-
        Delete an entity identified by its type and unique attributes.<br>In
        addition to the typeName path parameter, attribute key-value pair(s) can
        be provided in the following format:<br>attr:\=\.<br>NOTE: The attrName
        and attrValue should be unique across entities, eg.
        qualifiedName.<br>The REST request would look something like
        this:<br>DELETE
        /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.
      operationId: microsoftAzureEntityDeletebyuniqueattribute
      x-ms-examples:
        Entity_DeleteByUniqueAttribute:
          $ref: ./examples/Entity_DeleteByUniqueAttribute.json
      parameters:
        - $ref: '#/parameters/typeName'
        - 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: string
      responses:
        '200':
          description: Deleted with EntityMutationResponse.
          schema:
            $ref: '#/definitions/EntityMutationResponse'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Delete Atlas Entity Uniqueattribute Type Typename
  /atlas/v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}:
    delete:
      tags:
        - Entity
      description: >-
        Delete a given classification from an entity identified by its type and
        unique attributes.
      operationId: microsoftAzureEntityRemoveclassificationbyuniqueattribute
      x-ms-examples:
        Entity_RemoveClassificationByUniqueAttribute:
          $ref: ./examples/Entity_RemoveClassificationByUniqueAttribute.json
      parameters:
        - $ref: '#/parameters/typeName'
        - $ref: '#/parameters/classificationName'
        - 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: string
      responses:
        '204':
          description: No Content.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: >-
        Microsoft Azure Delete Atlas Entity Uniqueattribute Type Typename Classification Classificationname
  /atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications:
    post:
      tags:
        - Entity
      description: >-
        Add classification to the entity identified by its type and unique
        attributes.
      operationId: microsoftAzureEntityAddclassificationsbyuniqueattribute
      x-ms-examples:
        Entity_AddClassificationsByUniqueAttribute:
          $ref: ./examples/Entity_AddClassificationsByUniqueAttribute.json
      parameters:
        - $ref: '#/parameters/typeName'
        - 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: string
        - in: body
          name: atlasClassificationArray
          description: An array of classification to be added.
          required: true
          schema:
            type: array
            description: An array of classification.
            items:
              $ref: '#/definitions/AtlasClassification'
      responses:
        '204':
          description: No Content.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Atlas Entity Uniqueattribute Type Typename Classifications
    put:
      tags:
        - Entity
      description: >-
        Update classification on an entity identified by its type and unique
        attributes.
      operationId: microsoftAzureEntityUpdateclassificationsbyuniqueattribute
      x-ms-examples:
        Entity_UpdateClassificationsByUniqueAttribute:
          $ref: ./examples/Entity_UpdateClassificationsByUniqueAttribute.json
      parameters:
        - $ref: '#/parameters/typeName'
        - 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: string
        - in: body
          name: atlasClassificationArray
          description: An array of classification to be updated.
          required: true
          schema:
            type: array
            description: An array of classification.
            items:
              $ref: '#/definitions/AtlasClassification'
      responses:
        '204':
          description: No Content.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Put Atlas Entity Uniqueattribute Type Typename Classifications
  /atlas/v2/entity/bulk/setClassifications:
    post:
      tags:
        - Entity
      description: Set classifications on entities in bulk.
      operationId: microsoftAzureEntityBulksetclassifications
      x-ms-examples:
        Entity_BulkSetClassifications:
          $ref: ./examples/Entity_BulkSetClassifications.json
      parameters:
        - in: body
          name: entityHeaders
          description: Atlas entity headers.
          required: true
          schema:
            $ref: '#/definitions/AtlasEntityHeaders'
      responses:
        '200':
          description: OK
          schema:
            type: array
            description: Response that indicates each classification mutation result.
            items:
              type: string
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Atlas Entity Bulk Setclassifications
  /atlas/v2/entity/bulk/uniqueAttribute/type/{typeName}:
    get:
      tags:
        - Entity
      description: >-
        Bulk API to retrieve list of entities identified by its unique
        attributes.<br><br>In addition to the typeName path parameter, attribute
        key-value pair(s) can be provided in the following
        format<br><br>typeName=\&attr_1:\=\&attr_2:\=\&attr_3:\=\<br><br>NOTE:
        The attrName should be an unique attribute for the given
        entity-type<br><br>The REST request would look something like
        this<br><br>GET
        /v2/entity/bulk/uniqueAttribute/type/hive_db?attr_1:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1<br>Note:
        at least one unique attribute must be provided.
      operationId: microsoftAzureEntityListbyuniqueattributes
      x-ms-examples:
        Entity_ListByUniqueAttributes:
          $ref: ./examples/Entity_ListByUniqueAttributes.json
      parameters:
        - $ref: '#/parameters/typeName'
        - $ref: '#/parameters/minExtInfo'
        - $ref: '#/parameters/ignoreRelationships'
        - 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: OK.
          schema:
            $ref: '#/definitions/AtlasEntitiesWithExtInfo'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Entity Bulk Uniqueattribute Type Typename
  /atlas/v2/entity/guid/{guid}/header:
    get:
      tags:
        - Entity
      description: Get entity header given its GUID.
      operationId: microsoftAzureEntityGetheader
      x-ms-examples:
        Entity_GetHeader:
          $ref: ./examples/Entity_GetHeader.json
      parameters:
        - $ref: '#/parameters/guid'
      responses:
        '200':
          schema:
            $ref: '#/definitions/AtlasEntityHeader'
          description: AtlasEntityHeader
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Entity Guid Guid Header
  /atlas/v2/entity/guid/{guid}/businessmetadata:
    delete:
      tags:
        - Entity
      description: Remove business metadata from an entity.
      operationId: microsoftAzureEntityRemovebusinessmetadata
      consumes:
        - application/json
      x-ms-examples:
        Entity_RemoveBusinessMetadata:
          $ref: ./examples/Entity_RemoveBusinessMetadata.json
      parameters:
        - $ref: '#/parameters/guid'
        - name: businessMetadata
          required: false
          in: body
          schema:
            $ref: '#/definitions/BusinessMetadata'
      responses:
        '204':
          description: Success
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Delete Atlas Entity Guid Guid Businessmetadata
    post:
      tags:
        - Entity
      description: Add business metadata to an entity.
      operationId: microsoftAzureEntityAddorupdatebusinessmetadata
      consumes:
        - application/json
      x-ms-examples:
        Entity_AddOrUpdateBusinessMetadata:
          $ref: ./examples/Entity_AddOrUpdate_BusinessAttribute.json
      parameters:
        - $ref: '#/parameters/guid'
        - in: query
          type: boolean
          name: isOverwrite
          description: >-
            Whether to overwrite the existing business metadata on the entity or
            not, default is false.
          required: false
        - name: businessMetadata
          required: false
          in: body
          schema:
            $ref: '#/definitions/BusinessMetadata'
      responses:
        '204':
          description: Success
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Atlas Entity Guid Guid Businessmetadata
  /atlas/v2/entity/guid/{guid}/businessmetadata/{bmName}:
    delete:
      tags:
        - Entity
      description: Delete business metadata attributes from an entity.
      operationId: microsoftAzureEntityRemovebusinessmetadataattributes
      consumes:
        - application/json
      x-ms-examples:
        Entity_RemoveBusinessAttribute:
          $ref: ./examples/Entity_RemoveBusinessAttribute.json
      parameters:
        - name: bmName
          in: path
          type: string
          description: BusinessMetadata name
          required: true
        - $ref: '#/parameters/guid'
        - name: businessMetadataAttributes
          required: false
          in: body
          schema:
            $ref: '#/definitions/BusinessMetadataAttributes'
      responses:
        '204':
          description: Success
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Delete Atlas Entity Guid Guid Businessmetadata Bmname
    post:
      tags:
        - Entity
      description: Add or update business metadata attributes
      operationId: microsoftAzureEntityAddorupdatebusinessmetadataattributes
      consumes:
        - application/json
      x-ms-examples:
        Entity_AddOrUpdateBusinessAttribute:
          $ref: ./examples/Entity_AddOrUpdate_BusinessAttribute.json
      parameters:
        - name: bmName
          in: path
          type: string
          description: BusinessMetadata name
          required: true
        - $ref: '#/parameters/guid'
        - name: businessMetadataAttributes
          required: false
          in: body
          schema:
            $ref: '#/definitions/BusinessMetadataAttributes'
      responses:
        '204':
          description: Success
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Atlas Entity Guid Guid Businessmetadata Bmname
  /atlas/v2/entity/businessmetadata/import/template:
    get:
      tags:
        - Entity
      description: Get the sample Template for uploading/creating bulk BusinessMetaData
      operationId: microsoftAzureEntityGetsamplebusinessmetadatatemplate
      produces:
        - application/octet-stream
      x-ms-examples:
        Entity_GetSampleBusinessMetadataTemplate:
          $ref: ./examples/Entity_GetSampleBusinessMetadataTemplate.json
      parameters: []
      responses:
        '200':
          schema:
            description: Template File
            type: file
          description: Template File
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Atlas Entity Businessmetadata Import Template
  /atlas/v2/entity/businessmetadata/import:
    post:
      tags:
        - Entity
      description: Upload the file for creating Business Metadata in BULK
      operationId: microsoftAzureEntityImportbusinessmetadata
      consumes:
        - multipart/form-data
      produces:
        - application/json
      x-ms-examples:
        Entity_ImportBusinessMetadata:
          $ref: ./examples/Entity_ImportBusinessMetadata.json
      parameters:
        - name: uploadedInputStream
          in: formData
          type: file
          description: InputStream of file
      responses:
        '200':
          schema:
            $ref: '#/definitions/BulkImportResponse'
            description: If Business Metadata creation was successful
          description: If Business Metadata creation was successful
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Atlas Entity Businessmetadata Import
  /atlas/v2/entity/guid/{guid}/labels:
    delete:
      tags:
        - Entity
      description: delete given labels to a given entity
      operationId: microsoftAzureEntityRemovelabels
      consumes:
        - application/json
      x-ms-examples:
        Entity_RemoveLabels:
          $ref: ./examples/Entity_Label.json
      parameters:
        - $ref: '#/parameters/guid'
        - name: body
          required: false
          in: body
          schema:
            description: set of labels to be deleted
            type: array
            items:
              type: string
          description: set of labe

# --- truncated at 32 KB (185 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/purview-data-map-service-rest-api-document-openapi-original.yml