Filter

Filter [Filter] objects limit the authenticated user to a subset of business objects of a certain type. The Filter objects designate the business objects of a particular type that the authenticated user can or cannot view. Filter objects are grouped into filter sets. See Filterset.

Review the Usage Guidelines for the Filter object.

—	XML	SOAP	REST	Database table
Object	Filter	—	—	filter
Supported Commands	Read (all)	—	—	—

Note:

The Filter object supports the all read method only.

The Filter object has the following properties:

XML	Database	Description
id	filter_id	[Read-only] Unique ID. Automatically assigned by OpenAir.

Usage Guidelines

The Filter supports only the Read with the all method.

The Filter object element must include the attribute type. The type attribute value indicates the business object type. The only supported value is customer.

You can use XML API to read the internal IDs of Customer objects that the authenticated user can or cannot view. For example, you can use the following request:

            <Read type="Filter" method="all" limit="1000">
</Read> 

          

In the sample response, positive internal ID [id] values reference specific business objects, and negative values reference metavalues relative to the user. The internal IDs 0 and 1 should be ignored.

            <Read status = "0">
   <Filter type="customer">
      <id>1</id> 
      <id>0</id> 
      <id>21</id> 
      <id>24</id>
      <id>39</id>
      <id>-5</id>
      <id>-17</id>
      <id>-7</id>
   </Filter>
</Read > 

          

Important:

When defining filter sets and filters in the OpenAir UI, account administrators can choose whether to include the selected values (that is, select the business objects that user with the filter set can view) or to exclude the selected values (that is, select the business objects that user with the filter set cannot view). This is represented by the column exclude in the filter database table. However, the Filter object in the XML API does not include this object property.