Filter parameter

Owned by Pettrie de Bondt
Last updated: 31 Oct 2024 by Gerard Immeker
2 min read

How to filter your request? What is the syntax for the filter parameter?

Filter

A lot of REST/API endpoints for a GET on multiple entries have the ability to filter on the returned entries.

The filter always exists with one or more fields to filter on, e.g. field = value.

Input

Expression

Filter to supply

Expression

Filter to supply

field = value

field[eq]:value

field <> value

field[nq]:value

field <= value

field[le]:value

field >= value

field[ge]:value

field like value

field[like]:value (does only applies to string values)

field ilike value

field[ilike]:value (does only applies to string values)

field in value

field[in]:value
(multi value separated bij semi-colon ; )

field = "value with colon : or comma , " 

Surround value with double quotes

field[eq]:"value:,"

field = <empty>

Supply value as two double quotes

field[eg]:""





field1=value or field2=value

Separate two filters with comma and minus

field1[eq]:value,-field2[eq]:value

field1=value and field2=value

Seperate two filters with comma

field1[eq]:value,field2[eq]:value

(field1=value1 or field2=value1) and
(field3=value3 or field4=value4)

Use brackets

(field1[eq]:value,-field2[eq]:value),(field3[eq]:value,-field4[eq]:value)

field1 is null

field1[eq]:null

NOTE: no quotes

field 1 niet null

field1[nq]:null

NOTE: no quotes

field1 >= date

created_date[ge]:"2020-06-22"

field1>= date + time

modified_date[ge]:"2020-06-24T16:00.00"


Formatting

Extra

Explanation

Extra

Explanation

Text type fields (VARCHAR, TEXT)

Alle diacritics are replaced with normal characters (using the zappdiacritics)

e.g. Citroën > Citroen

Field: Licenceplate

All minus characters are removed

e.g. KZ-313-X > KZ313X

like and ilike operators

Values with the expression like and ilke are automatically supplied with % <percent>

e.g. field[like]:"dam" > like "%dam%"

Date and datetime fields have to be formated like: YYYY-MM-DD HH24:MI

Samples

# Sample: Search on licence plate license_plate[eq]:"kz-313-x" # Sample: Search on two vehicle ID's with an OR expression (-vehicle_id[eq]:60CEB4E9-9077-440E-9C01-29754A4C2EEE,-vehicle_id[eq]:E506CB2B-5972-4D17-9B06-6004B8978FFF) # Sample: Find all vehicles without a brand, empty "" or null (brand[eq]:"",-brand[eg]:null) /# Sample: Find vehicles with brand Fiat or Volvo (brand[eg]:"fiat",-brand[eg]:"volvo") # Sample: Find vehicle created between januari and februari created_date[ge]:"2019-01-01",created_date[le]:"2019-03-01" # Sample: Find all articles without description description[nq]:null # Sample: search on id's (multiple seperated bij semi-colon ;) in table user_id[in]:60CEB4E9-9077-440E-9C01-29754A4C2EEE;60CEB4E9-9077-440E-9C01-29754A4C2EEE

 

 

Error messages


Error: QueryOperator not valid

Meaning: The block hooks are not valid

Error: Filter not valid

Meaning: Multiple filters are not separated correctly


Related articles

 

Â