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 Jobs for the given dataset. By default, returned Jobs are sorted in descending order by the Job start time.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:datasets-read.
stringThe name of the Branch. If none is provided, the default Branch name - master for most enrollments - will be used.
integerMax number of results to return. A limit of 1000 on if no limit is supplied in the search request
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.
objectunionQuery for getting jobs on given dataset.
list<GetDatasetJobsSort>objectlist<JobDetails>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/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/jobs?branchName=master&preview=true" \
-d '{"orderBy":[{"sortType":"BY_STARTED_TIME","sortDirection":"DESCENDING"}],"where":{"type":"timeFilter","field":"SUBMITTED_TIME","comparisonType":"GTE","value":"2020-09-30T14:30:00Z"}}'1
2
3
4
5
6
7
8
{
"nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z",
"jobs": [
{
"jobRid": "ri.foundry.main.job.aaf94076-d773-4732-a1df-3b638eb50448"
}
]
}| 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 jobs the Dataset. | |
| Parameters | datasetRid | |
See Errors for a general overview of errors in the platform.