Breadcrumbs

Metavault API - Create data quality check

CreateDataQuality - POST

Path

/api/projects/{projectId}/dataquality

Http Method

POST

Overview

Required permissions

  • Write access to the Verify module. VERIFY WRITE

Request

Request body

JSON
{
  "responsible": {
    "type": "Hardcoded",
    "responsibleValue": "Michael"
  },
  "name": "DQ01",
  "description": "data quality 01",
  "qualityLevel": "Level3",
  "criticality": "Warning",
  "controlType": "Format",
  "resolution": "Call operations",
  "sourceSystemId": "e605eb83-d483-4738-a56f-f5b848f2f54d",
  "snapshotId": "bdc559dd-bf03-4e1c-b2b8-c724b80da1d3",
  "entityId": "f81e889e-4d64-405f-bf3c-9ac317fb046c",
  "entityType": "0",
  "nameColumn": {
    "columnId": "d6fd9b61-838c-4b1b-adaf-f1c8682a40b3",
    "satelliteId": "27d589a3-6333-4d23-b86f-8be4429e15c7",
    "alias": ""
  },
  "columns": [
    {
      "satelliteId": "27d589a3-6333-4d23-b86f-8be4429e15c7",
      "columnId": "d6fd9b61-838c-4b1b-adaf-f1c8682a40b3",
      "alias": "column2"
    }
  ],
  "dataQualityQuery": "{column2} IS NOT NULL"
}

Response

Success response (200 OK)

JSON
{
  "_embedded": {
    "columns": [
      {
        "satelliteId": "27d589a3-6333-4d23-b86f-8be4429e15c7",
        "columnId": "d6fd9b61-838c-4b1b-adaf-f1c8682a40b3",
        "alias": "column2"
      }
    ]
  },
  "name": "DQ01",
  "id": "89f2d3e0-7345-4643-b66f-0974758f8e6a",
  "description": "data quality 01",
  "qualityLevel": "Level3",
  "entityId": "f81e889e-4d64-405f-bf3c-9ac317fb046c",
  "entityType": "Hub",
  "sourceSystemId": "e605eb83-d483-4738-a56f-f5b848f2f54d",
  "criticality": "Warning",
  "resolution": "Call operations",
  "dataQualityQuery": "{column2} IS NOT NULL",
  "snapshotId": "bdc559dd-bf03-4e1c-b2b8-c724b80da1d3",
  "columns": [
    {
      "satelliteId": "27d589a3-6333-4d23-b86f-8be4429e15c7",
      "columnId": "d6fd9b61-838c-4b1b-adaf-f1c8682a40b3",
      "alias": "column2"
    }
  ],
  "nameColumn": {
    "satelliteId": "27d589a3-6333-4d23-b86f-8be4429e15c7",
    "columnId": "d6fd9b61-838c-4b1b-adaf-f1c8682a40b3",
    "alias": ""
  },
  "controlType": "Format",
  "responsible": {
    "type": "Hardcoded",
    "responsibleValue": "Michael"
  }
}