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 RIDs of the Data Health Checks that are configured for the given Dataset.
Third-party applications using this endpoint via OAuth2 must request the following operation scopes: api:data-health-read api:datasets-read.
stringThe name of the Branch. If none is provided, the default Branch name - master for most enrollments - will be used.
booleanEnables the use of preview functionality.
objectlist<CheckRid>1
2
3
curl \
\t-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/getHealthChecks?branchName=master&preview=true"1
2
3
4
5
{
"data": [
"ri.data-health.main.check.8e27b13a-e21b-4232-ae1b-76ccf5ff42b3"
]
}| Error Name | ||
|---|---|---|
Branch | Error Code | NOT_FOUND |
| Status Code | 404 | |
| Description | The requested branch could not be found, or the client token does not have access to it. | |
| Parameters | datasetRid, branchName | |
Dataset | Error Code | NOT_FOUND |
| Status Code | 404 | |
| Description | The requested dataset could not be found, or the client token does not have access to it. | |
| Parameters | datasetRid | |
Get | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | Could not getHealthChecks the Dataset. | |
| Parameters | datasetRid | |
See Errors for a general overview of errors in the platform.