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.
Replace the Check with the specified rid. Changing the type of a check after it has been created is not supported.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:data-health-write.
objectunionConfiguration of a check.
stringoptionalA note about why the Check was set up.
objectThe replaced Check
stringThe unique resource identifier (RID) of a Data Health Check.
list<CheckGroupRid>optionalunionConfiguration of a check.
stringoptionalA note about why the Check was set up.
stringoptionalThe user that created the Check.
stringoptionalThe timestamp when the Check was last updated.
1
2
3
4
5
curl -X PUT \
\t-H "Content-type: application/json" \
\t-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/dataHealth/checks/ri.data-health.main.check.8e27b13a-e21b-4232-ae1b-76ccf5ff42b3?preview=true" \
-d '{"intent":"Check to ensure builds are passing."}'1
2
3
4
5
6
7
8
9
{
"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."
}| Error Name | ||
|---|---|---|
Modifying | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | Changing the type of a check after it has been created is not supported. | |
| Parameters | originalCheckType, newCheckType | |
Invalid | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | The TimeCheckConfig is invalid. It must contain at least one of timeBounds or medianDeviation. | |
| Parameters | | |
Invalid | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | The PercentageCheckConfig is invalid. It must contain at least one of percentageBounds or medianDeviation. | |
| Parameters | | |
Invalid | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | The NumericColumnCheckConfig is invalid. It must contain at least one of numericBounds or trend. | |
| Parameters | | |
Invalid | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | The TrendConfig is invalid. It must contain at least one of trendType or differenceBounds. | |
| Parameters | | |
Invalid | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | The TransactionTimeCheckConfig is invalid. It must contain at least one of timeBounds or medianDeviation. | |
| Parameters | | |
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 | |
Replace | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | Could not replace the Check. | |
| Parameters | checkRid | |
Check | Error Code | NOT_FOUND |
| Status Code | 404 | |
| Description | The given Check could not be found. | |
| Parameters | checkRid | |
See Errors for a general overview of errors in the platform.