...
Operators are not case sensitive. All operators are available in short or long version.
Long | Short | Definition | ||||
|---|---|---|---|---|---|---|
equals | eq | Equals to | ||||
notequals | neq | Not equals to | ||||
greaterthan | gt | Greater than | ||||
greaterorequals | gte | Greater than or equals to | ||||
lesserthan | lt | Lesser than | ||||
lesserorequals | lte | Lesser than or equals to | ||||
empty | e | Void or null | ||||
notempty | ne | Non void and non null | ||||
in | in | Belongs to | ||||
notin | nin | Does not belong to | ||||
startswith | sw | Starts with | ||||
notstartswith | nsw | Does not start with | ||||
endswith | ew | Ends with | ||||
notendswith | new | Does not end with | ||||
contains | ct | Contains | ||||
notcontains | nct | Does not contains | ||||
descendantof
| dof | Descendant of | ||||
notdescendantof
| ndof | Not descendant of | ||||
overlap
| ovrl | Overlapping of two ranges |
Operators can use any type. The type value is adapted depending on the context.
E.g. all following expressions are equivalent:
...
Type: text, sentence, word, html
Long | Short | Definition | Multivalued |
|---|---|---|---|
equals | eq | Equals to | yes |
notequals | neq | Not equals to | yes |
empty | e | Void or null | no |
notempty | ne | Non void and non null | no |
in | in | Belongs to | yes |
notin | nin | Does not belong to | yes |
startswith | sw | Starts with | yes |
notstartswith | nsw | Does not start with | yes |
endswith | ew | Ends with | yes |
notendswith | new | Does not end with | yes |
contains | ct | Contains | yes |
notcontains | nct | Does not contain | yes |
Type: number (integer or real)
Long | Short | Definition | Multivalued |
|---|---|---|---|
equals | eq | Equals to | yes |
notequals | neq | Not equals to | yes |
greaterthan | gt | Greater than | yes |
greaterorequals | gte | Greater than or equals to | yes |
lesserthan | lt | Lesser than | yes |
lesserorequals | lte | Lesser than or equals to | yes |
empty | e | Void or null | no |
notempty | ne | Non void and non null | no |
Type: boolean
Long | Short | Definition | Multivalued |
|---|---|---|---|
equals | eq | Equals to | yes |
notequals | neq | Not equals to | yes |
empty | e | Void or null | no |
notempty | ne | Non void and non null | no |
Type: timestamp (dates)
The value is automatically converted to the appropriate type according to the type of the compared field (date or datetime). The dates comparison values could be set in JavaScript timestamp (as long) or using simple ISO strings.
Long | Short | Definition | Multivalued |
|---|---|---|---|
equals | eq | Equals to | yes |
notequals | neq | Not equals to | yes |
greaterthan | gt | Greater than | yes |
greaterorequals | gte | Greater than or equals to | yes |
lesserthan | lt | Lesser than | yes |
lesserorequals | lte | Lesser than or equals to | yes |
empty | e | Void or null | no |
notempty | ne | Non void and non null | no |
Value and format
The dates comparison values could be set in JavaScript timestamp (as long) or using simple ISO strings.
...
Path for resources can use slash (/) or backslash (\) indifferently.
Long | Short | Definition | Multivalued |
|---|---|---|---|
equals | eq | Equals to | yes |
notequals | neq | Not equals to | yes |
empty | e | Void or null | no |
notempty | ne | Non void and non null | no |
startswith | sw | Starts with | yes |
notstartswith | nsw | Does not start with | yes |
endswith | ew | Ends with | yes |
notendswith | new | Does not end with | yes |
contains | ct | Contains | yes |
notcontains | nct | Does not contains | yes |
Type: object
The test value shall be an object identifier or void for empty or not empty.
Long | Short | Definition | Multivalued |
|---|---|---|---|
equals | eq | Equals to | yes |
notequals | neq | Not equals to | yes |
empty | e | Void or null | no |
notempty | ne | Non void and non null | no |
in | in | Belongs to | yes |
notin | nin | Does not belong to | yes |
descendantof | dof | Descendant of | yes |
notdescendantof | ndof | Not descendant of | yes |
Type: array
Long | Short | Definition | Multivalued |
|---|---|---|---|
empty | e | Void or null | no |
notempty | ne | Non void and non null | no |
in | in | Belongs to | yes |
notin | nin | Does not belong to | no |
contains | ct | Contains | yes |
notcontains | nct | Contains | yes |
descendantof | dof | Descendant of | yes |
notdescendantof | ndof | Not descendant of | yes |
Type: identity
Long | Short | Definition | Multivalued |
|---|---|---|---|
equals | eq | Equals to | yes |
notequals | neq | Not equals to | yes |
greaterthan | gt | Greater than | yes |
greaterorequals | gte | Greater than or equals to | yes |
lesserthan | lt | Lesser than | yes |
lesserorequals | lte | Lesser than or equals to | yes |
empty | e | Void or null | no |
notempty | ne | Non void and non null | no |
in | in | Belongs to | yes |
notin | nin | Does not belong to | yes |
Type: uuid
It is possible to make queries on the uuid, even though it is not a field per se of an instance. Simply specify $uuid in the property name.
Long | Short | Definition | Multivalued |
|---|---|---|---|
equals | eq | Equals to | yes |
notequals | neq | Not equals to | yes |
greaterthan | gt | Greater than | yes |
greaterorequals | gte | Greater than or equals to | yes |
lesserthan | lt | Lesser than | yes |
lesserorequals | lte | Lesser than or equals to | yes |
empty | e | Void or null | no |
notempty | ne | Non void and non null | no |
in | in | Belongs to | yes |
notin | nin | Does not belong to | yes |
Subqueries
| Status | ||
|---|---|---|
|
...
Properties currently available:
variable pattern | Definition |
|---|---|
${surfer.id} | Surfer/user id |
${surfer.name} | Surfer/user name |
${surfer.role} | Surfer/user role name |
${surfer.role.id} | Surfer/user role id |
${surfer.locale} | Surfer/user locale |
${surfer.localejs} | Surfer/user locale (html/js syntax) |
${surfer.login} | Surfer/user login |
${surfer.props.<property name>} | Surfer/user custom property named <property name> |
Errors codes
HTTP code | API Code | Definition |
|---|---|---|
400 | 400/800 | Request syntax error |
Query policies
| Status | ||
|---|---|---|
|
...