update_data_quality_check

DataQualityChecksApi.update_data_quality_check(id, role_id, update_data_quality_check_request, content_type=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Update a data quality check

Updates AreAutoConstraintSuggestionsEnabled and/or DqConstraints for the check. Only those two body fields are accepted; other keys are rejected (GE-1034). After merge, the check must still have auto suggestions enabled or at least one constraint. Blocked while any run has RunStatus RUNNING. Caller needs editor access on the dataset. On success Message is “Data quality check item is updated successfully”.

Parameters:

  • id (str) – Data quality check ID to update. (required)

  • role_id (str) – Amorphic role ID the request is authorized against. (required)

  • update_data_quality_check_request (UpdateDataQualityCheckRequest) – (required)

  • content_type (str) – Must be application/json.

  • _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

  • _content_type (str, Optional) – force content-type for the request.

  • _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

  • _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

UpdateDataQualityCheckResponse

Returns:

Returns the result object.

Request and Response Examples

HTTP: PUT /data-quality-checks/{id}

Success (HTTP 200)

Data quality check updated successfully.

Request / response example

{
  "Message": "Data quality check item is updated successfully"
}

Errors

Documented error codes: GE-1034.

HTTP 400

Invalid input, unsupported body fields, or update blocked because a run is RUNNING. Codes include IPV-*, GE-1034, AUTH-*.

HTTP 500

Backend/generic failure. Body is {“Message”: “<CODE> - <text>”}.