Data Check

Update Data Check

Endpoint to update an existing Data Check

put/data-check/{id}

Request

Path parameters

idstring uuid required

ID of the Data Check to update

Request body

Example request

{
  "data": {
    "name": "Example Text",
    "checkType": "Example Text",
    "intervalInMinutes": 42,
    "isEnabled": true
  }
}

Response

Updated successfully

Example response

{
  "data": {
    "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "createdAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "updatedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "deletedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "project": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "projectId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "dataAsset": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "dataAssetId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "dataStoreId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "name": "Example Text",
    "description": "This is an example of longer text content that provides detailed information.",
    "checkType": "Example Text",
    "columnName": "Example Text",
    "segmentColumn": "Example Text",
    "acceptedValues": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "pattern": "This is an example of longer text content that provides detailed information.",
    "formatPreset": "Example Text",
    "samplePercent": 42,
    "referenceTableKey": "Example Text",
    "referenceColumnName": "Example Text",
    "customSql": "This is an example of longer text content that provides detailed information.",
    "intervalInMinutes": 42,
    "isEnabled": true,
    "isManagedByFile": true,
    "alertCondition": "Example Text",
    "alertThreshold": 42,
    "monitor": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "monitorId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "dataReconciliationId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "lastRunAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "lastRunStatus": "Example Text",
    "lastRunMessage": "This is an example of longer text content that provides detailed information.",
    "lastValue": 42,
    "failingRowsSample": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "lastSegmentCount": 42,
    "externalId": "This is an example of longer text content that provides detailed information.",
    "createdByUser": {
      "_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
    },
    "createdByUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.