Versions Compared

Version Old Version 3 New Version 4
Changes made by

Pio

Pio

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Reverted from v. 1

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:

  1. Field: The name of the field in the dataset you want to filter (e.g., displayName, platform).

  2. Operator: The comparison or matching operator (e.g., eq, gt, contains).

  3. Value: The value you want to compare, enclosed in single (') or double (") quotes.

...

Code Block
platform eq 'iOS'

Logical Operators

  1. and: Combines multiple conditions where all conditions must be true.

  2. 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

Field is equal to the

specified

value

complianceState eq 'Compliant'

ne

Field is not equal to the

specified

value

jailBroken ne 'Yes'

gt

Field is greater than the

specified

value

lastSyncDateTime gt '2024-01-01T00:00:00Z'

lt

Field is less than the

specified

value

freeStorageSpaceInBytes lt 500000

ge

Field is greater than or equal to the

specified

value

totalStorageSpaceInBytes ge 64000000

le

Field is less than or equal to the

specified

value

managementCertificateExpirationDate le '2023-12-31T23:59:59Z'

contains

The field contains the

specified

value (for strings)

userDisplayName contains 'Smith'

startsWith

The field starts with the

specified

value (for strings)

deviceName startsWith 'Android'

endsWith

The field ends with the

specified

value (for strings)

emailAddress endsWith '@example.com'

isEmpty

The field is empty (null, undefined, or empty string)

emailAddress isEmpty

isNotEmpty

The field is not empty

emailAddress isNotEmpty

and

...

Logical Operators

  1. and: Combines multiple conditions where all conditions must be true

...

  1. .

  2. or

...

  1. : 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

Field is equal to the value

platform eq 'iOS'

or

ne

Field is not equal to the value

publisher ne 'Microsoft'

gt

Field is greater than the value

deviceCount gt 10

lt

Field is less than the value

sizeInByte lt 500000

ge

Field is greater than or equal to the value

deviceCount ge 20

le

Field is less than or equal to the value

sizeInByte le 1000000

contains

The field contains the value (for strings)

displayName contains 'App'

startsWith

The field starts with the value (for strings)

publisher startsWith 'Apple'

endsWith

The field ends with the value (for strings)

application_url endsWith '.com'

...

Examples

Find Applications Published by "Apple":

...

Code Block
sizeInByte gt 1000000 or platform eq 'Android'

Key Rules

  1. Case Sensitivity:

    • Field names and string comparisons are case-sensitive. Ensure your field names and values match the case in the dataset.

  2. Quotes:

    • Use single (') or double (") quotes to enclose values.

  3. Logical Operators:

    • You cannot mix and and or in the same filter.

  4. Empty Filter String:

    • If the filter string is empty or null, the function returns the original dataset.