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.
Search for checkpoint records.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:checkpoints-read.
objectobjectRequest payload for searching checkpoint records.
stringThe page token indicates where to start paging. This should be omitted from the first page's request.
To fetch the next page, clients should take the value from the nextPageToken field of the previous response
and use it to populate the pageToken field of the next request.
integerThe page size for the search request. If no value is provided, a default of 100 will be used.
string (enum)Chronological order of creation time for records to be returned in. Defaults to reverse chronological order (DESC).
Enum values: ASC, DESC
objectResponse payload for searching checkpoint records.
list<Record>stringThe page token indicates where to start paging. This should be omitted from the first page's request.
To fetch the next page, clients should take the value from the nextPageToken field of the previous response
and use it to populate the pageToken field of the next request.
1
2
3
4
5
curl -X POST \
\t-H "Content-type: application/json" \
\t-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/checkpoints/records/search?preview=true" \
-d '{"sortDirection":"DESC","pageSize":100,"where":{"filter":{"type":"eq","field":"checkpointType","value":"CONTOUR_EXPORT"}},"pageToken":"v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
{
"data": [
{
"rid": "ri.checkpoints.main.checkpoint.a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"type": "CONTOUR_EXPORT",
"scope": "USER_SCOPED",
"actingUser": {
"userId": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
"username": {
"value": "admin"
}
},
"createdAt": "2023-11-14T09:30:00.000Z",
"checkpointedItems": [
{
"type": "checkpointedResource",
"rid": "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da",
"resourceType": "DATASET",
"compassPath": {
"value": "/My Project/My Dataset"
},
"orgMarkings": []
}
],
"justification": {
"type": "acknowledgementJustification",
"prompt": "I acknowledge this action",
"title": "Export Confirmation"
}
}
],
"nextPageToken": "{\"token\":\"1771291126611\",\"recordRid\":\"ri.checkpoints.main.checkpoint.01932cec-a44d-41fc-8066-bfc15c1c4a4c\"}"
}| Error Name | ||
|---|---|---|
Search | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | Could not search the Record. | |
| Parameters | | |
See Errors for a general overview of errors in the platform.