Child pages
  • Admin API Complex Type searchFilter

This documentation is for a previous version of Flexiant Cloud Orchestrator. The most recent version is v5.0. For the most recent documentation please see here

Skip to end of metadata
Go to start of metadata

Description
The searchFilter class holds the base data for each search filter.
Derived By
Restricting anyType
Content Model
Contains elements as defined in the following table.

Component

Type

Occurs

Description

filterConditions

filterCondition

0..*

an array of filter conditions applying to this filter.

Remarks
Search filter objects are used to restrict the data that the methods with names starting 'list' return, based on the data itself. They allow filtering of the objects returned by zero or more filterCondition objects. Each filterCondition object specifies a match criterion against one member of the complex type being searched against.
For example, if the listCustomers call is used, then customerDetails objects are searched and, if they meet the criteria supplied in the searchFilter supplied, returned. The customerDetails object contains a status field and a billingEntityUUID field. By setting filterConditions for each of these, it is possible to search on both status and billing entity UUID simultaneously.
Each filterCondition consists of a field identifier, and a condition, and a value. For more details on filterConditions, see the filterCondition complex type.
Note, that each filterCondition object must refer to a different field; it is not possible to have two filterConditions which refer to the same field. In order to search records where one field falls between a range, use a single filterCondition with the BETWEEN condition selected. There is no restriction on having multiple filterConditions provided each refers to a distinct field. Only records that match all the filter conditions supplied are returned by the relevant list call.

  • No labels