Microsoft Purview

Microsoft Purview Data Products API

Operations for managing data products

GitHub OpenAPI
Business capability
Data Governance Management BC-610.10

Operations 5

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

GET /dataproducts List data products · Microsoft Purview List data products #
Ask an LLM
“What data products are published in our unified catalog?”
“Can I page through data products in smaller batches?”
Tell an agent
List all data products in the catalog.
Show data products {size} per page.
POST /dataproducts Create a data product · Microsoft Purview Create a data product #
Ask an LLM
“How do I package data assets into a new data product?”
“Can I assign a new data product to a business domain?”
Tell an agent
Create a data product named {name} in business domain {domain}.
Create data product {name} containing assets {assets}.
GET /dataproducts/{dataProductId} Get a data product · Microsoft Purview Get a data product #
Ask an LLM
“Which data assets are included in a specific data product?”
“Who owns one particular data product?”
Tell an agent
Show me data product {product}.
Get the owners and assets of data product {product}.
PATCH /dataproducts/{dataProductId} Update a data product · Microsoft Purview Update a data product #
Ask an LLM
“How do I add assets to a data product that already exists?”
“Can I change the owners or status of an existing data product?”
Tell an agent
Set the data assets of existing data product {product} to {assets}.
Change the status of data product {product} to {status}.
DELETE /dataproducts/{dataProductId} Delete a data product · Microsoft Purview Delete a data product #
Ask an LLM
“Can I retire a data product from the unified catalog?”
“Is it possible to delete a data product by its ID?”
Tell an agent destructive · confirm first
Delete data product {product}.
Remove data product {product} from the catalog.

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
📖
Authentication
https://learn.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-client-creds-grant-flow
📖
GettingStarted
https://learn.microsoft.com/en-us/purview/legacy/how-to-purview-custom-lineage-api-user-guide
📖
GettingStarted
https://learn.microsoft.com/en-us/purview/legacy/tutorial-metadata-policy-collections-apis
📖
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://artifacts.apis.io/microsoft-purview/openapi/microsoft-purview-data-products-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-data-products-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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-data-products-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Microsoft Purview Unified Catalog Data Products API
  description: APIs for programmatically integrating and managing the Microsoft Purview Unified Catalog. Supports operations on business domains, glossary terms, data products, OKRs, critical data elements, and data access policies.
  version: 2024-03-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
  description: Microsoft Purview Unified Catalog API endpoint
  variables:
    accountName:
      description: The name of the Microsoft Purview account
      default: myaccount
security:
- oauth2: []
tags:
- name: Data Products
  description: Operations for managing data products
paths:
  /dataproducts:
    get:
      operationId: listDataProducts
      summary: Microsoft Purview List data products
      description: List all data products in the Purview unified catalog.
      tags:
      - Data Products
      parameters:
      - name: api-version
        in: query
        required: true
        schema:
          type: string
          default: 2024-03-01-preview
      - name: maxpagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Data products listed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataProductList'
        '401':
          description: Unauthorized
    post:
      operationId: createDataProduct
      summary: Microsoft Purview Create a data product
      description: Create a new data product in the unified catalog.
      tags:
      - Data Products
      parameters:
      - name: api-version
        in: query
        required: true
        schema:
          type: string
          default: 2024-03-01-preview
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataProduct'
      responses:
        '201':
          description: Data product created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataProduct'
        '401':
          description: Unauthorized
  /dataproducts/{dataProductId}:
    get:
      operationId: getDataProduct
      summary: Microsoft Purview Get a data product
      description: Get a data product by its identifier.
      tags:
      - Data Products
      parameters:
      - name: dataProductId
        in: path
        required: true
        schema:
          type: string
      - name: api-version
        in: query
        required: true
        schema:
          type: string
          default: 2024-03-01-preview
      responses:
        '200':
          description: Data product retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataProduct'
        '401':
          description: Unauthorized
        '404':
          description: Not found
    patch:
      operationId: updateDataProduct
      summary: Microsoft Purview Update a data product
      description: Update a data product by its identifier.
      tags:
      - Data Products
      parameters:
      - name: dataProductId
        in: path
        required: true
        schema:
          type: string
      - name: api-version
        in: query
        required: true
        schema:
          type: string
          default: 2024-03-01-preview
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataProduct'
      responses:
        '200':
          description: Data product updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataProduct'
        '401':
          description: Unauthorized
    delete:
      operationId: deleteDataProduct
      summary: Microsoft Purview Delete a data product
      description: Delete a data product by its identifier.
      tags:
      - Data Products
      parameters:
      - name: dataProductId
        in: path
        required: true
        schema:
          type: string
      - name: api-version
        in: query
        required: true
        schema:
          type: string
          default: 2024-03-01-preview
      responses:
        '204':
          description: Data product deleted successfully
        '401':
          description: Unauthorized
components:
  schemas:
    DataProduct:
      type: object
      description: A data product in the unified catalog
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        businessDomainId:
          type: string
        owners:
          type: array
          items:
            $ref: '#/components/schemas/GovernanceContact'
        status:
          type: string
          enum:
          - Draft
          - Published
          - Expired
        dataAssets:
          type: array
          items:
            type: object
            properties:
              assetId:
                type: string
              assetType:
                type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    GovernanceContact:
      type: object
      properties:
        id:
          type: string
          format: uuid
        displayName:
          type: string
        mail:
          type: string
          format: email
    DataProductList:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/DataProduct'
        nextLink:
          type: string
  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