Microsoft Purview website screenshot

Microsoft Purview

Microsoft Purview is a comprehensive data governance service that helps organizations discover, catalog, classify, and manage their data estate across on-premises, multi-cloud, and SaaS environments.

12 APIs 0 Features
ComplianceData CatalogData ClassificationData GovernanceData Loss PreventionInformation Protection

APIs

Microsoft Purview Catalog API

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 a...

Microsoft Purview Scanning API

APIs for configuring and managing scans of data sources to automatically discover and catalog data assets. Supports registering data sources and scheduling automated scans acros...

Microsoft Purview Account API

APIs for managing Purview accounts, configurations, and administrative settings. Provides resource management operations for creating, updating, and deleting Purview accounts th...

Microsoft Purview Data Map API

APIs for accessing and managing the unified data map that provides a holistic view of your data estate. Supports entity management, lineage tracking, relationship mapping, and d...

Microsoft Purview Metadata Policies API

APIs for creating and managing data access policies based on metadata attributes. Enables programmatic management of collection-level permissions and role assignments.

Microsoft Purview Workflow API

APIs for managing workflows and approval processes for data governance tasks. Supports defining custom approval workflows for glossary term management and other governance opera...

Microsoft Purview Unified Catalog API

APIs for programmatically integrating and managing the Microsoft Purview Unified Catalog. Supports operations on business domains, glossary terms, data products, OKRs, critical ...

Microsoft Purview Data Quality API

APIs for programmatically interacting with data quality rules, measuring data quality, and retrieving data quality scores for data assets. Supports data profiling, rule manageme...

Microsoft Purview eDiscovery API

APIs for automating eDiscovery operations through Microsoft Graph, including managing cases, custodians, review sets, searches, and exports for litigation, investigation, and re...

Microsoft Purview Information Protection API

APIs for accessing and managing sensitivity labels through Microsoft Graph. Enables applications to apply, update, and delete sensitivity labels, evaluate label actions, and enf...

Microsoft Purview Data Security and Governance API

APIs for integrating data loss prevention and compliance policy enforcement into applications through Microsoft Graph. Provides compute protection scopes and process content ope...

Microsoft Purview Records Management API

APIs for managing retention labels, retention policies, and disposition review through Microsoft Graph. Helps organizations manage data retention and deletion to meet legal obli...

Collections

Arazzo Workflows

Microsoft Purview Assign a Glossary Term to Entities

Create a glossary term and assign it to one or more catalog entities.

ARAZZO

Microsoft Purview Categorize a Glossary Term

Create a glossary category and a term that is filed under that category.

ARAZZO

Microsoft Purview Classify a Data Asset Entity

Register a catalog entity, confirm it, then apply and verify a classification.

ARAZZO

Microsoft Purview Define a Classification Type and Apply It

Register a custom classification typedef, confirm it, then classify an entity with it.

ARAZZO

Microsoft Purview Define a Data Quality Rule and Scan

Create a data quality rule, confirm it, then run a quality scan that evaluates it.

ARAZZO

Microsoft Purview Move Found Entities into a Collection

Search the catalog, then move the discovered entities into a target collection.

ARAZZO

Microsoft Purview Onboard an Entity into a Collection

Create a Data Map entity, confirm it, move it into a collection, and classify it.

ARAZZO

Microsoft Purview Profile a Data Asset and Poll for Results

Kick off data profiling for an asset, then poll until the profiling completes.

ARAZZO

Microsoft Purview Provision a Custom Scan Ruleset

Create a custom classification rule, build a scan ruleset that uses it, and confirm.

ARAZZO

Microsoft Purview Publish a Data Product

Create a business domain, confirm it, then publish a data product under it.

ARAZZO

Microsoft Purview Publish a Glossary Term

Create a glossary, confirm it, then create a term anchored to that glossary.

ARAZZO

Microsoft Purview Register a Data Source and Launch a Scan

Register a data source, configure a scan, and kick off a scan run.

ARAZZO

Microsoft Purview Relate Two Catalog Entities

Create an entity, then create a relationship linking it to another entity.

ARAZZO

Microsoft Purview Run a Scan and Poll to Completion

Launch a scan run, then poll scan history until the run reaches a terminal state.

ARAZZO

Microsoft Purview Schedule a Recurring Scan

Configure a scan, attach a recurring trigger, enable it, and confirm the schedule.

ARAZZO

Microsoft Purview Search and Classify a Found Asset

Search the catalog, read the top hit, and apply a classification to it.

ARAZZO

Microsoft Purview Trace Data Asset Lineage

Search for an asset, read its entity, then walk its lineage graph with pagination.

ARAZZO

Pricing Plans

Rate Limits

Microsoft Purview Rate Limits

4 limits

RATE LIMITS

FinOps

Semantic Vocabularies

Microsoft Purview Context

0 classes · 19 properties

JSON-LD

JSON Structure

Microsoft Purview Structure

0 properties

JSON STRUCTURE

Resources

🔗
PostmanWorkspace
PostmanWorkspace
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🌐
Portal
Portal
🔗
Documentation
Documentation
🚀
GettingStarted
GettingStarted
🔑
Authentication
Authentication
🔗
Reference
Reference
📦
SDKs
SDKs
🔗
Best Practices
Best Practices
📄
ChangeLog
ChangeLog
📰
Blog
Blog
💬
Support
Support
🟢
StatusPage
StatusPage
📜
TermsOfService
TermsOfService
📜
PrivacyPolicy
PrivacyPolicy
👥
GitHubOrganization
GitHubOrganization
🔗
Community
Community
🔗
Website
Website
🔗
Login
Login
📝
Signup
Signup
🔗
JSONLD
JSONLD

Sources

Raw ↑
opencollection: 1.0.0
info:
  name: Microsoft Purview Workflow API
  version: 2023-10-01-preview
request:
  auth:
    type: oauth2
    flow: client_credentials
    accessTokenUrl: https://login.microsoftonline.com/{tenantId}/oauth2/v2.0/token
    credentials:
      clientId: '{{clientId}}'
      clientSecret: '{{clientSecret}}'
items:
- info:
    name: Workflows
    type: folder
  items:
  - info:
      name: Microsoft Purview List all workflows
      type: http
    http:
      method: GET
      url: https://{accountName}.purview.azure.com/workflow/workflows
      params:
      - name: api-version
        value: ''
        type: query
    docs: List all workflows in the Purview account.
- info:
    name: Workflow
    type: folder
  items:
  - info:
      name: Microsoft Purview Get a workflow
      type: http
    http:
      method: GET
      url: https://{accountName}.purview.azure.com/workflow/workflows/:workflowId
      params:
      - name: workflowId
        value: ''
        type: path
      - name: api-version
        value: ''
        type: query
    docs: Get a specific workflow by its identifier.
  - info:
      name: Microsoft Purview Create or replace a workflow
      type: http
    http:
      method: PUT
      url: https://{accountName}.purview.azure.com/workflow/workflows/:workflowId
      params:
      - name: workflowId
        value: ''
        type: path
        description: The workflow identifier
      - name: api-version
        value: ''
        type: query
      body:
        type: json
        data: '{}'
    docs: Create or replace a workflow definition.
  - info:
      name: Microsoft Purview Delete a workflow
      type: http
    http:
      method: DELETE
      url: https://{accountName}.purview.azure.com/workflow/workflows/:workflowId
      params:
      - name: workflowId
        value: ''
        type: path
      - name: api-version
        value: ''
        type: query
    docs: Delete a workflow by its identifier.
  - info:
      name: Microsoft Purview Validate a workflow
      type: http
    http:
      method: POST
      url: https://{accountName}.purview.azure.com/workflow/workflows/:workflowId/validate
      params:
      - name: workflowId
        value: ''
        type: path
      - name: api-version
        value: ''
        type: query
      body:
        type: json
        data: '{}'
    docs: Validate a workflow definition without creating it.
- info:
    name: Workflow Run
    type: folder
  items:
  - info:
      name: Microsoft Purview Get a workflow run
      type: http
    http:
      method: GET
      url: https://{accountName}.purview.azure.com/workflow/workflowruns/:workflowRunId
      params:
      - name: workflowRunId
        value: ''
        type: path
      - name: api-version
        value: ''
        type: query
    docs: Get a workflow run by its identifier.
  - info:
      name: Microsoft Purview Cancel a workflow run
      type: http
    http:
      method: POST
      url: https://{accountName}.purview.azure.com/workflow/workflowruns/:workflowRunId/cancel
      params:
      - name: workflowRunId
        value: ''
        type: path
      - name: api-version
        value: ''
        type: query
      body:
        type: json
        data: '{}'
    docs: Cancel a running workflow run.
- info:
    name: Workflow Task
    type: folder
  items:
  - info:
      name: Microsoft Purview Get a workflow task
      type: http
    http:
      method: GET
      url: https://{accountName}.purview.azure.com/workflow/workflowtasks/:taskId
      params:
      - name: taskId
        value: ''
        type: path
      - name: api-version
        value: ''
        type: query
    docs: Get a workflow task by its identifier.
  - info:
      name: Microsoft Purview Reassign a workflow task
      type: http
    http:
      method: POST
      url: https://{accountName}.purview.azure.com/workflow/workflowtasks/:taskId/reassign
      params:
      - name: taskId
        value: ''
        type: path
      - name: api-version
        value: ''
        type: query
      body:
        type: json
        data: '{}'
    docs: Reassign a workflow task to a different user.
- info:
    name: Approval
    type: folder
  items:
  - info:
      name: Microsoft Purview Approve a workflow approval task
      type: http
    http:
      method: POST
      url: https://{accountName}.purview.azure.com/workflow/approvals/:taskId/approve
      params:
      - name: taskId
        value: ''
        type: path
      - name: api-version
        value: ''
        type: query
      body:
        type: json
        data: '{}'
    docs: Approve an approval task in a workflow.
  - info:
      name: Microsoft Purview Reject a workflow approval task
      type: http
    http:
      method: POST
      url: https://{accountName}.purview.azure.com/workflow/approvals/:taskId/reject
      params:
      - name: taskId
        value: ''
        type: path
      - name: api-version
        value: ''
        type: query
      body:
        type: json
        data: '{}'
    docs: Reject an approval task in a workflow.
- info:
    name: User Requests
    type: folder
  items:
  - info:
      name: Microsoft Purview Submit a user request
      type: http
    http:
      method: POST
      url: https://{accountName}.purview.azure.com/workflow/userrequests
      params:
      - name: api-version
        value: ''
        type: query
      body:
        type: json
        data: '{}'
    docs: Submit a user request to trigger a workflow.
bundled: true