Microsoft Purview

Microsoft Purview Entity API

Operations for managing catalog entities

GitHub OpenAPI
Business capability
Data Governance Management BC-610.10

Operations 19

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /api/atlas/v2/entity Create or update a single catalog entity · Microsoft Purview Create or update an entity #
Ask an LLM
“How do I register one data asset in the Purview catalog?”
“Will Purview update an asset that already exists with the same qualifiedName?”
Tell an agent
Create or update the catalog entity {entity}.
Upsert entity {entity} together with referred entities {refs}.
GET /api/atlas/v2/entity/guid/{guid} Get an entity's full definition · Microsoft Purview Get entity by GUID #
Ask an LLM
“How can I read everything Purview knows about one asset by its GUID?”
“Can I fetch an entity without its relationships to keep the response small?”
Tell an agent
Get the full definition of entity {guid}.
Fetch entity {guid} ignoring relationships: {ignore}.
DELETE /api/atlas/v2/entity/guid/{guid} Delete one entity by GUID · Microsoft Purview Delete an entity by GUID #
Ask an LLM
“Can I remove a single asset from the catalog using its GUID?”
“What is the way to delete one entity that was registered by mistake?”
Tell an agent destructive · confirm first
Delete the single entity {guid}.
Remove asset {guid} from the catalog.
GET /api/atlas/v2/entity/bulk Fetch several entities by their GUIDs · Microsoft Purview List entities by GUIDs #
Ask an LLM
“Can I retrieve many assets in one call when I have a list of GUIDs?”
“Which call returns multiple entities at once with minimal extra info?”
Tell an agent
Get the entities with GUIDs {guids}.
Fetch entities {guids} in bulk with minimal extended info {min}.
POST /api/atlas/v2/entity/bulk Create or update many entities at once · Microsoft Purview Create or update entities in bulk #
Ask an LLM
“How do I load a batch of assets into the catalog in one request?”
“Can I upsert many entities together with the entities they reference?”
Tell an agent
Bulk create or update entities {entities}.
Upsert the batch {entities} with referred entities {refs}.
DELETE /api/atlas/v2/entity/bulk Delete many entities at once · Microsoft Purview Delete entities in bulk #
Ask an LLM
“Can I delete a whole list of assets in one call?”
“Is there a bulk delete for entities by GUID?”
Tell an agent destructive · confirm first
Bulk delete the entities with GUIDs {guids}.
Remove all of these assets from the catalog in one go: {guids}.
GET /api/atlas/v2/entity/guid/{guid}/classification/{classificationName} Get one classification on an entity · Microsoft Purview Get classification for entity #
Ask an LLM
“Does a given asset carry a specific classification?”
“What are the details of one classification applied to an entity?”
Tell an agent
Get classification {classification} on entity {guid}.
Check whether asset {guid} has the {classification} classification.
DELETE /api/atlas/v2/entity/guid/{guid}/classification/{classificationName} Remove a classification from an entity · Microsoft Purview Remove classification from entity #
Ask an LLM
“How do I take a wrong classification off an asset?”
“Can I delete just one classification from an entity?”
Tell an agent destructive · confirm first
Remove classification {classification} from entity {guid}.
Unclassify asset {guid} as {classification}.
GET /api/atlas/v2/entity/guid/{guid}/classifications List all classifications on an entity · Microsoft Purview List classifications for entity #
Ask an LLM
“What classifications have been applied to a given asset?”
“Which sensitive data types were detected on an entity?”
Tell an agent
List the classifications on entity {guid}.
Show every classification tagged on asset {guid}.
POST /api/atlas/v2/entity/guid/{guid}/classifications Add classifications to an entity · Microsoft Purview Add classifications to entity #
Ask an LLM
“How do I tag an asset with additional classifications?”
“Can I add new classifications to one entity by GUID?”
Tell an agent
Add classifications to entity {guid}.
Tag asset {guid} with new classifications.
PUT /api/atlas/v2/entity/guid/{guid}/classifications Update existing classifications on an entity · Microsoft Purview Update classifications on entity #
Ask an LLM
“How do I change the attributes of classifications already on an asset?”
“Can I modify classifications an entity already has?”
Tell an agent
Update the existing classifications on entity {guid}.
Modify classifications already applied to asset {guid}.
POST /api/atlas/v2/entity/guid/{guid}/labels Add labels to an entity · Microsoft Purview Add labels to entity #
Ask an LLM
“Can I append labels to an asset without touching its current ones?”
“How do I add a label to a single entity?”
Tell an agent
Add labels to entity {guid}.
Append new labels to asset {guid} keeping the existing ones.
PUT /api/atlas/v2/entity/guid/{guid}/labels Replace the labels on an entity · Microsoft Purview Set labels on entity #
Ask an LLM
“How do I overwrite all labels on an asset with a new set?”
“Can I set an entity's labels to exactly a given list?”
Tell an agent
Set the labels on entity {guid}, replacing any existing ones.
Overwrite asset {guid}'s labels.
DELETE /api/atlas/v2/entity/guid/{guid}/labels Remove labels from an entity · Microsoft Purview Remove labels from entity #
Ask an LLM
“How do I delete specific labels from an asset?”
“Can I strip labels off one entity?”
Tell an agent destructive · confirm first
Remove labels from entity {guid}.
Strip the given labels off asset {guid}.
POST /api/atlas/v2/entity/bulk/setClassifications Set classifications on many entities · Microsoft Purview Set classifications on entities in bulk #
Ask an LLM
“Can I classify a batch of assets in one request?”
“How do I apply classifications across multiple entities at once?”
Tell an agent
Set classifications in bulk using the entity header map {map}.
Apply classifications to many assets via {map}.
POST /api/atlas/v2/entity/guid/{guid}/businessmetadata Add or update business metadata on an entity · Microsoft Purview Add or update business metadata on entity #
Ask an LLM
“How do I attach business metadata attributes to an asset?”
“Can I overwrite an entity's business metadata instead of merging it?”
Tell an agent
Add business metadata to entity {guid}.
Set business metadata on asset {guid} with overwrite set to {overwrite}.
DELETE /api/atlas/v2/entity/guid/{guid}/businessmetadata Remove business metadata from an entity · Microsoft Purview Remove business metadata from entity #
Ask an LLM
“How do I clear business metadata from an asset?”
“Can I delete the business attributes attached to one entity?”
Tell an agent destructive · confirm first
Remove business metadata from entity {guid}.
Clear the business attributes on asset {guid}.
POST /api/atlas/v2/entity/bulk/collection/{collectionId} Move entities into a collection · Microsoft Purview Move entities to collection #
Ask an LLM
“How do I move assets from one Purview collection to another?”
“Can I relocate several entities to a target collection at once?”
Tell an agent
Move entities {guids} to collection {collection}.
Relocate these assets into collection {collection}: {guids}.
GET /api/atlas/v2/entity/guid/{guid}/header Get an entity's header summary · Microsoft Purview Get entity header #
Ask an LLM
“Is there a lightweight way to get just an asset's name, type and status?”
“What does the header of an entity contain?”
Tell an agent
Get the header for entity {guid}.
Show only the summary header of asset {guid}.

Documentation

📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/
📖
Authentication
https://learn.microsoft.com/en-us/purview/tutorial-using-rest-apis
📖
GettingStarted
https://learn.microsoft.com/en-us/purview/data-gov-api-create-assets
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/scanning
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/account
📖
Authentication
https://learn.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-client-creds-grant-flow
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/datamap
📖
GettingStarted
https://learn.microsoft.com/en-us/purview/legacy/how-to-purview-custom-lineage-api-user-guide
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/metadatapolicies
📖
GettingStarted
https://learn.microsoft.com/en-us/purview/legacy/tutorial-metadata-policy-collections-apis
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/workflow
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/unified-catalog-api-overview
📖
Authentication
https://learn.microsoft.com/en-us/purview/data-gov-api-rest-data-plane
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/unified-catalog-data-quality
📖
Documentation
https://learn.microsoft.com/en-us/graph/api/resources/security-ediscovery-apioverview?view=graph-rest-1.0
📖
Authentication
https://learn.microsoft.com/en-us/graph/security-ediscovery-appauthsetup
📖
GettingStarted
https://learn.microsoft.com/en-us/purview/edisc-ref-api-guide
📖
Documentation
https://learn.microsoft.com/en-us/graph/security-information-protection-overview
📖
Documentation
https://learn.microsoft.com/en-us/graph/security-datasecurityandgovernance-overview
📖
GettingStarted
https://learn.microsoft.com/en-us/purview/developer/use-the-api
📖
Documentation
https://learn.microsoft.com/en-us/graph/api/resources/security-recordsmanagement-overview?view=graph-rest-1.0

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/microsoft-purview/refs/heads/main/openapi/microsoft-purview-entity-api-openapi.yml

Other Resources

🔗
Pricing
https://azure.microsoft.com/en-us/pricing/details/purview/
🔗
Reference
https://learn.microsoft.com/en-us/purview/data-map-data-sources
🔗
Reference
https://learn.microsoft.com/en-us/purview/unified-catalog-data-quality
🔗
Reference
https://learn.microsoft.com/en-us/purview/sensitivity-labels
🔗
Reference
https://learn.microsoft.com/en-us/purview/developer/
🔗
Reference
https://learn.microsoft.com/en-us/graph/compliance-concept-overview

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/microsoft-purview:microsoft-purview-entity-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

microsoft-purview-entity-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Microsoft Purview Entity API
  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/
  version: '1.0'
  description: 'Operations tagged Entity across 2 of this provider''s published API definitions: microsoft-purview-catalog-openapi.yml, microsoft-purview-data-map-openapi.yml. Each path carries the servers of the definition it was published in.'
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
- url: https://{accountName}.purview.azure.com/datamap
  description: Microsoft Purview Data Map API endpoint
  variables:
    accountName:
      description: The name of the Microsoft Purview account
      default: myaccount
security:
- oauth2: []
tags:
- name: Entity
  description: Operations for managing catalog entities
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
    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
  /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
    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
  /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
    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
  /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
    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
  /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
    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
  /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
    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
  /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
    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
  /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
    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
  /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
    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
  /api/atlas/v2/entity/guid/{guid}/header:
    get:
      operationId: entityGetHeader
      summary: Microsoft Purview Get entity header
      description: Get entity header given its GUID.
      tags:
      - Entity
      parameters:
      - name: guid
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: api-version
        in: query
        required: true
        schema:
          type: string
          default: '2023-09-01'
      responses:
        '200':
          description: Entity header retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AtlasEntityHeader_2'
        '401':
          description: Unauthorized
        '404':
          description: Not found
    servers:
    - url: https://{accountName}.purview.azure.com/datamap
      description: Microsoft Purview Data Map API endpoint
      variables:
        accountName:
          description: The name of the Microsoft Purview account
          default: myaccount
components:
  schemas:
    TimeBoundary:
      type: object
      properties:
        endTime:
          type: string
        startTime:
          type: string
        timeZone:
          type: string
    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'
    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'
    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
    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'
    AtlasEntityHeaders:
      type: object
      description: Collection of entity headers for bulk operations
      properties:
        guidHeaderMap:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/AtlasEntityHeader'
    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
    MoveEntitiesRequest:
      type: object
      properties:
        entityGuids:
          type: array
          items:
            type: string
            format: uuid
    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
    AtlasClassification_2:
      type: object
      properties:
        attributes:
          type: object
          additionalProperties: true
        typeName:
          type: string
        entityGuid:
          type: string
          format: uuid
        propagate:
          type: boolean
    AtlasEntity_2:
      type: object
      properties:
        attributes:
          type: object
          additionalProperties: true
        typeName:
          type: string
        lastModifiedTS:
          type: string
        businessAttributes:
          type: object
          additionalProperties: true
        classifications:
          type: array
          items:
            $ref: '#/components/schemas/AtlasClassification_2'
        createTime:
          type: integer
          format: int64
        createdBy:
          type: string
        guid:
          type: string
          format: uuid
        labels:
          type: array
          items:
            type: string
        meanings:
          type: array
          items:
            $ref: '#/components/schemas/AtlasTermAssignmentHeader_2'
        status:
          type: string
          enum:
          - ACTIVE
          - DELETED
        updateTime:
          type: integer
          format: int64
        updatedBy:
          type: string
        version:
          type: integer
          format: int64
    AtlasEntityWithExtInfo_2:
      type: object
      properties:
        entity:
          $ref: '#/components/schemas/AtlasEntity_2'
        referredEntities:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/AtlasEntity_2'
    AtlasEntityHeader_2:
      type: object
      properties:
        attributes:
          type: object
          additionalProperties: true
        typeName:
          type: string
        classificationNames:
          type: array
          items:
            type: string
        displayText:
          type: string
        guid:
          type: string
          format: uuid
        labels:
          type: array
          items:
            type: string
        status:
          type: string
          enum:
          - ACTIVE
          - DELETED
    AtlasEntitiesWithExtInfo_2:
      type: object
      properties:
        entities:
          type: array
          items:
            $ref: '#/components/schemas/AtlasEntity_2'
        referredEntities:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/AtlasEntity_2'
    AtlasTermAssignmentHeader_2:
      type: object
      properties:
        confidence:
          type: integer
          format: int32
        displayText:
          type: string
        relationGuid:
          type: string
          format: uuid
        status:
          type: string
        termGuid:
          type: string
          format: uuid
    AtlasClassifications_2:
      type: object
      properties:
        list:
          type: array
          items:
            $ref: '#/components/schemas/AtlasClassification_2'
        pageSize:
          type: integer
          format: int32
        totalCount:
          type: integer
          format: int64
    EntityMutationResponse_2:
      type: object
      properties:
        guidAssignments:
          type: object
          additionalProperties:
            type: string
        mutatedEntities:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/AtlasEntityHeader_2'
  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
x-refined-from:
- microsoft-purview-catalog-openapi.yml
- microsoft-purview-data-map-openapi.yml