Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

BatchGetDataQualityResult

Retrieves a list of data quality results for the specified result IDs.

Request Syntax


{
   "ResultIds": [ "string" ]
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ResultIds

A list of unique result IDs for the data quality results.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: Yes

Response Syntax


{
   "Results": [ 
      { 
         "AnalyzerResults": [ 
            { 
               "Description": "string",
               "EvaluatedMetrics": { 
                  "string" : number 
               },
               "EvaluationMessage": "string",
               "Name": "string"
            }
         ],
         "CompletedOn": number,
         "DataSource": { 
            "GlueTable": { 
               "AdditionalOptions": { 
                  "string" : "string" 
               },
               "CatalogId": "string",
               "ConnectionName": "string",
               "DatabaseName": "string",
               "TableName": "string"
            }
         },
         "EvaluationContext": "string",
         "JobName": "string",
         "JobRunId": "string",
         "Observations": [ 
            { 
               "Description": "string",
               "MetricBasedObservation": { 
                  "MetricName": "string",
                  "MetricValues": { 
                     "ActualValue": number,
                     "ExpectedValue": number,
                     "LowerLimit": number,
                     "UpperLimit": number
                  },
                  "NewRules": [ "string" ]
               }
            }
         ],
         "ResultId": "string",
         "RuleResults": [ 
            { 
               "Description": "string",
               "EvaluatedMetrics": { 
                  "string" : number 
               },
               "EvaluationMessage": "string",
               "Name": "string",
               "Result": "string"
            }
         ],
         "RulesetEvaluationRunId": "string",
         "RulesetName": "string",
         "Score": number,
         "StartedOn": number
      }
   ],
   "ResultsNotFound": [ "string" ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Results

A list of DataQualityResult objects representing the data quality results.

Type: Array of DataQualityResult objects

ResultsNotFound

A list of result IDs for which results were not found.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceException

An internal service error occurred.

HTTP Status Code: 500

InvalidInputException

The input provided was not valid.

HTTP Status Code: 400

OperationTimeoutException

The operation timed out.

HTTP Status Code: 400