How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Microsoft Purview Entity API

Operations for managing catalog entities

Microsoft Purview Entity API is one of 44 APIs that Microsoft Purview publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Entity. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, pricing, a getting-started guide, and an API reference.

This API exposes 19 operations across 10 paths, and defines 19 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://{accountName}.purview.azure.com/catalog, https://{accountName}.purview.azure.com/datamap.

19 operations 10 paths 19 schemas 5 DELETE5 GET7 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://{account-name}.purview.azure.com
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Microsoft Purview Entity API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the clientCredentials flow, exposing 1 scope. By default, every request must be authenticated.

  • oauth2 — Azure Active Directory OAuth2 authentication

Paths & Operations 19

Across 10 paths, the API surfaces 19 operations — 5 DELETE, 5 GET, 7 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Entity 19

Operations for managing catalog entities

POST
/api/atlas/v2/entity
Microsoft Purview Create or update an entity
createOrUpdateEntity body → 200400401404
GET
/api/atlas/v2/entity/guid/{guid}
Microsoft Purview Get entity by GUID
getEntityByGuid 3 params → 200401404
DELETE
/api/atlas/v2/entity/guid/{guid}
Microsoft Purview Delete an entity by GUID
deleteEntityByGuid 1 param → 200401404
GET
/api/atlas/v2/entity/bulk
Microsoft Purview List entities by GUIDs
listEntitiesByGuids 3 params → 200401
POST
/api/atlas/v2/entity/bulk
Microsoft Purview Create or update entities in bulk
bulkCreateOrUpdateEntities body → 200400401
DELETE
/api/atlas/v2/entity/bulk
Microsoft Purview Delete entities in bulk
bulkDeleteEntities 1 param → 200401
GET
/api/atlas/v2/entity/guid/{guid}/classification/{classificationName}
Microsoft Purview Get classification for entity
getEntityClassification 2 params → 200401404
DELETE
/api/atlas/v2/entity/guid/{guid}/classification/{classificationName}
Microsoft Purview Remove classification from entity
removeEntityClassification 2 params → 204401404
GET
/api/atlas/v2/entity/guid/{guid}/classifications
Microsoft Purview List classifications for entity
listEntityClassifications 1 param → 200401404
POST
/api/atlas/v2/entity/guid/{guid}/classifications
Microsoft Purview Add classifications to entity
addEntityClassifications 1 param body → 204400401
PUT
/api/atlas/v2/entity/guid/{guid}/classifications
Microsoft Purview Update classifications on entity
updateEntityClassifications 1 param body → 204400401
POST
/api/atlas/v2/entity/guid/{guid}/labels
Microsoft Purview Add labels to entity
addEntityLabels 1 param body → 204401
PUT
/api/atlas/v2/entity/guid/{guid}/labels
Microsoft Purview Set labels on entity
setEntityLabels 1 param body → 204401
DELETE
/api/atlas/v2/entity/guid/{guid}/labels
Microsoft Purview Remove labels from entity
removeEntityLabels 1 param body → 204401
POST
/api/atlas/v2/entity/bulk/setClassifications
Microsoft Purview Set classifications on entities in bulk
bulkSetClassifications body → 200401
POST
/api/atlas/v2/entity/guid/{guid}/businessmetadata
Microsoft Purview Add or update business metadata on entity
addOrUpdateBusinessMetadata 2 params body → 204401
DELETE
/api/atlas/v2/entity/guid/{guid}/businessmetadata
Microsoft Purview Remove business metadata from entity
removeBusinessMetadata 1 param body → 204401
POST
/api/atlas/v2/entity/bulk/collection/{collectionId}
Microsoft Purview Move entities to collection
moveEntitiesToCollection 1 param body → 200401
GET
/api/atlas/v2/entity/guid/{guid}/header
Microsoft Purview Get entity header
entityGetHeader 2 params → 200401404

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are AtlasEntity (19 properties), AtlasEntity_2 (14 properties), AtlasEntityHeader (11 properties), AtlasTermAssignmentHeader (9 properties). Each schema is shown below with its type and property counts.

AtlasTermAssignmentHeader
object
9 properties
AtlasEntity
object
An instance of an entity along with extended info such as classification and referenced entities
19 properties
AtlasEntitiesWithExtInfo
object
A collection of entities with extended info
2 properties
TimeBoundary
object
3 properties
AtlasEntityWithExtInfo
object
An instance of an entity along with extended info
2 properties
AtlasClassifications
object
A paginated list of classifications
6 properties
EntityMutationResponse
object
The mutation response result of an entity operation
3 properties
AtlasEntityHeader
object
An instance of an entity header
11 properties
AtlasEntityHeaders
object
Collection of entity headers for bulk operations
1 property
AtlasClassification
object
A classification instance
8 properties
MoveEntitiesRequest
object
1 property
AtlasTermAssignmentHeader_2
object
5 properties
AtlasEntity_2
object
14 properties
AtlasEntitiesWithExtInfo_2
object
2 properties
AtlasEntityWithExtInfo_2
object
2 properties
AtlasClassifications_2
object
3 properties
EntityMutationResponse_2
object
2 properties
AtlasEntityHeader_2
object
7 properties
AtlasClassification_2
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-purview-entity-api-openapi.yml Raw ↑

Other APIs Microsoft Purview publishes across the network.

Microsoft Purview Accounts API
Microsoft Purview Approval API
Microsoft Purview Business Domains API
Microsoft Purview Cases API
Microsoft Purview Classification Rules API
Microsoft Purview Critical Data Elements API
Microsoft Purview Custodians API
Microsoft Purview Data Products API
Microsoft Purview Data Profiling API
Microsoft Purview Data Quality Rules API
Microsoft Purview Data Quality Scans API
Microsoft Purview Data Quality Scores API
Where this information came from

This is an independent, third-party profile of Microsoft Purview Entity API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.