{
  "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
}