Administrator Guide

Filter Elements
Use the Filter element to fetch a list of objects of a specific entity. You can use a filter to perform Read and
Delete operations.
A filter contains a Criteria element that includes the following:
l fieldname: Specifies the name of the field present in XML that needs to be filtered.
l filterString: Specifies the string that is used to match the filter during a match of the filter.
l match: Specifies the operator to be used.
For example, the match operator equals/matches the value of the fieldname field in the Entity object
using filterString.
Filter Example
The following is an example of an XML request that contains a filter on a Guest user with a criteria to fetch
Guest users that match the name McIntosh.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<TipsApiRequest xmlns="http://www.avendasys.com/tipsapiDefs/1.0">
<TipsHeader version="3.0" source="Guest"/>
<Filter entity="GuestUser">
<Criteria fieldName="name" filterString="McIntosh" match="equals"/>
</Filter>
</TipsApiRequest>
Advanced Match Operations
When you specify multiple filters, the result can be a combination of the list of elements of all of the filter
criteria. For Match All criteria, specify the nested criteria as MoreFilterConditions. For match any criteria,
multiple filters with criteria can be specified for the Entity type. If a criteria is not specified, then the Advanced
Match operation fetches all objects of the Entity type.
Because the number of entities and the associated tag attributes with each entity can impact performance, the
complex query supported in the Advanced Match Operations should be used with care.
You can use the API to query based on tag attributes when the queries are not repeated.
With the XML request and response examples given in this section, you can use the Advanced Match
operation to fetch all objects of an Entity type.
XML Request
The following example describes the XML request that fetches all network devices with the IP address
192.0.2.10 and vendor IETF:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<TipsApiRequest xmlns="http://www.avendasys.com/tipsapiDefs/1.0">
<TipsHeader version="3.0"/>
<Filter entity="NadClient">
<Criteria fieldName="ipAddress" filterString="192.0.2.10" match="contains">
<MoreFilterConditions fieldName="name" fieldValue="IETF" match="equals"/>
</Criteria>
</Filter>
</TipsApiRequest>
Dell Networking W-ClearPass Deployment Guide Using the W-ClearPass Configuration API | 201