Query Interface

The Basic listing of resources on the Limecraft Flow API allows filtering by providing filter query parameters. Currently, only the fq (filter query) parameter is supported to filter the results by targeting specific properties.

Filter Exact

To filter resources with an exact match, use the following API call format:

GET /api/production?fq=name:MyProductionName

Wildcards

In most cases, wildcards are supported to filter resources with partial matches:

GET /api/production?fq=name:MyProduction*

Special characters

Special characters (such as :) need to be escaped or enclosed in quotes. The following example shows how to filter resources by name with special characters:

GET /api/production?fq=name:"MyProduction:WithColon"

GET /api/production?fq=name:MyProduction\:WithColon

Combine filters

Filter queries can be combined to create more complex queries.

AND

By default, all filter query parameters are combined using the AND operator. For example, the following API call will return all file resources that have the funnel property set to TempFile and mimeType property set to video/mp4:

GET /api/production/12345/file?fq=funnel:TempFile&fq=mimeType:video/mp4

OR

To perform OR queries, use brackets to group values. For example, the following API call will return all file resources that have mimeType property set to either video/mp4 or video/mov:

GET /api/production/12345/file?fq=mimeType:(video/mp4 video/mov)

Negate

Filter queries can be negated using the minus sign. For example, the following API call will return all file resources that do not have mimeType property set to either video/mp4 or video/mov:

GET /api/production/12345/file?fq=-mimeType:(video/mp4 video/mov)

All calls that support this level of filtering will be marked, and the list of available properties on which can be filtered will be made available.