openapi: 3.1.0
info:
  title: Microsoft Purview Catalog API
  description: >-
    APIs for discovering, cataloging, and managing metadata for data assets
    across your data estate. The catalog is built on Apache Atlas and provides
    searchable inventory of data assets with classifications and glossary terms.
  version: 2022-08-01-preview
  contact:
    name: Microsoft Purview Support
    url: https://learn.microsoft.com/en-us/purview/
  license:
    name: Microsoft API License
    url: https://azure.microsoft.com/en-us/support/legal/
servers:
  - url: https://{accountName}.purview.azure.com/catalog
    description: Microsoft Purview Catalog API endpoint
    variables:
      accountName:
        description: The name of the Microsoft Purview account
        default: myaccount
security:
  - oauth2: []
tags:
  - name: Discovery
    description: Operations for searching and discovering data assets
  - name: Entity
    description: Operations for managing catalog entities
  - name: Glossary
    description: Operations for managing glossary terms, categories, and assignments
  - name: Lineage
    description: Operations for tracking data lineage
  - name: Relationship
    description: Operations for managing relationships between entities
  - name: Type
    description: Operations for managing type definitions
paths:
  /api/atlas/v2/entity:
    post:
      operationId: createOrUpdateEntity
      summary: Microsoft Purview Create or update an entity
      description: >-
        Create or update an entity. Existing entity is matched using its unique
        guid if supplied or by its unique attributes such as qualifiedName.
      tags:
        - Entity
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AtlasEntityWithExtInfo'
      responses:
        '200':
          description: Entity created or updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityMutationResponse'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
  /api/atlas/v2/entity/guid/{guid}:
    get:
      operationId: getEntityByGuid
      summary: Microsoft Purview Get entity by GUID
      description: Get complete definition of an entity given its GUID.
      tags:
        - Entity
      parameters:
        - name: guid
          in: path
          required: true
          description: The globally unique identifier of the entity
          schema:
            type: string
            format: uuid
        - name: minExtInfo
          in: query
          description: Whether to return minimal information for referred entities
          schema:
            type: boolean
            default: false
        - name: ignoreRelationships
          in: query
          description: Whether to ignore relationships
          schema:
            type: boolean
            default: false
      responses:
        '200':
          description: Entity retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AtlasEntityWithExtInfo'
        '401':
          description: Unauthorized
        '404':
          description: Entity not found
    delete:
      operationId: deleteEntityByGuid
      summary: Microsoft Purview Delete an entity by GUID
      description: Delete an entity identified by its GUID.
      tags:
        - Entity
      parameters:
        - name: guid
          in: path
          required: true
          description: The globally unique identifier of the entity
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Entity deleted successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityMutationResponse'
        '401':
          description: Unauthorized
        '404':
          description: Entity not found
  /api/atlas/v2/entity/bulk:
    get:
      operationId: listEntitiesByGuids
      summary: Microsoft Purview List entities by GUIDs
      description: List entities in bulk identified by their GUIDs.
      tags:
        - Entity
      parameters:
        - name: guid
          in: query
          required: true
          description: List of GUIDs of entities to retrieve
          schema:
            type: array
            items:
              type: string
        - name: minExtInfo
          in: query
          description: Whether to return minimal information for referred entities
          schema:
            type: boolean
            default: false
        - name: ignoreRelationships
          in: query
          description: Whether to ignore relationships
          schema:
            type: boolean
            default: false
      responses:
        '200':
          description: Entities retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AtlasEntitiesWithExtInfo'
        '401':
          description: Unauthorized
    post:
      operationId: bulkCreateOrUpdateEntities
      summary: Microsoft Purview Create or update entities in bulk
      description: >-
        Create or update entities in bulk. Existing entity is matched using its
        unique guid if supplied or by its unique attributes.
      tags:
        - Entity
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AtlasEntitiesWithExtInfo'
      responses:
        '200':
          description: Entities created or updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityMutationResponse'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
    delete:
      operationId: bulkDeleteEntities
      summary: Microsoft Purview Delete entities in bulk
      description: Delete a list of entities in bulk identified by their GUIDs or unique attributes.
      tags:
        - Entity
      parameters:
        - name: guid
          in: query
          required: true
          description: List of GUIDs of entities to delete
          schema:
            type: array
            items:
              type: string
      responses:
        '200':
          description: Entities deleted successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityMutationResponse'
        '401':
          description: Unauthorized
  /api/atlas/v2/entity/guid/{guid}/classification/{classificationName}:
    get:
      operationId: getEntityClassification
      summary: Microsoft Purview Get classification for entity
      description: Get classification for a given entity represented by a GUID.
      tags:
        - Entity
      parameters:
        - name: guid
          in: path
          required: true
          description: The globally unique identifier of the entity
          schema:
            type: string
            format: uuid
        - name: classificationName
          in: path
          required: true
          description: The name of the classification
          schema:
            type: string
      responses:
        '200':
          description: Classification retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AtlasClassification'
        '401':
          description: Unauthorized
        '404':
          description: Not found
    delete:
      operationId: removeEntityClassification
      summary: Microsoft Purview Remove classification from entity
      description: Delete a given classification from an existing entity represented by a GUID.
      tags:
        - Entity
      parameters:
        - name: guid
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: classificationName
          in: path
          required: true
          schema:
            type: string
      responses:
        '204':
          description: Classification removed successfully
        '401':
          description: Unauthorized
        '404':
          description: Not found
  /api/atlas/v2/entity/guid/{guid}/classifications:
    get:
      operationId: listEntityClassifications
      summary: Microsoft Purview List classifications for entity
      description: List classifications for a given entity represented by a GUID.
      tags:
        - Entity
      parameters:
        - name: guid
          in: path
          required: true
          description: The globally unique identifier of the entity
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Classifications retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AtlasClassifications'
        '401':
          description: Unauthorized
        '404':
          description: Not found
    post:
      operationId: addEntityClassifications
      summary: Microsoft Purview Add classifications to entity
      description: Add classifications to an existing entity represented by a GUID.
      tags:
        - Entity
      parameters:
        - name: guid
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/AtlasClassification'
      responses:
        '204':
          description: Classifications added successfully
        '400':
          description: Bad request
        '401':
          description: Unauthorized
    put:
      operationId: updateEntityClassifications
      summary: Microsoft Purview Update classifications on entity
      description: Update classifications to an existing entity represented by a GUID.
      tags:
        - Entity
      parameters:
        - name: guid
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/AtlasClassification'
      responses:
        '204':
          description: Classifications updated successfully
        '400':
          description: Bad request
        '401':
          description: Unauthorized
  /api/atlas/v2/entity/guid/{guid}/labels:
    post:
      operationId: addEntityLabels
      summary: Microsoft Purview Add labels to entity
      description: Add given labels to a given entity identified by its GUID.
      tags:
        - Entity
      parameters:
        - name: guid
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
      responses:
        '204':
          description: Labels added successfully
        '401':
          description: Unauthorized
    put:
      operationId: setEntityLabels
      summary: Microsoft Purview Set labels on entity
      description: Set labels to a given entity identified by its GUID.
      tags:
        - Entity
      parameters:
        - name: guid
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
      responses:
        '204':
          description: Labels set successfully
        '401':
          description: Unauthorized
    delete:
      operationId: removeEntityLabels
      summary: Microsoft Purview Remove labels from entity
      description: Delete given labels from a given entity identified by its GUID.
      tags:
        - Entity
      parameters:
        - name: guid
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
      responses:
        '204':
          description: Labels removed successfully
        '401':
          description: Unauthorized
  /api/atlas/v2/entity/bulk/setClassifications:
    post:
      operationId: bulkSetClassifications
      summary: Microsoft Purview Set classifications on entities in bulk
      description: Set classifications on entities in bulk.
      tags:
        - Entity
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AtlasEntityHeaders'
      responses:
        '200':
          description: Classifications set successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
        '401':
          description: Unauthorized
  /api/atlas/v2/entity/guid/{guid}/businessmetadata:
    post:
      operationId: addOrUpdateBusinessMetadata
      summary: Microsoft Purview Add or update business metadata on entity
      description: Add business metadata to an entity.
      tags:
        - Entity
      parameters:
        - name: guid
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: isOverwrite
          in: query
          description: Whether to overwrite existing business metadata
          schema:
            type: boolean
            default: false
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties:
                type: object
      responses:
        '204':
          description: Business metadata added successfully
        '401':
          description: Unauthorized
    delete:
      operationId: removeBusinessMetadata
      summary: Microsoft Purview Remove business metadata from entity
      description: Remove business metadata from an entity.
      tags:
        - Entity
      parameters:
        - name: guid
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              type: object
              additionalProperties:
                type: object
      responses:
        '204':
          description: Business metadata removed successfully
        '401':
          description: Unauthorized
  /api/atlas/v2/entity/bulk/collection/{collectionId}:
    post:
      operationId: moveEntitiesToCollection
      summary: Microsoft Purview Move entities to collection
      description: Move existing entities to the target collection.
      tags:
        - Entity
      parameters:
        - name: collectionId
          in: path
          required: true
          description: The collection identifier
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MoveEntitiesRequest'
      responses:
        '200':
          description: Entities moved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityMutationResponse'
        '401':
          description: Unauthorized
  /api/atlas/v2/glossary:
    get:
      operationId: listGlossaries
      summary: Microsoft Purview List all glossaries
      description: >-
        Get all glossaries. Recommend using limit/offset to get pagination result.
      tags:
        - Glossary
      parameters:
        - name: limit
          in: query
          description: The page size - by default there is no paging
          schema:
            type: integer
            format: int32
        - name: offset
          in: query
          description: The offset for pagination purpose
          schema:
            type: integer
            format: int32
        - name: sort
          in: query
          description: The sort order - ASC or DESC
          schema:
            type: string
            enum: [ASC, DESC]
        - name: ignoreTermsAndCategories
          in: query
          description: Whether to ignore terms and categories
          schema:
            type: boolean
            default: false
      responses:
        '200':
          description: Glossaries retrieved successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AtlasGlossary'
        '401':
          description: Unauthorized
    post:
      operationId: createGlossary
      summary: Microsoft Purview Create a glossary
      description: Create a glossary.
      tags:
        - Glossary
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AtlasGlossary'
      responses:
        '200':
          description: Glossary created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AtlasGlossary'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
  /api/atlas/v2/glossary/{glossaryId}:
    get:
      operationId: getGlossary
      summary: Microsoft Purview Get glossary by GUID
      description: Get a specific Glossary by its GUID.
      tags:
        - Glossary
      parameters:
        - name: glossaryId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Glossary retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AtlasGlossary'
        '401':
          description: Unauthorized
        '404':
          description: Glossary not found
    put:
      operationId: updateGlossary
      summary: Microsoft Purview Update a glossary
      description: Update the given glossary.
      tags:
        - Glossary
      parameters:
        - name: glossaryId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AtlasGlossary'
      responses:
        '200':
          description: Glossary updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AtlasGlossary'
        '401':
          description: Unauthorized
    delete:
      operationId: deleteGlossary
      summary: Microsoft Purview Delete a glossary
      description: >-
        Delete a glossary. Will delete underlying terms/categories together.
      tags:
        - Glossary
      parameters:
        - name: glossaryId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: Glossary deleted successfully
        '401':
          description: Unauthorized
        '404':
          description: Glossary not found
  /api/atlas/v2/glossary/{glossaryId}/terms:
    get:
      operationId: listGlossaryTerms
      summary: Microsoft Purview List terms in glossary
      description: Get terms belonging to a specific glossary.
      tags:
        - Glossary
      parameters:
        - name: glossaryId
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: limit
          in: query
          schema:
            type: integer
            format: int32
        - name: offset
          in: query
          schema:
            type: integer
            format: int32
        - name: sort
          in: query
          schema:
            type: string
            enum: [ASC, DESC]
      responses:
        '200':
          description: Terms retrieved successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AtlasGlossaryTerm'
        '401':
          description: Unauthorized
  /api/atlas/v2/glossary/{glossaryId}/categories:
    get:
      operationId: listGlossaryCategories
      summary: Microsoft Purview List categories in glossary
      description: Get the categories belonging to a specific glossary.
      tags:
        - Glossary
      parameters:
        - name: glossaryId
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: limit
          in: query
          schema:
            type: integer
            format: int32
        - name: offset
          in: query
          schema:
            type: integer
            format: int32
        - name: sort
          in: query
          schema:
            type: string
            enum: [ASC, DESC]
      responses:
        '200':
          description: Categories retrieved successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AtlasGlossaryCategory'
        '401':
          description: Unauthorized
  /api/atlas/v2/glossary/term:
    post:
      operationId: createGlossaryTerm
      summary: Microsoft Purview Create a glossary term
      description: Create a glossary term.
      tags:
        - Glossary
      parameters:
        - name: includeTermHierarchy
          in: query
          description: Whether to include the term hierarchy
          schema:
            type: boolean
            default: false
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AtlasGlossaryTerm'
      responses:
        '200':
          description: Term created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AtlasGlossaryTerm'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
  /api/atlas/v2/glossary/term/{termId}:
    get:
      operationId: getGlossaryTerm
      summary: Microsoft Purview Get glossary term by GUID
      description: Get a specific glossary term by its GUID.
      tags:
        - Glossary
      parameters:
        - name: termId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Term retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AtlasGlossaryTerm'
        '401':
          description: Unauthorized
        '404':
          description: Term not found
    put:
      operationId: updateGlossaryTerm
      summary: Microsoft Purview Update a glossary term
      description: Update the given glossary term by its GUID.
      tags:
        - Glossary
      parameters:
        - name: termId
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: includeTermHierarchy
          in: query
          schema:
            type: boolean
            default: false
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AtlasGlossaryTerm'
      responses:
        '200':
          description: Term updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AtlasGlossaryTerm'
        '401':
          description: Unauthorized
    delete:
      operationId: deleteGlossaryTerm
      summary: Microsoft Purview Delete a glossary term
      description: Delete a glossary term.
      tags:
        - Glossary
      parameters:
        - name: termId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: Term deleted successfully
        '401':
          description: Unauthorized
  /api/atlas/v2/glossary/terms:
    post:
      operationId: createGlossaryTerms
      summary: Microsoft Purview Create glossary terms in bulk
      description: Create glossary terms in bulk.
      tags:
        - Glossary
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/AtlasGlossaryTerm'
      responses:
        '200':
          description: Terms created successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AtlasGlossaryTerm'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
  /api/atlas/v2/glossary/category:
    post:
      operationId: createGlossaryCategory
      summary: Microsoft Purview Create a glossary category
      description: Create a glossary category.
      tags:
        - Glossary
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AtlasGlossaryCategory'
      responses:
        '200':
          description: Category created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AtlasGlossaryCategory'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
  /api/atlas/v2/glossary/category/{categoryId}:
    get:
      operationId: getGlossaryCategory
      summary: Microsoft Purview Get glossary category by GUID
      description: Get specific glossary category by its GUID.
      tags:
        - Glossary
      parameters:
        - name: categoryId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Category retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AtlasGlossaryCategory'
        '401':
          description: Unauthorized
        '404':
          description: Category not found
    put:
      operationId: updateGlossaryCategory
      summary: Microsoft Purview Update a glossary category
      description: Update the given glossary category by its GUID.
      tags:
        - Glossary
      parameters:
        - name: categoryId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AtlasGlossaryCategory'
      responses:
        '200':
          description: Category updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AtlasGlossaryCategory'
        '401':
          description: Unauthorized
    delete:
      operationId: deleteGlossaryCategory
      summary: Microsoft Purview Delete a glossary category
      description: Delete a glossary category.
      tags:
        - Glossary
      parameters:
        - name: categoryId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: Category deleted successfully
        '401':
          description: Unauthorized
  /api/atlas/v2/glossary/terms/{termId}/assignedEntities:
    get:
      operationId: listEntitiesAssignedWithTerm
      summary: Microsoft Purview List entities assigned with term
      description: List all related objects assigned with the specified term.
      tags:
        - Glossary
      parameters:
        - name: termId
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: limit
          in: query
          schema:
            type: integer
            format: int32
        - name: offset
          in: query
          schema:
            type: integer
            format: int32
        - name: sort
          in: query
          schema:
            type: string
            enum: [ASC, DESC]
      responses:
        '200':
          description: Assigned entities retrieved successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AtlasRelatedObjectId'
        '401':
          description: Unauthorized
    post:
      operationId: assignTermToEntities
      summary: Microsoft Purview Assign term to entities
      description: Assign the given term to the provided list of related objects.
      tags:
        - Glossary
      parameters:
        - name: termId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/AtlasRelatedObjectId'
      responses:
        '204':
          description: Term assigned successfully
        '401':
          description: Unauthorized
    delete:
      operationId: deleteTermAssignmentFromEntities
      summary: Microsoft Purview Remove term assignment from entities
      description: Delete the term assignment for the given list of related objects.
      tags:
        - Glossary
      parameters:
        - name: termId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/AtlasRelatedObjectId'
      responses:
        '204':
          description: Term assignment removed successfully
        '401':
          description: Unauthorized
  /api/search/query:
    post:
      operationId: searchQuery
      summary: Microsoft Purview Search data assets
      description: Get data using search.
      tags:
        - Discovery
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchRequest'
      responses:
        '200':
          description: Search results retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchResult'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
  /api/search/suggest:
    post:
      operationId: searchSuggest
      summary: Microsoft Purview Get search suggestions
      description: Get search suggestions by query criteria.
      tags:
        - Discovery
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SuggestRequest'
      responses:
        '200':
          description: Suggestions retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuggestResult'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
  /api/search/autocomplete:
    post:
      operationId: searchAutoComplete
      summary: Microsoft Purview Get auto complete options
      description: Get auto complete options for search.
      tags:
        - Discovery
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AutoCompleteRequest'
      responses:
        '200':
          description: Auto complete results retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutoCompleteResult'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
  /api/atlas/v2/lineage/{guid}:
    get:
      operationId: getLineageByGuid
      summary: Microsoft Purview Get lineage by GUID
      description: Get lineage info of the entity specified by GUID.
      tags:
        - Lineage
      parameters:
        - name: guid
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: direction
          in: query
          required: true
          description: The direction of lineage (INPUT, OUTPUT, BOTH)
          schema:
            type: string
            enum: [INPUT, OUTPUT, BOTH]
        - name: depth
          in: query
          description: The number of hops for lineage
          schema:
            type: integer
            format: int32
            default: 3
      responses:
        '200':
          description: Lineage info retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AtlasLineageInfo'
        '401':
          description: Unauthorized
        '404':
          description: Entity not found
  /api/atlas/v2/lineage/{guid}/next:
    get:
      operationId: getLineageNextPage
      summary: Microsoft Purview Get next page of lineage
      description: Return immediate next page lineage info about entity with pagination.
      tags:
        - Lineage
      parameters:
        - name: guid
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: direction
          in: query
          required: true
          schema:
            type: string
            enum: [INPUT, OUTPUT, BOTH]
        - name: offset
          in: query
          schema:
            type: integer
            format: int32
        - name: limit
          in: query
          schema:
            type: integer
            format: int32
      responses:
        '200':
          description: Next page of lineage retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AtlasLineageInfo'
        '401':
          description: Unauthorized
  /api/atlas/v2/relationship:
    post:
      operationId: createRelationship
      summary: Microsoft Purview Create a relationship
      description: Create a new relationship between entities.
      tags:
        - Relationship
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AtlasRelationship'
      responses:
        '200':
          description: Relationship created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AtlasRelationship'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
    put:
      operationId: updateRelationship
      summary: Microsoft Purview Update a relationship
      description: Update an existing relationship between entities.
      tags:
        - Relationship
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AtlasRelationship'
      responses:
        '200':
          description: Relationship updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AtlasRelationship'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
  /api/atlas/v2/relationship/guid/{guid}:
    get:
      operationId: getRelationship
      summary: Microsoft Purview Get relationship by GUID
      description: Get relationship information between entities by its GUID.
      tags:
        - Relationship
      parameters:
        - name: guid
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: extendedInfo
          in: query
          description: Whether to return extended information
          schema:
            type: boolean
            default: false
      responses:
        '200':
          description: Relationship retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AtlasRelationshipWithExtInfo'
        '401':
          description: Unauthorized
        '404':
          description: Relationship not found
    delete:
      operationId: deleteRelationship
      summary: Microsoft Purview Delete a relationship
      description: Delete a relationship between entities by its GUID.
      tags:
        - Relationship
      parameters:
        - name: guid
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: Relationship deleted successfully
        '401':
          description: Unauthorized
        '404':
          description: Relationship not found
  /api/atlas/v2/types/typedefs:
    get:
      operationId: listTypeDefinitions
      summary: Microsoft Purview List all type definitions
      description: List all type definitions in bulk.
      tags:
        - Type
      parameters:
        - name: includeTermTemplate
          in: query
          description: Whether to include term template definitions
          schema:
            type: boolean
            default: false
        - name: type
          in: query
          description: Type category filter
          schema:
            type: string
            enum: [classification, entity, enum, relationship, struct, term_template]
      responses:
        '200':
          description: Type definitions retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AtlasTypesDef'
        '401':
          description: Unauthorized
    post:
      operationId: bulkCreateTypeDefinitions
      summary: Microsoft Purview Create type definitions in bulk
      description: Create all atlas type definitions in bulk.
      tags:
        - Type
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AtlasTypesDef'
      responses:
        '200':
          description: Type definitions created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AtlasTypesDef'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
    put:
      operationId: bulkUpdateTypeDefinitions
      summary: Microsoft Purview Update type definitions in bulk
      description: Update all types in bulk.
      tags:
        - Type
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AtlasTypesDef'
      responses:
        '200':
          description: Type definitions updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AtlasTypesDef'
        '401':
          description: Unauthorized
    delete:
      operationId: bulkDeleteTypeDefinitions
      summary: Microsoft Purview Delete type definitions in bulk
      description: Delete API for all types in bulk.
      tags:
        - Type
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AtlasTypesDef'
      responses:
        '204':
          description: Type definitions deleted successfully
        '401':
          description: Unauthorized
  /api/atlas/v2/types/typedefs/headers:
    get:
      operationId: listTypeDefinitionHeaders
      summary: Microsoft Purview List type definition headers
      description: List all type definitions returned as a list of minimal information header.
      tags:
        - Type
      parameters:
        - name: includeTermTemplate
          in: query
          schema:
            type: boolean
            default: false
        - name: type
          in: query
          schema:
            type: string
            enum: [classification, entity, enum, relationship, struct, term_template]
      responses:
        '200':
          description: Type definition headers retrieved successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AtlasTypeDefHeader'
        '401':
          description: Unauthorized
  /api/atlas/v2/types/typedef/guid/{guid}:
    get:
      operationId: getTypeDefinitionByGuid
      summary: Microsoft Purview Get type definition by GUID
      description: Get the type definition for the given GUID.
      tags:
        - Type
      parameters:
        - name: guid
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Type definition retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AtlasTypeDef'
        '401':
          description: Unauthorized
        '404':
          description: Type definition not found
  /api/atlas/v2/types/typedef/name/{name}:
    get:
      operationId: getTypeDefinitionByName
      summary: Microsoft Purview Get type definition by name
      description: Get the type definition by its name (unique).
      tags:
        - Type
      parameters:
        - name: name
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Type definition retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AtlasTypeDef'
        '401':
          description: Unauthorized
        '404':
          description: Type definition not found
    delete:
      operationId: deleteTypeDefinitionByName
      summary: Microsoft Purview Delete type definition by name
      description: Delete API for type identified by its name.
      tags:
        - Type
      parameters:
        - name: name
          in: path
          required: true
          schema:
            type: string
      responses:
        '204':
          description: Type definition deleted successfully
        '401':
          description: Unauthorized
        '404':
          description: Type definition not found
components:
  securitySchemes:
    oauth2:
      type: oauth2
      description: Azure Active Directory OAuth2 authentication
      flows:
        clientCredentials:
          tokenUrl: https://login.microsoftonline.com/{tenantId}/oauth2/v2.0/token
          scopes:
            https://purview.azure.net/.default: Access Microsoft Purview
  schemas:
    AtlasEntity:
      type: object
      description: An instance of an entity along with extended info such as classification and referenced entities
      properties:
        attributes:
          type: object
          description: The attributes of the entity
          additionalProperties: true
        typeName:
          type: string
          description: The name of the type
        lastModifiedTS:
          type: string
          description: ETag for concurrency control
        businessAttributes:
          type: object
          additionalProperties: true
        classifications:
          type: array
          items:
            $ref: '#/components/schemas/AtlasClassification'
        createTime:
          type: integer
          format: int64
        createdBy:
          type: string
        guid:
          type: string
          format: uuid
        homeId:
          type: string
        labels:
          type: array
          items:
            type: string
        meanings:
          type: array
          items:
            $ref: '#/components/schemas/AtlasTermAssignmentHeader'
        provenanceType:
          type: integer
          format: int32
        proxy:
          type: boolean
        relationshipAttributes:
          type: object
          additionalProperties: true
        status:
          type: string
          enum: [ACTIVE, DELETED]
        updateTime:
          type: integer
          format: int64
        updatedBy:
          type: string
        version:
          type: integer
          format: int64
        collectionId:
          type: string
    AtlasEntityWithExtInfo:
      type: object
      description: An instance of an entity along with extended info
      properties:
        entity:
          $ref: '#/components/schemas/AtlasEntity'
        referredEntities:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/AtlasEntity'
    AtlasEntitiesWithExtInfo:
      type: object
      description: A collection of entities with extended info
      properties:
        entities:
          type: array
          items:
            $ref: '#/components/schemas/AtlasEntity'
        referredEntities:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/AtlasEntity'
    EntityMutationResponse:
      type: object
      description: The mutation response result of an entity operation
      properties:
        guidAssignments:
          type: object
          additionalProperties:
            type: string
        mutatedEntities:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/AtlasEntityHeader'
        partialUpdatedEntities:
          type: array
          items:
            $ref: '#/components/schemas/AtlasEntityHeader'
    AtlasEntityHeader:
      type: object
      description: An instance of an entity header
      properties:
        attributes:
          type: object
          additionalProperties: true
        typeName:
          type: string
        lastModifiedTS:
          type: string
        classificationNames:
          type: array
          items:
            type: string
        classifications:
          type: array
          items:
            $ref: '#/components/schemas/AtlasClassification'
        displayText:
          type: string
        guid:
          type: string
          format: uuid
        labels:
          type: array
          items:
            type: string
        meaningNames:
          type: array
          items:
            type: string
        meanings:
          type: array
          items:
            $ref: '#/components/schemas/AtlasTermAssignmentHeader'
        status:
          type: string
          enum: [ACTIVE, DELETED]
    AtlasEntityHeaders:
      type: object
      description: Collection of entity headers for bulk operations
      properties:
        guidHeaderMap:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/AtlasEntityHeader'
    AtlasClassification:
      type: object
      description: A classification instance
      properties:
        attributes:
          type: object
          additionalProperties: true
        typeName:
          type: string
        lastModifiedTS:
          type: string
        entityGuid:
          type: string
          format: uuid
        entityStatus:
          type: string
          enum: [ACTIVE, DELETED]
        propagate:
          type: boolean
        removePropagationsOnEntityDelete:
          type: boolean
        validityPeriods:
          type: array
          items:
            $ref: '#/components/schemas/TimeBoundary'
    AtlasClassifications:
      type: object
      description: A paginated list of classifications
      properties:
        list:
          type: array
          items:
            $ref: '#/components/schemas/AtlasClassification'
        pageSize:
          type: integer
          format: int32
        sortBy:
          type: string
        sortType:
          type: string
        startIndex:
          type: integer
          format: int64
        totalCount:
          type: integer
          format: int64
    TimeBoundary:
      type: object
      properties:
        endTime:
          type: string
        startTime:
          type: string
        timeZone:
          type: string
    AtlasTermAssignmentHeader:
      type: object
      properties:
        confidence:
          type: integer
          format: int32
        createdBy:
          type: string
        description:
          type: string
        displayText:
          type: string
        expression:
          type: string
        relationGuid:
          type: string
          format: uuid
        status:
          type: string
          enum: [DISCOVERED, PROPOSED, IMPORTED, VALIDATED, DEPRECATED, OBSOLETE, OTHER]
        steward:
          type: string
        termGuid:
          type: string
          format: uuid
    AtlasGlossary:
      type: object
      description: A glossary object
      properties:
        guid:
          type: string
          format: uuid
        qualifiedName:
          type: string
        name:
          type: string
        shortDescription:
          type: string
        longDescription:
          type: string
        language:
          type: string
        usage:
          type: string
        terms:
          type: array
          items:
            $ref: '#/components/schemas/AtlasRelatedTermHeader'
        categories:
          type: array
          items:
            $ref: '#/components/schemas/AtlasRelatedCategoryHeader'
    AtlasGlossaryTerm:
      type: object
      description: A glossary term
      properties:
        guid:
          type: string
          format: uuid
        qualifiedName:
          type: string
        name:
          type: string
        shortDescription:
          type: string
        longDescription:
          type: string
        abbreviation:
          type: string
        usage:
          type: string
        status:
          type: string
          enum: [Draft, Approved, Alert, Expired]
        anchor:
          $ref: '#/components/schemas/AtlasGlossaryHeader'
        categories:
          type: array
          items:
            $ref: '#/components/schemas/AtlasTermCategorizationHeader'
        classifications:
          type: array
          items:
            $ref: '#/components/schemas/AtlasClassification'
        assignedEntities:
          type: array
          items:
            $ref: '#/components/schemas/AtlasRelatedObjectId'
        resources:
          type: array
          items:
            $ref: '#/components/schemas/ResourceLink'
    AtlasGlossaryCategory:
      type: object
      description: A glossary category
      properties:
        guid:
          type: string
          format: uuid
        qualifiedName:
          type: string
        name:
          type: string
        shortDescription:
          type: string
        longDescription:
          type: string
        anchor:
          $ref: '#/components/schemas/AtlasGlossaryHeader'
        parentCategory:
          $ref: '#/components/schemas/AtlasRelatedCategoryHeader'
        childrenCategories:
          type: array
          items:
            $ref: '#/components/schemas/AtlasRelatedCategoryHeader'
        terms:
          type: array
          items:
            $ref: '#/components/schemas/AtlasRelatedTermHeader'
    AtlasGlossaryHeader:
      type: object
      properties:
        displayText:
          type: string
        glossaryGuid:
          type: string
          format: uuid
        relationGuid:
          type: string
          format: uuid
    AtlasRelatedTermHeader:
      type: object
      properties:
        description:
          type: string
        displayText:
          type: string
        expression:
          type: string
        relationGuid:
          type: string
          format: uuid
        status:
          type: string
          enum: [DRAFT, ACTIVE, DEPRECATED, OBSOLETE, OTHER]
        steward:
          type: string
        termGuid:
          type: string
          format: uuid
    AtlasRelatedCategoryHeader:
      type: object
      properties:
        categoryGuid:
          type: string
          format: uuid
        description:
          type: string
        displayText:
          type: string
        parentCategoryGuid:
          type: string
          format: uuid
        relationGuid:
          type: string
          format: uuid
    AtlasTermCategorizationHeader:
      type: object
      properties:
        categoryGuid:
          type: string
          format: uuid
        description:
          type: string
        displayText:
          type: string
        relationGuid:
          type: string
          format: uuid
        status:
          type: string
    AtlasRelatedObjectId:
      type: object
      properties:
        displayText:
          type: string
        guid:
          type: string
          format: uuid
        relationshipAttributes:
          type: object
        relationshipGuid:
          type: string
          format: uuid
        relationshipStatus:
          type: string
          enum: [ACTIVE, DELETED]
        relationshipType:
          type: string
        typeName:
          type: string
        uniqueAttributes:
          type: object
          additionalProperties: true
    ResourceLink:
      type: object
      properties:
        displayName:
          type: string
        url:
          type: string
          format: uri
    AtlasRelationship:
      type: object
      description: A relationship between entities
      properties:
        attributes:
          type: object
          additionalProperties: true
        typeName:
          type: string
        lastModifiedTS:
          type: string
        createTime:
          type: integer
          format: int64
        createdBy:
          type: string
        end1:
          $ref: '#/components/schemas/AtlasObjectId'
        end2:
          $ref: '#/components/schemas/AtlasObjectId'
        guid:
          type: string
          format: uuid
        homeId:
          type: string
        label:
          type: string
        provenanceType:
          type: integer
          format: int32
        status:
          type: string
          enum: [ACTIVE, DELETED]
        updateTime:
          type: integer
          format: int64
        updatedBy:
          type: string
        version:
          type: integer
          format: int64
    AtlasRelationshipWithExtInfo:
      type: object
      properties:
        referredEntities:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/AtlasEntity'
        relationship:
          $ref: '#/components/schemas/AtlasRelationship'
    AtlasObjectId:
      type: object
      properties:
        guid:
          type: string
          format: uuid
        typeName:
          type: string
        uniqueAttributes:
          type: object
          additionalProperties: true
    AtlasLineageInfo:
      type: object
      description: Lineage information for an entity
      properties:
        baseEntityGuid:
          type: string
          format: uuid
        childrenCount:
          type: integer
          format: int32
        guidEntityMap:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/AtlasEntityHeader'
        lineageDepth:
          type: integer
          format: int32
        lineageDirection:
          type: string
          enum: [INPUT, OUTPUT, BOTH]
        lineageWidth:
          type: integer
          format: int32
        parentRelations:
          type: array
          items:
            $ref: '#/components/schemas/ParentRelation'
        relations:
          type: array
          items:
            $ref: '#/components/schemas/LineageRelation'
    LineageRelation:
      type: object
      properties:
        fromEntityId:
          type: string
          format: uuid
        relationshipId:
          type: string
          format: uuid
        toEntityId:
          type: string
          format: uuid
    ParentRelation:
      type: object
      properties:
        childEntityId:
          type: string
          format: uuid
        parentEntityId:
          type: string
          format: uuid
        relationshipId:
          type: string
          format: uuid
    SearchRequest:
      type: object
      description: Search request payload
      properties:
        keywords:
          type: string
        offset:
          type: integer
          format: int32
        limit:
          type: integer
          format: int32
        filter:
          type: object
        facets:
          type: array
          items:
            $ref: '#/components/schemas/SearchFacetItem'
        taxonomySetting:
          type: object
    SearchResult:
      type: object
      description: Search result
      properties:
        searchCount:
          type: integer
          format: int32
        searchFacets:
          type: object
        value:
          type: array
          items:
            $ref: '#/components/schemas/SearchResultValue'
    SearchResultValue:
      type: object
      properties:
        searchScore:
          type: number
          format: float
        searchHighlights:
          type: object
        objectType:
          type: string
        createTime:
          type: integer
          format: int64
        updateTime:
          type: integer
          format: int64
        id:
          type: string
        name:
          type: string
        qualifiedName:
          type: string
        entityType:
          type: string
        description:
          type: string
        classification:
          type: array
          items:
            type: string
        label:
          type: array
          items:
            type: string
        term:
          type: array
          items:
            $ref: '#/components/schemas/TermSearchResultValue'
        owner:
          type: string
        assetType:
          type: array
          items:
            type: string
    TermSearchResultValue:
      type: object
      properties:
        name:
          type: string
        glossaryName:
          type: string
        guid:
          type: string
          format: uuid
    SearchFacetItem:
      type: object
      properties:
        count:
          type: integer
          format: int32
        facet:
          type: string
        sort:
          type: object
    SuggestRequest:
      type: object
      properties:
        keywords:
          type: string
        limit:
          type: integer
          format: int32
        filter:
          type: object
    SuggestResult:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/SearchResultValue'
    AutoCompleteRequest:
      type: object
      properties:
        keywords:
          type: string
        limit:
          type: integer
          format: int32
        filter:
          type: object
    AutoCompleteResult:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/AutoCompleteResultValue'
    AutoCompleteResultValue:
      type: object
      properties:
        text:
          type: string
        queryPlusText:
          type: string
    AtlasTypesDef:
      type: object
      description: The definitions of types
      properties:
        businessMetadataDefs:
          type: array
          items:
            $ref: '#/components/schemas/AtlasTypeDef'
        classificationDefs:
          type: array
          items:
            $ref: '#/components/schemas/AtlasTypeDef'
        entityDefs:
          type: array
          items:
            $ref: '#/components/schemas/AtlasTypeDef'
        enumDefs:
          type: array
          items:
            $ref: '#/components/schemas/AtlasTypeDef'
        relationshipDefs:
          type: array
          items:
            $ref: '#/components/schemas/AtlasTypeDef'
        structDefs:
          type: array
          items:
            $ref: '#/components/schemas/AtlasTypeDef'
        termTemplateDefs:
          type: array
          items:
            $ref: '#/components/schemas/AtlasTypeDef'
    AtlasTypeDef:
      type: object
      description: A type definition
      properties:
        category:
          type: string
          enum: [PRIMITIVE, OBJECT_ID_TYPE, ENUM, STRUCT, CLASSIFICATION, ENTITY, ARRAY, MAP, RELATIONSHIP, TERM_TEMPLATE]
        createTime:
          type: integer
          format: int64
        createdBy:
          type: string
        dateFormatter:
          type: object
        description:
          type: string
        guid:
          type: string
          format: uuid
        name:
          type: string
        options:
          type: object
          additionalProperties:
            type: string
        typeVersion:
          type: string
        updateTime:
          type: integer
          format: int64
        updatedBy:
          type: string
        version:
          type: integer
          format: int64
        lastModifiedTS:
          type: string
    AtlasTypeDefHeader:
      type: object
      properties:
        category:
          type: string
        guid:
          type: string
          format: uuid
        name:
          type: string
    MoveEntitiesRequest:
      type: object
      properties:
        entityGuids:
          type: array
          items:
            type: string
            format: uuid