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.
Retrieve a single checkpoint record by id.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:checkpoints-read.
objectstringIdentifier of a checkpoint record.
stringIdentifier of the checkpoint configuration that produced a record.
string (enum)Checkpoint type identifier. See the Checkpoints documentation for more details.
Enum values: CONTOUR_CREATE, CONTOUR_EXPORT, HUBBLE_EXPORT, COMPASS_IMPORT, COMPASS_EXPORT, COMPASS_ADD_REFERENCE, COMPASS_AUTHORIZE_MARKING_ON_PROJECT, COMPASS_ADD_ROLE_GRANT, COMPASS_REMOVE_REFERENCE, COMPASS_REMOVE_AUTHORIZED_MARKING_FROM_PROJECT, COMPASS_REMOVE_ROLE_GRANT, DATA_CONNECTION_SYNC_CREATE, DATA_CONNECTION_SYNC_BULK_CREATE, DATA_CONNECTION_SYNC_EDIT, DATA_CONNECTION_SOURCE_SHARE, LOGIN, REPORT_EXPORT, CIPHER_ENCRYPT, CIPHER_DECRYPT, ATTACHMENT_IMPORT, ATTACHMENT_EXPORT, SLATE_EXPORT, NOTEPAD_EXPORT, QUIVER_EXPORT, DATA_LIFETIME_APPLY_RETENTION_POLICY, FRONTEND_EXPORT, BUILD_LOG_EXPORT, CODE_REPOSITORY_LOG_EXPORT, CODE_REPOSITORY_MODIFY_APPROVAL_POLICY, CODE_REPOSITORY_MERGE_PULL_REQUEST, CODE_REPOSITORY_BUILD, CODE_WORKBOOK_BUILD, SCHEDULE_CREATE, SCHEDULE_MODIFY, SCHEDULE_RUN, SCHEDULE_DELETE, RUN_BUILD, MULTIPASS_TOKEN_CREATE, MULTIPASS_ADD_GROUP_MEMBER, MULTIPASS_ADD_MARKING_MEMBER, MULTIPASS_REMOVE_GROUP_MEMBER, MULTIPASS_REMOVE_MARKING_MEMBER, MULTIPASS_UPDATE_GROUP_MEMBERSHIP_EXPIRATION_CONFIG, MULTIPASS_UPDATE_GROUP_MEMBER_EXPIRY, SCOPED_SESSION_SELECT, CODE_WORKSPACE_LOG_EXPORT, CODE_WORKSPACE_MOVE_DATA_FROM_FOUNDRY, CODE_WORKSPACE_MOVE_DATA_TO_FOUNDRY, MANAGE_CODE_WORKSPACE_DASHBOARD_DOWNLOADS, NOTEPAD_MEDIA_IMPORT, CONTOUR_DASHBOARD_EXPORT, PACKAGE_PRODUCT, NOTEPAD_WIDGET_SNAPSHOT, MEDIA_SET_IMPORT, MEDIA_SET_EXPORT, UPGRADE_ASSISTANT_SUMMARY_EXPORT, TABLES_REGISTRATION_AUTOMATIC, TABLES_REGISTRATION_MANUAL, DEV_CONSOLE_OPENAPI_SPECIFICATION_EXPORT, DEV_CONSOLE_USAGE_EXPORT, DEPLOY_PIPELINE, PIPELINE_BUILDER_MERGE_PROPOSAL, PIPELINE_BUILDER_MODIFY_APPROVAL_POLICY, PIPELINE_BUILDER_ARCHIVE_BRANCHES, PIPELINE_BUILDER_MODIFY_FALLBACK_BRANCHES, MODEL_EXPORT, THREADS_SESSION_EXPORT, AGENT_SESSION_EXPORT, USER_INTAKE_SUBMISSION_EXPORT, FUNCTION_BACKED_EXPORT, SUBMIT_ACTION, START_WALKTHROUGH, OBJECT_SET_EXPORT, RESET_MFA_METHOD, ISSUE_CREATE, RECORD_FLOW_CAPTURE, UPLOAD_DATA_TO_FLOW_CAPTURE, EXPORT_FLOW_CAPTURE_ZIP, INSIGHT_LOAD
string (enum)Indicates whether the checkpoint was scoped to a user or resource.
Enum values: USER_SCOPED, RESOURCE_SCOPED
objectUser that performed the checkpoint action.
stringA Foundry User ID.
stringThe time at which the checkpoint record was created.
list<CheckpointedItem>unionJustification submitted by the user to pass a checkpoint.
stringIdentifier of the project that scoped a checkpoint.
stringIdentifier of the organization associated with a checkpoint.
stringIdentifier of the namespace associated with a checkpoint.
stringIdentifier of the interaction associated with a record.
objectMetadata linking a checkpoint record to an Approvals workflow.
1
2
3
curl \
\t-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/checkpoints/records/ri.checkpoints.main.checkpoint.a1b2c3d4-e5f6-7890-abcd-ef1234567890?preview=true"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
34
35
36
37
38
39
40
{
"projectRid": "ri.compass.main.folder.d4e5f6a7-b8c9-0123-defa-234567890123",
"delegateUserId": "0d1fe74e-2b70-4a93-9b1a-80070637788b",
"configRid": "ri.checkpoints.main.config.b2c3d4e5-f6a7-8901-bcde-f12345678901",
"organizationRid": "ri.multipass..organization.e5f6a7b8-c9d0-1234-efab-345678901234",
"checkpointedItems": [
{
"type": "checkpointedResource",
"rid": "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da",
"resourceType": "DATASET",
"compassPath": {
"value": "/My Project/My Dataset"
},
"orgMarkings": []
}
],
"rid": "ri.checkpoints.main.checkpoint.a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"type": "CONTOUR_EXPORT",
"actingUser": {
"userId": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
"username": {
"value": "admin"
}
},
"createdAt": "2023-11-14T09:30:00.000Z",
"approvalsMetadata": {
"approvalsTaskId": "e3f4a5b6-c7d8-9012-efab-123456789012",
"approvalsSubtaskIds": [
"f4a5b6c7-d8e9-0123-fabc-234567890123"
]
},
"scope": "USER_SCOPED",
"interactionRid": "ri.checkpoints.main.checkpointable-interaction.c3d4e5f6-a7b8-9012-cdef-123456789012",
"namespaceRid": "ri.compass.main.folder.f6a7b8c9-d0e1-2345-fabc-456789012345",
"justification": {
"type": "acknowledgementJustification",
"prompt": "I acknowledge this action",
"title": "Export Confirmation"
}
}| Error Name | ||
|---|---|---|
Checkpoint | Error Code | NOT_FOUND |
| Status Code | 404 | |
| Description | The checkpoint record could not be found. | |
| Parameters | recordRid | |
Checkpoint | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | The caller does not have permission to access the checkpoint record. | |
| Parameters | recordRid | |
Record | Error Code | NOT_FOUND |
| Status Code | 404 | |
| Description | The given Record could not be found. | |
| Parameters | recordRid | |
See Errors for a general overview of errors in the platform.