Microsoft Purview

Microsoft Purview Workflow Run API

Operations for managing workflow runs

Documentation GitHub OpenAPI

Operations 2

GET /workflowruns/{workflowRunId} Microsoft Purview Get a workflow run #

POST /workflowruns/{workflowRunId}/cancel Microsoft Purview Cancel a workflow run #

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-workflow-run-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

openapi: 3.2.0
info:
  title: Microsoft Purview Workflow Workflow Run API
  description: APIs for managing workflows and approval processes for data governance tasks. Supports defining custom approval workflows for glossary term management and other governance operations within Purview.
  version: 2023-10-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/workflow
  description: Microsoft Purview Workflow API endpoint
  variables:
    accountName:
      description: The name of the Microsoft Purview account
      default: myaccount
security:
- oauth2: []
tags:
- name: Workflow Run
  description: Operations for managing workflow runs
paths:
  /workflowruns/{workflowRunId}:
    get:
      operationId: getWorkflowRun
      summary: Microsoft Purview Get a workflow run
      description: Get a workflow run by its identifier.
      tags:
      - Workflow Run
      parameters:
      - name: workflowRunId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: api-version
        in: query
        required: true
        schema:
          type: string
          default: 2023-10-01-preview
      responses:
        '200':
          description: Workflow run retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowRun'
        '401':
          description: Unauthorized
        '404':
          description: Workflow run not found
  /workflowruns/{workflowRunId}/cancel:
    post:
      operationId: cancelWorkflowRun
      summary: Microsoft Purview Cancel a workflow run
      description: Cancel a running workflow run.
      tags:
      - Workflow Run
      parameters:
      - name: workflowRunId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: api-version
        in: query
        required: true
        schema:
          type: string
          default: 2023-10-01-preview
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                comment:
                  type: string
                  description: The reason for cancellation
      responses:
        '200':
          description: Workflow run cancelled successfully
        '401':
          description: Unauthorized
components:
  schemas:
    WorkflowRun:
      type: object
      properties:
        id:
          type: string
          format: uuid
        workflowId:
          type: string
          format: uuid
        startTime:
          type: string
          format: date-time
        requestor:
          type: string
          format: uuid
        userRequestId:
          type: string
          format: uuid
        runPayload:
          type: object
        status:
          type: string
          enum:
          - InProgress
          - Completed
          - Canceling
          - CancellationFailed
          - Cancelled
          - Failed
          - NotStarted
        endTime:
          type: string
          format: date-time
        cancelTime:
          type: string
          format: date-time
        cancelComment:
          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