get_data_quality_check_details

DataQualityChecksApi.get_data_quality_check_details(id, role_id, projection_expression=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get data quality check details

Returns the data quality check item for id, including AccessType and current recommendation/auto-suggestion fields when available. Missing check returns IPV-1002 (HTTP 400). When auto suggestions are enabled and RecommendationJobId is set, GET may call Glue and refresh RecommendationJobRunStatus / AutoConstraintSuggestions (often a Glue ruleset string) and persist updates. Non UUID-v4 path ids can raise an uncaught ValueError and return HTTP 500. This Lambda maps InvalidInputException, UnauthorizedUserException, GenericFailureException, ClientError, and ParamValidationError to HTTP 400. Uncaught exceptions return HTTP 500 (EMF-1001 wrapping GE-1044).

Parameters:

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

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

  • projection_expression (str) – Comma-separated attributes to include. Applied client-side after fetch when provided.

  • _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:

DataQualityCheck

Returns:

Returns the result object.

Request and Response Examples

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

Parameter examples

Name

In

Example

projectionExpression

query

"DataQualityCheckId,DatasetId,DqConstraints,AccessType"

Success (HTTP 200)

Data quality check details.

Errors

HTTP 400

Invalid input or authorization failure. Codes include IPV-*, AUTH-*.

HTTP 500

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