Documentation
Documentation
    • English (United States)
Entity Query Filter
Close API Documentation
Entity Query Filter

The query filter allows to restrict the entities which are returned.

Properties
  • Children
    The 'children' can contain other filter nodes which are applied to the query. This property is only applicable on filter types 'OR' and 'AND'.
  • Field Name
    The 'fieldName' indicates the property on the entity which should be filtered. This property is only applicable on filter type 'LEAF'.
  • Operator
    The 'operator' indicates what kind of filtering on the 'fieldName' is executed on. This property is only applicable on filter type 'LEAF'.
  • Type
    The filter type controls how the query node is interpreted. I.e. if the node acts as leaf node or as a filter group.
  • Value
    The 'value' is used to compare with the 'fieldName' as defined by the 'operator'. This property is only applicable on filter type 'LEAF'.