Filter Operators
This documentation is for LiquidPlanner New: next.liquidplanner.com
| Operator | Description | Filter String | Use on (field type) | Note |
|---|---|---|---|---|
| [is] | Returns the requested data where the filtered attribute’s value matches the specified value | ?itemType[is]="packages" | string, enum string, number, boolean | |
| [is_not] | Returns the requested data where the filter attribute doesn’t match the specified value | ?itemType[is_not]="tasks" | string, enum string, number | |
| [in] | Returns the requested data, if the filter attribute’s value matches any one of the specified values | ?id[in]=["425261","425263"] | string, enum string, number | Encode operator and value |
| [not_in] | Returns the requested data, where the filter attribute’s value does not match any of the specified values | ?id[not_in]=["425261","425263"] | String, enum string, number | Encode operator and value |
| [is_present] | If the specified value is 'true', returns the requested data that has its filter attribute value set (i.e. not null), and if the specified value is 'false', returns the requested data that does not have its filter attribute value not set (i.e. null) | ?name[is_present]="false" | string, enum string, number, dateTime, boolean | |
| [starts_with] | Returns the requested data, where the filter attribute's value starts with the specified value | ?name[starts_with]="Sample" | string | |
| [gt] | Returns the requested data, where the filter attribute's value is greater than the specified value | ?id[gt]=”1234” | number | |
| [lt] | Returns the requested data, where the filter attribute's value is less than the specified value | ?id[lt]="1234" | number | |
| [lte] | Returns the requested data, where the filter attribute's value is less than or equal to the specified value | ?id[lte]="1234" | number | |
| [between] | Takes two values as input. Returns the requested data, where the filter attribute's value falls within the specified range (the range is inclusive) | ?expectedStart[between]=["2019-01-01T00:00:00Z","2023-01-01T00:00:00Z"] | number, dateTime | Encode operator and value |
| [on] | Returns the requested data, where the filter attribute's value is equal to the provided date | ?targetFinish[on]="2022-08-23" | date | Supply date in ISO format. Example: 2022-08-01 |
| [before] | Returns the requested data, where the filter attribute's value is less than the specified timestamp value | ?expectedStart[before]="2022-11-09T00:00:00Z" | dateTime | |
| [after] | Returns the requested data, where the filter attribute's value is greater than the specified timestamp value | ?expectedStart[after]="2022-11-09T00:00:00Z" | dateTime |
Updated about 2 years ago