This endpoint is in preview and may be modified or removed at any time.
To use this endpoint, add preview=true to the request query parameters.
Get the CheckReport with the specified rid.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:data-health-read.
stringThe unique resource identifier (RID) of a Data Health Check Report.
objectstringThe unique resource identifier (RID) of a Data Health Check Report.
objectSnapshot of the check configuration when this report was created. This will not change if the check is later modified.
objectThe result of running a check.
stringThe time at which the resource was created.
1
2
3
curl \
\t-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/dataHealth/checkReports/ri.data-health.main.check-report.a1b2c3d4-e5f6-7890-abcd-ef1234567890?preview=true"1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"result": {
"status": "PASSED"
},
"createdTime": "2003-05-06T12:34:56.789Z",
"check": {
"updatedTime": "2024-09-25T17:29:35.974Z",
"createdBy": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
"groups": [
"ri.data-health.main.check-group.08e376a8-607d-4f44-b8dd-b4587be6ce9b"
],
"rid": "ri.data-health.main.check.8e27b13a-e21b-4232-ae1b-76ccf5ff42b3",
"intent": "Check to ensure builds are passing."
},
"rid": "ri.data-health.main.check-report.a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}| Error Name | ||
|---|---|---|
Check | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | The type of the requested check is not yet supported in the Platform API. | |
| Parameters | checkType | |
Check | Error Code | NOT_FOUND |
| Status Code | 404 | |
| Description | The given CheckReport could not be found. | |
| Parameters | checkReportRid | |
See Errors for a general overview of errors in the platform.