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 Schedules that target the given Dataset.
Note: It may take up to an hour for recent changes to schedules to be reflected in this response, especially for schedules managed by Marketplace. This operation will return outdated results in the meantime.
Third-party applications using this endpoint via OAuth2 must request the following operation scopes: api:orchestration-read api:datasets-read.
stringThe name of the Branch. If none is provided, the default Branch name - master for most enrollments - will be used.
integerThe page size to use for the endpoint.
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.
booleanEnables the use of preview functionality.
objectlist<ScheduleRid>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
curl \
\t-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/getSchedules?branchName=master&preview=true"1
2
3
4
5
6
{
"data": [
"ri.scheduler.main.schedule.5ad5c340-59f3-4a60-9fc6-161bb984f871"
],
"nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"
}| 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 getSchedules the Dataset. | |
| Parameters | datasetRid | |
See Errors for a general overview of errors in the platform.