{
  "opencollection": "1.0.0",
  "info": {
    "name": "Microsoft Purview Data Quality API",
    "version": "2024-03-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": "Data Quality Rules",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Microsoft Purview List data quality rules",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{accountName}.purview.azure.com/dataquality/rules",
            "params": [
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              },
              {
                "name": "maxpagesize",
                "value": "",
                "type": "query"
              },
              {
                "name": "skipToken",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "List all data quality rules configured in the Purview account."
        },
        {
          "info": {
            "name": "Microsoft Purview Create a data quality rule",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{accountName}.purview.azure.com/dataquality/rules",
            "params": [
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new data quality rule for evaluating data assets."
        },
        {
          "info": {
            "name": "Microsoft Purview Get a data quality rule",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{accountName}.purview.azure.com/dataquality/rules/:ruleId",
            "params": [
              {
                "name": "ruleId",
                "value": "",
                "type": "path"
              },
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Get a data quality rule by its identifier."
        },
        {
          "info": {
            "name": "Microsoft Purview Update a data quality rule",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://{accountName}.purview.azure.com/dataquality/rules/:ruleId",
            "params": [
              {
                "name": "ruleId",
                "value": "",
                "type": "path"
              },
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an existing data quality rule."
        },
        {
          "info": {
            "name": "Microsoft Purview Delete a data quality rule",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{accountName}.purview.azure.com/dataquality/rules/:ruleId",
            "params": [
              {
                "name": "ruleId",
                "value": "",
                "type": "path"
              },
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Delete a data quality rule by its identifier."
        }
      ]
    },
    {
      "info": {
        "name": "Data Quality Scores",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Microsoft Purview List data quality scores",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{accountName}.purview.azure.com/dataquality/scores",
            "params": [
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              },
              {
                "name": "assetId",
                "value": "",
                "type": "query",
                "description": "Filter scores by data asset identifier"
              },
              {
                "name": "maxpagesize",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Retrieve data quality scores for data assets."
        },
        {
          "info": {
            "name": "Microsoft Purview Get a data quality score",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{accountName}.purview.azure.com/dataquality/scores/:scoreId",
            "params": [
              {
                "name": "scoreId",
                "value": "",
                "type": "path"
              },
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Get a specific data quality score by its identifier."
        }
      ]
    },
    {
      "info": {
        "name": "Data Profiling",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Microsoft Purview Get data profiling result",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{accountName}.purview.azure.com/dataquality/profiling/:assetId",
            "params": [
              {
                "name": "assetId",
                "value": "",
                "type": "path"
              },
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Get data profiling results for a specific data asset."
        },
        {
          "info": {
            "name": "Microsoft Purview Run data profiling",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{accountName}.purview.azure.com/dataquality/profiling/:assetId",
            "params": [
              {
                "name": "assetId",
                "value": "",
                "type": "path",
                "description": "The data asset identifier"
              },
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Initiate data profiling for a specific data asset."
        }
      ]
    },
    {
      "info": {
        "name": "Data Quality Scans",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Microsoft Purview Run a data quality scan",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{accountName}.purview.azure.com/dataquality/scans",
            "params": [
              {
                "name": "api-version",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Initiate a data quality scan to evaluate rules against data assets."
        }
      ]
    }
  ],
  "bundled": true
}