How to Use the Filter
The Filter enables users to filter a dataset based on a human-readable filter string. This tool allows for dynamic and complex filtering by specifying conditions and logical operators like and and or.
Here’s a guide on how to use this function, focusing on fields like displayName, version, publisher, platform, deviceCount, sizeInByte, id, and application_url.
...
Filter String Format
The filter string should consist of conditions and logical operators (and, or).
Conditions
A condition specifies:
Field: The name of the field in the dataset you want to filter (e.g.,
displayName,platform).Operator: The comparison or matching operator (e.g.,
eq,gt,contains).Value: The value you want to compare, enclosed in single (
') or double (") quotes.
...
| Code Block |
|---|
platform eq 'iOS' |
Logical Operators
and: Combines multiple conditions where all conditions must be true.or: Combines multiple conditions where at least one condition must be true.
Note: You can use either and or or in a single filter but not both at the same time.
...
Supported Operators
Operator
Description
Example
eq
Operator | Description | Example |
|---|---|---|
|
Field is equal to the value
complianceState eq 'Compliant'
ne
Field is not equal to the value
jailBroken ne 'Yes'
gt
Field is greater than the value
lastSyncDateTime gt '2024-01-01T00:00:00Z'
lt
Field is less than the value
freeStorageSpaceInBytes lt 500000
ge
Field is greater than or equal to the value
totalStorageSpaceInBytes ge 64000000
le
Field is less than or equal to the value
managementCertificateExpirationDate le '2023-12-31T23:59:59Z'
contains
The field contains the value (for strings)
userDisplayName contains 'Smith'
startsWith
The field starts with the value (for strings)
deviceName startsWith 'Android'
endsWith
The field ends with the value (for strings)
emailAddress endsWith '@example.com'
Logical Operators
and: Combines multiple conditions where all conditions must be true.
or: Combines multiple conditions where at least one condition must be true.
Note: You can use either and or or in a single filter but not both at the same time.
Supported Operators
Checks if a field is equal to the specified value |
|
|
Checks if a field is not equal to the specified value |
|
|
Checks if a field is greater than the specified value |
|
|
Checks if a field is less than the specified value |
|
|
Checks if a field is greater than or equal to the specified value |
|
|
Checks if a field is less than or equal to the specified value |
|
|
Checks if a field contains the specified value (for strings) |
|
|
Checks if a field starts with the specified value (for strings) |
|
|
Checks if a field ends with the specified value (for strings) |
| |
| Checks if a field is empty (null, undefined, or an empty string) |
|
| Checks if a field is not empty |
|
...
Examples
Find Applications Published by "Apple":
...
| Code Block |
|---|
sizeInByte gt 1000000 or platform eq 'Android' |
Key Rules
Case Sensitivity:
Field names and string comparisons are case-sensitive. Ensure your field names and values match the case in the dataset.
Quotes:
Use single (
') or double (") quotes to enclose values.
Logical Operators:
You cannot mix
andandorin the same filter.
Empty Filter String:
If the filter string is empty or
null, the function returns the original dataset.