Filter Syntax
The filter option enables custom querying of your data and supports the following grammar syntax.
Query nesting
The filter language supports arbitrary nesting of queries. Parentheses are used to express query nesting.
Example:
"(surname = \"smith\" OR surname = \"jones\") AND forename = \"mary\" "
Query composition
Supports conjunction, disjunction and negation combinations of queries.
Conjunction: <<query>> AND <<query>>
Disjunction: <<query>> OR <<query>>
Negation: NOT <<query>>
Operators
Each query then consists of an operator.
<<property>> BETWEEN <<NumericLiteral>> AND <<NumericLiteral >>
<<property>>NOT BETWEEN <<NumericLiteral > AND <<NumericLiteral >>
<<property>> IS NOT NULL
<<property>> IS NULL
<<property>> LIKE <<StringLiteral>>
Note: the LIKE operator can use the full range of the T-SQL LIKE syntax.
Example: <<property>> LIKE “%chatswood%”
<<property>> = <<Literal>>
<<property>> <> | != |> | >= | < | <= <<StringLiteral>>
Note: the ‘|’ symbol is used to delimit the range of valid operators.
Property names
This can be any valid property name that your data contains.
The system default property names that exist for all features are:
- DisplayName: A common field available for all types to use to standardise a field as the primary display name field.
- LastUpdated: Contains the datetime of when the record was updated or created.
- Feature_Id: a system generated unique identifier of the feature
- FeatureType_Id: The FeatureType_ID is reserved. To specify a feature type id for a query, you must use the type property on the getFeature(s) method.
Literals
Currently supports date, numeric, string literals and NULL.
Numeric Literals
Supports a signed or unsigned integer or float value.
String Literals
Should be enclosed within double quotes. To escape a double quote within a string, prefix with a backslash.
Example:
"MapData Sciences \"MDS\" Pty Ltd"