List flow transforms on the specified project. To learn more about flow transforms, read Flow transforms.
Listing, Sorting and Filtering Flow Transforms
This endpoint returns the list of flow transforms 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: metadata/name
, project
Filtering
There are two ways to filter the set of returned flow transforms 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 flow transforms 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: metadata/name
, project
$label_key
and $label
are specific to querying flow transforms based on their labels. Labels are a set of key-value pairs that can be used to identify flow transforms with
any arbitrary metadata you want, specifically for the purpose of retrieving relevant subsets of flow transforms.
Examples:
?$top=10
- Returns only the first 10 flow transforms from the list.
?$orderby=name desc
- Sorts flow transforms by name in descending order.
?$filter=name eq 'descriptive name'
- Returns flow transforms that match the provided name.
?$orderby=properties/created desc
- Sorts flow transforms by creation date in descending order.
?$filter=properties/created ge 2021-01-01T00:00:00Z
- Returns flow transforms created after January 1, 2021.
?$label=studio=paravalley
- Returns flow transforms with the label studio
set to paravalley
.
?$label=release-date~2023
- Returns flow transforms with the label release-date
set to a value that contains 2023
.
?$label_key=studio&label_key=release-date
- Returns flow transforms with any value set for the studio
label and the release-date
label.