Users Guide
Dell Networking W-ClearPass Policy Manager | Configuration APIGuide Other API Methods | 14
Chapter 4
Other API Methods
The following other API methods are available in the ClearPass Configuration API:
l NameList
l Reorder
l Status Change
NameList
The NameList method returns the list of names for all objects created for an Entity type. The XML request contains an
EntityNameList request passed in the entity-type. Multiple EntityNameList requests can be passed for different Entity
types. In the XML response, EntityNameList is populated with the entity-names. The list of names in the XML
response is not displayed in a specific order. However, for the entities that have a specific order (for example,
Services), the names are populated in the order as specified in the EntityNameList.
The URL for the NameList method is https://<server>/tipsapi/config/namelist/<Entity>. The following is an example
of the XML request for the NameList method:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<TipsApiRequest xmlns="http://www.avendasys.com/tipsapiDefs/1.0">
<TipsHeader version="3.0"/>
<EntityNameList entity="Service"/>
</TipsApiRequest>
The following is an example of the XML response for the NameList method:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<TipsApiResponse xmlns="http://www.avendasys.com/tipsapiDefs/1.0"><TipsHeader
exportTime="Wed May 28 15:39:01 IST 2014" version="6.3"/>
<StatusCode>Success</StatusCode>
<EntityNameList entity="Service"><Name>[Policy Manager Admin Network Login Service]
</Name><Name>[AirGroup Authorization Service]</Name><Name>[Aruba Device Access Service]
</Name><Name>[Guest Operator Logins]</Name><Name>test 802.1X Wireless</Name>
</EntityNameList>
</TipsApiResponse>
Reorder
The Reorder method receives a list of names of objects of the entity type and applies the new order to the list of
objects. The XML request contains an EntityOrderList that should specify the entity-type and a list of names. This list
should contain the names of all elements of the entity-type. The new order is returned in the XML response. Multiple
EntityOrderList for different entity-types can be passed in the request. The Reorder method is available for the
Services entity-type.
The URL for the Reorder method is https://<server>/tipsapi/config/reorder/<Entity>. The following is an example of
the XML request for the Reorder method:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<TipsApiRequest xmlns="http://www.avendasys.com/tipsapiDefs/1.0">
<TipsHeader version="6.3"/>
<EntityOrderList entity="Service"><Name>[Aruba Device Access Service]</Name>
<Name>[Guest Operator Logins]</Name><Name>test 802.1X Wireless</Name>
<Name>[Policy Manager Admin Network Login Service]</Name>
<Name>[AirGroup Authorization Service]</Name></EntityOrderList>