User Guide

24 Chapter 2: Working with Filters
Filtering a specific number of entries starting at a specific entry
You can use the following technique to create pagination when there is too much data for one
page. The following example shows 25 records starting at the 100th record:
filter-rows=25&filter-start=100
Filtering by membership in standard groups
To filter by membership in standard groups, filter by the type field, as in the following example:
action=principal-list&filter-type=admins
Do not use the name field to filter by membership in standard groups because the group names
can be changed and are therefore unreliable. For example, the following example shows an
incorrect way to filter by group membership:
action=principal-list&filter-name=Account Administrators
Filter reference
Filters comprise a type (either filter or sort) with an optional modifier, the name of the field, if
needed, and finally, the value of the field name, as the following example shows:
Type-Modifier-FieldName=Value
The following table lists all the filter types and modifiers that you can use with Breeze:
Type Modifier Description
filter (none)
Field must match value exactly.
filter like
Field must contain value.
filter out
Field cannot contain value.
filter rows
Limits the return result to number of rows specified in value. Does not use the
field name.
filter start
Limits the return result to number of rows specified in value. Does not use the
field name.
filter gt
Selects all items greater than the value. Works only with dates.
filter lt
Selects all items greater than the value. Works only with dates.
filter gte
Selects all items greater than or equal to the value. Works only with dates.
filter lte
Selects all items less than or equal to the value. Works only with dates.
sort (none)
Sorts results. Value must be asc or desc.