Get Dataset Schedules

GET/api/v2/datasets/{datasetRid}/getSchedules

Warning

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

Third-party applications using this endpoint via OAuth2 must request the following operation scopes: api:orchestration-read api:datasets-read.

Path parameters

datasetRid

string

The Resource Identifier (RID) of a Dataset.

Query parameters

branchName

string

optional

The name of the Branch. If none is provided, the default Branch name - master for most enrollments - will be used.

pageSize

integer

optional

The page size to use for the endpoint.

pageToken

string

optional

The 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.

preview

boolean

optional

Enables the use of preview functionality.

Response body

ListSchedulesResponse

object

Hide child attributes

data

list<ScheduleRid>

optional

Show child attributes

nextPageToken

string

optional

Examples

Request

Copied!

curl \
	-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/getSchedules?branchName=master&preview=true"

Response

Copied!

{
  "data": [
    "ri.scheduler.main.schedule.5ad5c340-59f3-4a60-9fc6-161bb984f871"
  ],
  "nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"
}

Error responses

Error Name
`BranchNotFound`	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`
`DatasetNotFound`	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`
`GetDatasetSchedulesPermissionDenied`	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.