Listing, Sorting and Filtering Scheduled Operations
This endpoint returns the list of scheduled operations.
Sorting
The results from this endpoint can be ordered using the $orderby
query parameter. Specify a field name, and optionally asc
or desc
.
Sorting is valid on the following fields: name
, startTme
, endTime
, type
Filtering
There are two ways to filter the set of returned scheduled operations from this endpoint - the first is to use the $filter
query parameter, the second is to use the
$label_key
and $label
query parameters.
$filter
allows for scheduled operations to be filtered on the basis of fields in the schema using OData query syntax.
See this document for more details on the syntax used.
Filters are valid on the following fields: name
, startTme
, endTime
, type
$label_key
and $label
are specific to querying scheduled operations based on their labels. Labels are a set of key-value pairs that can be used to identify scheduled operations with
any arbitrary metadata you want, specifically for the purpose of retrieving relevant subsets of scheduled operations.
Examples:
?$top=10
- Returns only the first 10 scheduled operations from the list.
?$orderby=name desc
- Sorts scheduled operations by name in descending order.
?$filter=name eq 'descriptive name'
- Returns scheduled operations that match the provided name.
?$orderby=properties/created desc
- Sorts scheduled operations by creation date in descending order.
?$filter=properties/created ge 2021-01-01T00:00:00Z
- Returns scheduled operations created after January 1, 2021.
?$label=studio=paravalley
- Returns scheduled operations with the label studio
set to paravalley
.
?$label=release-date~2023
- Returns scheduled operations with the label release-date
set to a value that contains 2023
.
?$label_key=studio&label_key=release-date
- Returns scheduled operations with any value set for the studio
label and the release-date
label.