SearchFilter

Description

The SearchFilter object defines one or more fields and the corresponding values used to narrow down search results. It determines which records are returned based on the specified matching criteria.

Properties

TypeNameDescription
stringFieldNameName of the field being searched.
stringComparisonOperatorOperation to use when performing a comparison. See below for the different types of comparisons allowed.
List of Comparisons
  • eq (equals)
  • gt (greater than)
  • lt (less than)
  • ge (greater than or equal to)
  • le (less than or equal to)
  • ne (not equal)
stringFieldValueValue to search for.