Expression | SQL Equals | Example | >
---|---|---|
EQ | = | &filter[property][EQ]=12340 |
NEQ | <> | &filter[property][NEQ]=12340 |
GT | > | &filter[property][GT]=12340 |
GTE | >= | &filter[property][GTE]=12340 |
LT | < | &filter[property][LT]=12340 |
LTE | <= | &filter[property][LTE]=12340 |
IN | IN | &filter[property][IN]=12340&filter[property][IN]=165822 |
NIN | NOT IN | &filter[property][NIN]=12340&filter[property][NIN]=165822 |
LIKE | LIKE | &filter[property][LIKE]=Arn% |
NLIKE | NOT LIKE | &filter[property][NLIKE]=Arn% |
BETWEEN | BETWEEN | &filter[property][BETWEEN]=12340&filter[property][BETWEEN]=165822 |
You can use several filters together and it will then be interpreted as AND.
Note: Do not use quotation marks (like "this" or 'this') when using filters. All parameters will be interpreted on our side, use our examples where possible. Enums and strings should be written out without quotation marks.([parameter][EQ]=this)
Selecting the article with id between 120 and 150, take 50 rows, skip 0 rows, order by id descending. Note that id is an integer datatype
{
"id": {
"BETWEEN": [
120, 150
]
},
"take": 50,
"skip": 0,
"orderby": {
"desc": [
"id"
]
}
}
As url:
filter[id][BETWEEN]=1&filter[id][BETWEEN]=20&filter[take]=50&filter[skip]=0&filter[orderby][desc]=id
Selecting all articles with articleType in "hour","normal"
{
"articleType": {
"IN": [
"hour",
"normal"
]
}
}
As url:
filter[articleType][in]=hour&filter[articleType][IN]=normal
Use the Rowversion on the mother object to filter on newer or older versions. Its only possible to use [GT] (only) on Rowversion due to datatype limitations. To get those rows that has been changed since the last query, you have to take the MAX(Rowversion) of the "mother" object from that result and select like the next time to get the new and changed rows:
{
"rowversion": {
"GT": [
"9535698"
]
}
}
As url:
filter[Rowversion][GT]=9535698
You can query two levels deep like this:
{
"carrierType.carrierTypeKind": {
"NIN": [
"free", "activity"
]
},
"take": 50,
"skip": 50,
"orderby": {
"asc": [
"id"
]
}
}
As url:
carrierType.carrierTypeKind][NIN]=free&filter[carrierType.carrierTypeKind][NIN]=activity&filter[take]=50&filter[skip]=50&filter[orderby][asc]=id