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 Type API

Operations for managing type definitions

Microsoft Purview Type 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 Type. 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 8 operations across 4 paths, and defines 5 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.

8 operations 4 paths 5 schemas 2 DELETE4 GET1 POST1 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 Type 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 8

Across 4 paths, the API surfaces 8 operations — 2 DELETE, 4 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Type 8

Operations for managing type definitions

GET
/api/atlas/v2/types/typedefs
Microsoft Purview List all type definitions
listTypeDefinitions 2 params → 200401
POST
/api/atlas/v2/types/typedefs
Microsoft Purview Create type definitions in bulk
bulkCreateTypeDefinitions body → 200400401
PUT
/api/atlas/v2/types/typedefs
Microsoft Purview Update type definitions in bulk
bulkUpdateTypeDefinitions body → 200401
DELETE
/api/atlas/v2/types/typedefs
Microsoft Purview Delete type definitions in bulk
bulkDeleteTypeDefinitions body → 204401
GET
/api/atlas/v2/types/typedefs/headers
Microsoft Purview List type definition headers
listTypeDefinitionHeaders 2 params → 200401
GET
/api/atlas/v2/types/typedef/guid/{guid}
Microsoft Purview Get type definition by GUID
getTypeDefinitionByGuid 1 param → 200401404
GET
/api/atlas/v2/types/typedef/name/{name}
Microsoft Purview Get type definition by name
getTypeDefinitionByName 1 param → 200401404
DELETE
/api/atlas/v2/types/typedef/name/{name}
Microsoft Purview Delete type definition by name
deleteTypeDefinitionByName 1 param → 204401404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are AtlasTypeDef (13 properties), AtlasTypesDef (7 properties), AtlasTypesDef_2 (6 properties), AtlasTypeDef_2 (5 properties). Each schema is shown below with its type and property counts.

AtlasTypesDef
object
The definitions of types
7 properties
AtlasTypeDefHeader
object
3 properties
AtlasTypeDef
object
A type definition
13 properties
AtlasTypesDef_2
object
6 properties
AtlasTypeDef_2
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-purview-type-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 Type 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.