Cisco Cisco Prime IP Express 8.3 Technical References

Page of 1286
Resource: ClientClass
This resource is used to manage the 
 class of Network Registrar objects.
A client-class description. A client-class defines the selection criteria and configuration for a group of clients.
Functions
Get ClientClass Object List
Gets the list of Network Registrar ClientClass objects.
Request:
GET /web-services/rest/resource/ClientClass 
ClientClass string properties may be specified as query parameters to filter the return list. Filter
values can specify a regular expression or exact match. Use an empty string to test for unset
values.
Response:
Returns the list of ClientClass objects
Content-Type: application/xml, application/json
If the list exceeds the maximum return list size, the next link is provided to get the next set of
objects.
Get ClientClass Object By Name
Gets the Network Registrar ClientClass object by name.
Request:
GET /web-services/rest/resource/ClientClass/{objectName}
objectName
: the string representation of the ClientClass name property
Response:
Returns the ClientClass object
Content-Type: application/xml, application/json
Put ClientClass Object By Name
Modifies or creates the specified Network Registrar ClientClass object.
Request:
PUT /web-services/rest/resource/ClientClass/{objectName} 
Accept: application/xml, application/json 
objectName: the string representation of the ClientClass name property 
Query Parameters 
  action: extra action to perform; value can be 'push' 
When connected to a regional server, the optional push action will push the object to the
specified local clusters after changes are made. If the input object is null, or identical to the
currently saved object, only the push action will be performed. 
Action Parameters 
  localCluster: the cluster or pair name; use repeated parameters or a comma-separated list to
specify a multiple entries 
  mode: the sync mode; value can be 'ensure', 'replace', or 'exact' 
At least one local cluster or pair must be specified. By default, changes will be made in 'replace'
mode.
Response:
Returns the location of the ClientClass object, if created
Content: none
Create ClientClass Object