Query operation legacy filter support (prior to version 1.1.0)

Filtering is supported with the API before version 1.1.0. The syntax is still supported with the current version of the API.

Query operations can support various filtering options. The filter fields that are available are based on the elements in the schema provided during browsing. By default, available filter fields are created for each child element that is of a simple type based on the root element of the schema.

For example, your schema may describe an XML structure like the following.

<User>
  <firstName>Joe</firstName>
  <lastName>Smith</lastName>
  <phone>555-1234</phone>
</User>

The firstName, lastName, and phone fields are available by default as filters for the Query operation. You can use the annotations in your schema to add/remove fields from the available field list. For example, you can add the following annotation to the sample phone element definition in the User schema to ignore the phone element.

<xs:annotation>
  <xs:appinfo>
    <filter ignore="true" xmlns="http://www.boomi.com/connector/annotation" />
  </xs:appinfo>
</xs:annotation>

If you add the following code to the top-level User element in the sample schema, additional filter field options are added. In this example, you add the email and fullName filter field options.

<xs:annotation>
  <xs:appinfo>
    <filter ignore="false" xmlns="http://www.boomi.com/connector/annotation">
      <field name="email"/>
      <field name="fullName"/>
    </filter>
  </xs:appinfo>
</xs:annotation>

If you use ignore="true" at the top-level element, all child elements are ignored as filter options.