Listing, Sorting and Filtering Live Outputs
This endpoint returns the list of live outputs in the specified project.
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
, properties/created
, properties/description
, properties/lastModified
Filtering
There are two ways to filter the set of returned live outputs 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 live outputs 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
, properties/created
, properties/description
, properties/lastModified
Examples:
?$top=10
- Returns only the first 10 live outputs from the list.
?$orderby=name desc
- Sorts live outputs by name in descending order.
?$filter=name eq 'descriptive name'
- Returns live outputs that match the provided name.
?$orderby=properties/created desc
- Sorts live outputs by creation date in descending order.
?$filter=properties/created ge 2021-01-01T00:00:00Z
- Returns live outputs created after January 1, 2021.