swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Entity API
schemes:
- https
tags:
- name: Entity
paths:
  /entity/moveTo:
    post:
      operationId: microsoftAzureEntityMoveentitiestocollection
      description: Move existing entities to the target collection.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: collectionId
        in: query
        description: The collection where entities will be moved to.
        required: true
        type: string
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/MoveEntitiesOptions'
      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_MoveEntitiesToCollection:
          $ref: ./examples/Entity_MoveEntitiesToCollection.json
      summary: Microsoft Azure Post Entity Moveto
      tags:
      - Entity
  /atlas/v2/entity:
    post:
      tags:
      - Entity
      description: 'Create or update an entity in Atlas.<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_CustomAttribute.json
      parameters:
      - in: body
        name: entity
        description: Atlas entity with extended information.
        required: true
        schema:
          $ref: '#/definitions/AtlasEntityWithExtInfo'
      - $ref: '#/parameters/businessAttributeUpdateBehavior'
      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/excludeRelationshipTypes'
      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 Atlas 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: microsoftAzureEntityCreateorupdateentities
      x-ms-examples:
        Entity_CreateOrUpdateEntities:
          $ref: ./examples/Entity_CreateOrUpdateEntities.json
      parameters:
      - in: body
        name: entities
        description: An array of entities to create or update.
        required: true
        schema:
          $ref: '#/definitions/AtlasEntitiesWithExtInfo'
      - $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: microsoftAzureEntityDeletebyguids
      x-ms-examples:
        Entity_DeleteByGuids:
          $ref: ./examples/Entity_DeleteByGuids.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: microsoftAzureEntityGetbyguid
      x-ms-examples:
        Entity_GetByGuid:
          $ref: ./examples/Entity_GetByGuid.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: microsoftAzureEntityPartialupdateentityattributebyguid
      x-ms-examples:
        Entity_PartialUpdateEntityAttributeByGuid:
          $ref: ./examples/Entity_PartialUpdateEntityAttributeByGuid.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: microsoftAzureEntityDeletebyguid
      x-ms-examples:
        Entity_DeleteByGuid:
          $ref: ./examples/Entity_DeleteByGuid.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: List classifications 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_2'
        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: microsoftAzureEntityDeleteclassification
      x-ms-examples:
        Entity_DeleteClassification:
          $ref: ./examples/Entity_DeleteClassification.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_2'
      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_2'
      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: microsoftAzureEntityPartialupdateentitybyuniqueattributes
      x-ms-examples:
        Entity_PartialUpdateEntityByUniqueAttributes:
          $ref: ./examples/Entity_PartialUpdateEntityByUniqueAttributes.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: microsoftAzureEntityDeleteclassificationbyuniqueattribute
      x-ms-examples:
        Entity_DeleteClassificationByUniqueAttribute:
          $ref: ./examples/Entity_DeleteClassificationByUniqueAttribute.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_2'
      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_2'
      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: microsoftAzureEntitySetclassifications
      x-ms-examples:
        Entity_SetClassifications:
          $ref: ./examples/Entity_SetClassifications.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: microsoftAzureEntityGetentitiesbyuniqueattributes
      x-ms-examples:
        Entity_GetEntitiesByUniqueAttributes:
          $ref: ./examples/Entity_GetEntitiesByUniqueAttributes.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_2'
          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: microsoftAzureEntityDeletebusinessmetadata
      consumes:
      - application/json
      x-ms-examples:
        Entity_DeleteBusinessMetadata:
          $ref: ./examples/Entity_BusinessMetadata.json
      parameters:
      - $ref: '#/parameters/guid'
      - name: body
        required: false
        in: body
        schema:
          description: BusinessMetadata
          type: object
          additionalProperties:
            type: object
        description: 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
      - in: body
        name: body
        description: Business Metadata
        required: false
        schema:
          type: object
          additionalProperties: {}
      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: microsoftAzureEntityDeletebusinessmetadataattributes
      consumes:
      - application/json
      x-ms-examples:
        Entity_DeleteBusinessAttribute:
          $ref: ./examples/Entity_Delete_BusinessAttribute.json
      parameters:
      - name: bmName
        in: path
        type: string
        description: BusinessMetadata name
        required: true
      - $ref: '#/parameters/guid'
      - name: body
        required: false
        in: body
        schema:
          description: BusinessMetadataAttributes
          type: object
          additionalProperties: {}
        description: 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: body
        required: false
        in: body
        schema:
          description: BusinessMetadataAttributes
          type: object
          additionalProperties: {}
        description: 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: microsoftAzureEntityDeletelabels
      consumes:
      - application/json
      x-ms-examples:
        Entity_DeleteLabel:
          $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 labels to be deleted
      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 Labels
    post:
      tags:
      - Entity
      description: Set labels to a given entity
      operationId: microsoftAzureEntitySetlabels
      consumes:
      - application/json
      x-ms-examples:
        Entity_SetLabel:
          $ref: ./examples/Entity_Label.json
      parameters:
      - $ref: '#/parameters/guid'
      - name: body
        required: false
        in: body
        schema:
          description: set of labels to be set to the entity
          type: array
          items:
            type: string
        description: set of labels to be set to the entity
      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 Labels
    put:
      tags:
      - Entity
      description: add given labels to a given entity
      operationId: microsoftAzureEntityAddlabel
      consumes:
      - application/json
      x-ms-examples:
        Entity_AddLabel:
          $ref: ./examples/Entity_Label.json
      parameters:
      - $ref: '#/parameters/guid'
      - name: body
        required: false
        in: body
        schema:
          description: set of labels to be added
          type: array
          items:
            type: string
        description: set of labels to be added
      responses:
        '204':
          description: Success
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Put Atlas Entity Guid Guid Labels
  /atlas/v2/entity/uniqueAttribute/type/{typeName}/labels:
    delete:
      tags:
      - Entity
      operationId: microsoftAzureEntityDeletelabelsbyuniqueattribute
      description: 'Delete given labels to a given entity identified by its type and unique attributes, if labels is null/empty, no labels will be removed. If any labels in labels set are non-existing labels, they will be ignored, only existing labels will be removed. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:=. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue. '
      consumes:
      - application/json
      x-ms-examples:
        Entity_DeleteLabelsByUniqueAttribute:
          $ref: ./examples/Entity_DeleteLabelsByUniqueAttribute.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
      - name: body
        required: false
        in: body
        schema:
          description: set of labels to be deleted
          type: array
          items:
            type: string
        description: set of labels to be deleted
      responses:
        '204':
          description: Success
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Delete Atlas Entity Uniqueattribute Type Typename Labels
    post:
      tags:
      - Entity
      operationId: microsoftAzureEntitySetlabelsbyuniqueattribute
      description: 'Set labels to a given entity identified by its type and unique attributes, if labels is null/empty, existing labels will all be removed. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:=. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: POST /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.'
      consumes:
      - application/json
      x-ms-examples:
        Entity_SetLabelsByUniqueAttribute:
          $ref: ./examples/Entity_SetLabelsByUniqueAttribute.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
      - name: body
        required: false
        in: body
        schema:
          description: set of labels to be set
          type: array
          items:
            type: string
        description: set of labels to be set
      responses:
        '204':
          description: Success
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Atlas Entity Uniqueattribute Type Typename Labels
    put:
      tags:
      - Entity
      operationId: microsoftAzureEntityAddlabelsbyuniqueattribute
      description: 'Add given labels to a given entity identified by its type and unique attributes, if labels is null/empty, no labels will be added. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format: attr:=. NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. The REST request would look something like this: PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.'
      consumes:
      - application/json
      x-ms-examples:
        Entity_AddLabelsByUniqueAttribute:
          $ref: ./examples/Entity_AddLabelsByUniqueAttribute.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
      - name: body
        required: false
        in: body
        schema:
          description: set of labels to be added
          type: array
          items:
            type: string
        description: set of labels to be added
      responses:
        '204':
          description: Success
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Put Atlas Entity Uniqueattribute Type Typename Labels
  /entity/bulk/delete:
    delete:
      tags:
      - Entity
      description: Delete entities with hierarchy
      operationId: microsoftAzureEntityDeletewithhierarchy
      x-ms-examples:
        Entity_DeleteWithHierarchy:
          $ref: ./examples/Entity_DeleteWithHierarchy.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
      - name: parallelCount
        in: query
        description: This parameter is used only for entity bulk delete to define the number of concurrent threads.
        required: false
        type: string
        enum:
        - PARALLEL_COUNT_4
        - PARALLEL_COUNT_8
        - PARALLEL_COUNT_16
        - PARALLEL_COUNT_32
        - PARALLEL_COUNT_64
        x-ms-enum:
          name: parallelCount
          modelAsString: true
      - $ref: '#/parameters/purviewAPIVersion'
      responses:
        '202':
          description: Accepted. A job to delete entities with hierarchy.
          headers:
            Operation-Location:
              description: Response header for long running operation
              type: string
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: operation-location
      summary: Microsoft Azure Delete Entity Bulk Delete
  /entity/operations/{operationId}:
    get:
      tags:
      - Entity
      description: Get the status of entity long running operation
      operationId: microsoftAzureEntityGetoperationstatus
      x-ms-examples:
        Entity_GetOperationForDeleteWithHierarchy:
          $ref: ./examples/Entity_GetOperationForDeleteWithHierarchy.json
      parameters:
      - $ref: '#/parameters/operationId'
      - $ref: '#/parameters/purviewAPIVersion'
      responses:
        '200':
          description: OK. Return the status of the long running operation.
          schema:
            $ref: '#/definitions/EntityLongRunningOperation'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Get Entity Operations Operationid
definitions:
  LastModifiedTS:
    type: string
    title: lastModifiedTS
    description: ETag for concurrency control.
  Azure.Core.uuid:
    type: string
    format: uuid
    description: Universally Unique Identifier
  EntityLongRunningOperation:
    type: object
    title: Status of entity operation
    description: The status of entity operation
    required:
    - id
    - status
    properties:
      id:
        type: string
      status:
        $ref: '#/definitions/EntityLongRunningOperationStatus'
      createTime:
        type: string
        description: The created time of the record.
      lastUpdateTime:
        type: string
        description: The last updated time of the record.
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/EntityLongRunningOperationProperties'
      error:
        x-ms-client-flatten: true
        $ref: '#/definitions/AsyncOperationError'
  AtlasEntityHeaders:
    type: object
    title: AtlasEntityHeaders
    properties:
      guidHeaderMap:
        readOnly: false
        description: The description of the guid header map,
        type: object
        additionalProperties:
          $ref: '#/definitions/AtlasEntityHeader_2'
    description: An instance of an entity header map.
  AtlasEntityHeader:
    type: object
    description: An instance of an entity - like hive_table, hive_database.
    properties:
      attributes:
        type: object
        description: The attributes of the struct.
        additionalProperties: {}
      typeName:
        type: string
        description: The name of the type.
      lastModifiedTS:
        type: string
        description: ETag for concurrency control.
      classificationNames:
        type: array
        description: An array of classification names.
        items:
          type: string
      classifications:
        type: array
        description: An array of classifications.
        items:
          $ref: '#/definitions/AtlasClassification'
        x-ms-identifiers: []
      displayText:
        type: string
        description: The display text.
      guid:
        type: string
        description: The GUID of the record.
      isIncomplete:
        type: boolean
        description: Whether it is a shell entity
      labels:
        type: array
        description: labels
        items:
          type: string
      meaningNames:
        type: array
        description: An array of meanings.
        items:
          type: string
      meanings:
        type: array
        description: An array of term assignment headers.
        items:
          $ref: '#/definitions/AtlasTermAssignmentHeader'
        x-ms-identifiers: []
      status:
        $ref: '#/definitions/EntityStatus'
        description: 'Status of the entity - can be active or deleted. Deleted entities are not

          removed.'
  AtlasEntityHeader_2:
    type: object
    title: AtlasEntityHeader
    allOf:
    - $ref: '#/definitions/AtlasStruct'
    - properties:
        classificationNames:
          type: array
          description: An array of classification names.
          items:
            type: string
        classifications:
          type: array
          description: An array of classifications.
          items:
            $ref: '#/definitions/AtlasClassification_2'
        displayText:
          type: string
          description: The display text.
        guid:
          type: string
          description: The GUID of the record.
        isIncomplete:
          readOnly: false
          description: Whether it is a shell entity
          type: boolean
        labels:
          readOnly: false
          description: labels
          type: array
          items:
            type: string
        meaningNames:
          type: array
          description: An array of meanings.
          items:
            type: string
        meanings:
          type: array
          description: An array of term assignment headers.
          items:
            $ref: '#/definitions/AtlasTermAssignmentHeader_2'
        status:
          $ref: '#/definitions/Status'
    description: An instance of an entity - like hive_table, hive_database.
  EntityMutationResult:
    type: object
    description: The mutation response result of entity.
    properties:
      guidAssignments:
        type: object
        description: A map of GUID assignments with entities.
        additionalProperties:
          type: string
      mutatedEntities:
        type: object
        description: The entity headers of mutated entities.
        additionalProperties:
          items:
            $ref: '#/definitions/AtlasEntityHeader'
          type: array
          x-ms-identifiers: []
      partialUpdatedEntities:
        type: array
        description: An array of entity headers that partially updated.
        items:
          $ref: '#/definitions/AtlasEntityHeader'
        x-ms-identifiers: []
  EntityStatus:
    type: string
    description: Status - can be active or deleted
    enum:
    - ACTIVE
    - DELETED
    x-ms-enum:
      name: EntityStatus
      modelAsString: true
      values:
      - name: Active
        value: ACTIVE
        description: The status is active.
      - name: Deleted
        value: DELETED
        description: The status is deleted.
  AtlasErrorResponse:
    type: object
    description: An error response from the service
    properties:
      requestId:
        $ref: '#/definitions/Azure.Core.uuid'
        description: The request ID.
      errorCode:
        type: string
        description: The error code.
      errorMessage:
        type: string
        description: The error message.
  AtlasTermAssignmentHeader:
    type: object
    description: The header for term assignment.
    properties:
      confidence:
        type: integer
        format: int32
        description: The confidence of the term assignment.
      createdBy:
        type: string
        description: The user who created the record.
      description:
        type: string
        description: The description of the term assignment.
      displayText:
        type: string
        description: The display text.
      expression:
        type: string
        description: The expression of the term assignment.
      relationGuid:
        $ref: '#/definitions/Azure.Core.uuid'
        description: The GUID of the relationship.
      status:
        $ref: '#/definitions/AtlasTermAssignmentStatus'
        description: The status of terms assignment.
      steward:
        type: string
        description: The steward of the term.
      termGuid:
        $ref: '#/definitions/Azure.Core.uuid'
        description: The GUID of the term.
  AtlasEntitiesWithExtInfo:
    type: object
    title: AtlasEntitiesWithExtInfo
    allOf:
    - $ref: '#/definitions/AtlasEntityExtInfo'
    - properties:
        entities:
          type: array
          description: An array of entities.
          items:
            $ref: '#/definitions/AtlasEntity'
    description: An instance of an entity along with extended info - like hive_table, hive_database.
  AtlasTermAssignmentStatus:
    type: string
    description: Status for term assignment
    enum:
    - DISCOVERED
    - PROPOSED
    - IMPORTED
    - VALIDATED
    - DEPRECATED
    - OBSOLETE
    - OTHER
    x-ms-enum:
      name: AtlasTermAssignmentStatus
      modelAsString: true
      values:
      - name: Discovered
        value: DISCOVERED
        description: The status is discovered.
      - name: Proposed
        value: PROPOSED
        description: The status is proposed.
      - name: Imported
        value: IMPORTED
        description: The status is imported.
      - name: Validated
        value: VALIDATED
        description: The status is validated.
      - name: Deprecated
        value: DEPRECATED
        description: The status is deprecated.
      - name: Obsolete
        value: OBSOLETE
        description: The status is obsolete.
      - name: Other
        value: OTHER
        description: Other status.
  SortType:
    type: string
    title: SortType
    description: to specify whether the result should be sorted? If yes, whether asc or desc.
    enum:
    - NONE
    - ASC
    - DESC
    x-ms-enum:
      name: SortType
      modelAsString: true
  AtlasStruct:
    type: object
    properties:
      attributes:
        type: object
        description: The attributes of the struct.
        additionalProperties: {}
      typeName:
        type: string
        description: The name of the type.
      lastModifiedTS:
        $ref: '#/definitions/LastModifiedTS'
    title: AtlasStruct
    description: Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.
  ContactBasic:
    title: ContactBasic
    type: object
    properties:
      id:
        type: string
        description: Azure Active Directory object Id.
      info:
        type: string
        description: additional information to describe this contact.
  ImportStatus:
    type: string
    title: ImportStatus
    enum:
    - SUCCESS
    - FAILED
    description: ImportStatus
    x-ms-enum:
      name: importStatus
      modelAsString: true
  BulkImportResponse:
    type: object
    title: BulkImportResponse
    properties:
      failedImportInfoList:
        readOnly: false
        description: failed importInfoList
        type: array
        items:
          $ref: '#/definitions/ImportInfo'
      successImportInfoList:
        readOnly: false
        description: successful importInfoList
        type: array
        items:
          $ref: '#/definitions/ImportInfo'
    example:
      failedImportInfoList:
      - childObjectName: '...'
        importStatus: SUCCESS
        parentObjectName: '...'
        remarks: '...'
      - childObjectName: '...'
        importStatus: SUCCESS
        parentObjectName: '...'
        remarks: '...'
      successImportInfoList:
      - childObjectName: '...'
        importStatus: FAILED
        parentObjectName: '...'
        remarks: '...'
      - childObjectName: '...'
        importStatus: FAILED
        parentObjectName: '...'
        remarks: '...'
    description: example
  AtlasEntityExtInfo:
    type: object
    properties:
      referredEntities:
        type: object
        description: The referred entities.
        additionalProperties:
          $ref: '#/definitions/AtlasEntity'
    title: AtlasEntityExtInfo
    description: An instance of an entity along with extended info - like hive_table, hive_database.
  AtlasTermAssignmentHeader_2:
    type: object
    properties:
      confidence:
        type: integer
        format: int32
        description: The confidence of the term assignment.
      createdBy:
        type: string
        description: The user who created the record.
      description:
        type: string
        description: The description of the term assignment.
      displayText:
        type: string
        description: The display text.
      expression:
        type: string
        description: The expression of the term assignment.
      relationGuid:
        type: string
        description: The GUID of the relationship.
      source:
        type: string
        description: The source of the term.
      status:
        $ref: '#/definitions/AtlasTermAssignmentStatus_2'
      steward:
        type: string
        description: The steward of the term.
      termGuid:
        type: string
        description: The GUID of the term.
    title: AtlasTermAssignmentHeader
    description: The header for term assignment.
  ClassificationAssociateRequest:
    type: object
    properties:
      classification:
        $ref: '#/definitions/AtlasClassification_2'
      entityGuids:
        type: array
        description: The GUID of the entity.
        items:
          type: string
    title: ClassificationAssociateRequest
    description: The request for classification association.
  Status:
    type: string
    title: Status
    description: Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store.
    enum:
    - ACTIVE
    - DELETED
    x-ms-enum:
      name: Status
      modelAsString: true
  PList:
    type: object
    properties:
      list:
        type: array
        description: An array of objects.
        items:
          type: object
          properties: {}
      pageSize:
        type: integer
        format: int32
        description: The size of the page.
      sortBy:
        type: string
        description: The sorted by field.
      sortType:
        $ref: '#/definitions/SortType'
      startIndex:
        type: integer
        format: int64
        description: The start index of the page.
      totalCount:
        type: integer
        format: int64
        description: The total count of items.
    title: PList
    description: Paginated-list, for returning search results.
  AtlasClassification:
    type: object
    description: 'An instance of a classification; it doesn''t have an identity, this object

      exists only when associated with an entity.'
    properties:
      attributes:
        type: object
        description: The attributes of the struct.
        additionalProperties: {}
      typeName:
        type: string
        description: The name of the type.
      lastModifiedTS:
        type: string
        description: ETag for concurrency control.
      entityGuid:
        type: string
        description: The GUID of the entity.
      entityStatus:
        $ref: '#/definitions/EntityStatus'
        description: 'Status of the entity - can be active or deleted. Deleted entities are not

          removed.'
      removePropagationsOnEntityDelete:
        type: boolean
        description: Determines if propagations will be removed on entity deletion.
      validityPeriods:
        type: array
        description: An array of time boundaries indicating validity periods.
        items:
          $ref: '#/definitions/TimeBoundary'
        x-ms-identifiers: []
  AtlasEntity:
    type: object
    title: AtlasEntity
    allOf:
    - $ref: '#/definitions/AtlasStruct'
    - properties:
        businessAttributes:
          readOnly: false
          description: Business Attributes
          type: object
          additionalProperties:
            type: object
        classifications:
          type: array
          description: An array of classifications.
          items:
            $ref: '#/definitions/AtlasClassification_2'
        createTime:
          type: integer
          format: int64
          description: The created time of the record.
        createdBy:
          type: string
          description: The user who created the record.
        customAttributes:
          readOnly: false
          description: Custom Attribute
          type: object
          additionalProperties:
            type: string
        guid:
          type: string
          description: The GUID of the entity.
        homeId:
          type: string
          description: The home ID of the entity.
        collectionId:
          type: string
          description: The collection ID of the entity.
        isIncomplete:
          readOnly: false
          description: Whether it is a shell entity
          type: boolean
        labels:
          readOnly: false
          description: labels
          type: array
          items:
            type: string
        meanings:
          type: array
          description: An array of term assignment headers indicating the meanings of the entity.
          items:
            $ref: '#/definitions/AtlasTermAssignmentHeader_2'
        provenanceType:
          readOnly: false
          description: Used to record the provenance of an instance of an entity or relationship.
          type: number
        proxy:
          type: boolean
          description: Determines if there's a proxy.
        relationshipAttributes:
          type: object
          description: The attributes of relationship.
          additionalProperties: {}
        status:
          $ref: '#/definitions/Status'
        updateTime:
          type: integer
          format: int64
          description: The update time of the record.
        updatedBy:
          type: string
          description: The user who updated the record.
        version:
          type: number
          description: The version of the entity.
        source:
          type: string
          description: indicate the source who create the classification detail
        sourceDetails:
          type: object
          additionalProperties:
            type: object
            properties: {}
          description: more detail on source information
        contacts:
          type: object
          description: The dictionary of contacts for entities. Key could be Expert or Owner.
          additionalProperties:
            type: array
            items:
              $ref: '#/definitions/ContactBasic'
    description: An instance of an entity - like hive_table, hive_database.
  AtlasClassifications:
    type: object
    title: AtlasClassifications
    allOf:
    - $ref: '#/definitions/PList'
    description: REST serialization friendly list.
  ErrorResponse:
    description: An error response from the service
    type: object
    properties:
      requestId:
        type: string
        description: The request ID.
      errorCode:
        type: string
        description: The error code.
      errorMessage:
        type: string
        description: The error message.
  ImportInfo:
    type: object
    title: ImportInfo
    properties:
      childObjectName:
        readOnly: false
        description: childObjectName
        type: string
      importStatus:
        readOnly: false
        $ref: '#/definitions/ImportStatus'
        description: importStatus
      parentObjectName:
        readOnly: false
        description: parentObjectName
        type: string
      remarks:
        readOnly: false
        description: remarks
        type: string
    example:
      childObjectName: '...'
      importStatus: SUCCESS
      parentObjectName: '...'
      remarks: '...'
    description: ImportInfo
  TimeBoundary:
    type: object
    description: Captures time-boundary details
    properties:
      endTime:
        type: string
        description: The end of the time boundary.
      startTime:
        type: string
        description: The start of the time boundary.
      timeZone:
        type: string
        description: The timezone of the time boundary.
  EntityMutationResponse:
    type: object
    properties:
      guidAssignments:
        type: object
        description: A map of GUID assignments with entities.
        additionalProperties:
          type: string
      mutatedEntities:
        type: object
        description: The entity headers of mutated entities.
        additionalProperties:
          type: array
          items:
            $ref: '#/definitions/AtlasEntityHeader_2'
      partialUpdatedEntities:
        type: array
        description: An array of entity headers that partially updated.
        items:
          $ref: '#/definitions/AtlasEntityHeader_2'
    title: EntityMutationResponse
    description: The mutation response of entity.
  AtlasEntityWithExtInfo:
    type: object
    title: AtlasEntityWithExtInfo
    allOf:
    - $ref: '#/definitions/AtlasEntityExtInfo'
    - properties:
        entity:
          $ref: '#/definitions/AtlasEntity'
    description: An instance of an entity along with extended info - like hive_table, hive_database.
  EntityLongRunningOperationProperties:
    type: object
    additionalProperties: {}
  EntityLongRunningOperationStatus:
    type: string
    enum:
    - NotStarted
    - Succeeded
    - Failed
    - Running
    x-ms-enum:
      name: EntityLongRunningOperationStatus
      modelAsString: true
    title: EntityLongRunningOperationStatus
    description: Enum of the status of entity asynchronous operation.
  TimeBoundary_2:
    type: object
    properties:
      endTime:
        type: string
        description: The end of the time boundary.
      startTime:
        type: string
        description: The start of the time boundary.
      timeZone:
        type: string
        description: The timezone of the time boundary.
    title: TimeBoundary
    description: Captures time-boundary details
  AtlasTermAssignmentStatus_2:
    type: string
    title: AtlasTermAssignmentStatus
    description: The status of terms assignment.
    enum:
    - DISCOVERED
    - PROPOSED
    - IMPORTED
    - VALIDATED
    - DEPRECATED
    - OBSOLETE
    - OTHER
    x-ms-enum:
      name: AtlasTermAssignmentStatus
      modelAsString: true
  AtlasClassification_2:
    type: object
    title: AtlasClassification
    allOf:
    - $ref: '#/definitions/AtlasStruct'
    - properties:
        entityGuid:
          type: string
          description: The GUID of the entity.
        entityStatus:
          $ref: '#/definitions/Status'
        removePropagationsOnEntityDelete:
          type: boolean
          description: Determines if propagations will be removed on entity deletion.
        validityPeriods:
          type: array
          description: An array of time boundaries indicating validity periods.
          items:
            $ref: '#/definitions/TimeBoundary_2'
        source:
          type: string
          description: indicate the source who create the classification detail
        sourceDetails:
          type: object
          additionalProperties:
            type: object
            properties: {}
          description: more detail on source information
    description: An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity.
  MoveEntitiesOptions:
    type: object
    description: MoveEntitiesOptions
    properties:
      entityGuids:
        type: array
        description: An array of entity guids to be moved to target collection.
        items:
          type: string
  AsyncOperationError:
    type: object
    properties:
      code:
        type: string
        description: Code from async job if fail
      message:
        type: string
        description: Message from async job if fail
parameters:
  operationId:
    name: operationId
    in: path
    description: The globally unique identifier for async operation job.
    required: true
    type: string
    minLength: 1
    maxLength: 4096
    x-ms-parameter-location: method
  businessAttributeUpdateBehavior:
    name: businessAttributeUpdateBehavior
    description: Used to define the update behavior for business attributes when updating entities.
    in: query
    required: false
    type: string
    enum:
    - ignore
    - replace
    - merge
    x-ms-enum:
      name: businessAttributeUpdateBehavior
      modelAsString: true
    x-ms-parameter-location: method
  typeName:
    name: typeName
    description: The name of the type.
    in: path
    required: true
    type: string
    minLength: 1
    maxLength: 4096
    x-ms-parameter-location: method
  minExtInfo:
    name: minExtInfo
    description: Whether to return minimal information for referred entities.
    in: query
    required: false
    type: boolean
    default: false
    x-ms-parameter-location: method
  excludeRelationshipTypes:
    name: excludeRelationshipTypes
    description: An array of the relationship types need to be excluded from the response.
    in: query
    required: false
    type: array
    items:
      type: string
    collectionFormat: multi
    x-ms-parameter-location: method
  guid:
    name: guid
    description: The globally unique identifier of the entity.
    in: path
    required: true
    type: string
    minLength: 1
    maxLength: 4096
    x-ms-parameter-location: method
  classificationName:
    name: classificationName
    description: The name of the classification.
    in: path
    required: true
    type: string
    minLength: 1
    maxLength: 4096
    x-ms-parameter-location: method
  purviewAPIVersion:
    name: api-version
    description: The version of the API.
    in: query
    required: true
    type: string
    x-ms-parameter-location: method
  Azure.Core.Foundations.ApiVersionParameter:
    name: api-version
    in: query
    description: The API version to use for this operation.
    required: true
    type: string
    minLength: 1
    x-ms-parameter-location: method
    x-ms-client-name: apiVersion
  ignoreRelationships:
    name: ignoreRelationships
    description: Whether to ignore relationship attributes.
    in: query
    required: false
    type: boolean
    default: false
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'