Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

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.

Example Condition:

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

  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 value

platform eq 'iOS'

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":

publisher eq 'Apple'

Find Applications with Device Count Greater Than 50:

deviceCount gt 50

Find Applications for iOS and Published by Microsoft:

platform eq 'iOS' and publisher eq 'Microsoft'

Find Applications Hosted on .com URLs:

application_url endsWith '.com'

Find Applications Larger Than 1MB or Running on Android:

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.

  • No labels