Cisco Cisco Prime IP Express 8.3 Technical References

Page of 1286
Resource: CCMScopeTemplate
This resource is used to manage the 
 class of Network Registrar objects.
A template for creating a Scope object from a subnet address. Most attributes are copied literally from the template to
the newly created scope. Attributes of type AT_EXPR or AT_TEXPR are evaluated as expressions to generate a
subnet-specific value for the corresponding scope attribute.
Functions
Get CCMScopeTemplate Object List
Gets the list of Network Registrar CCMScopeTemplate objects.
Request:
GET /web-services/rest/resource/CCMScopeTemplate 
CCMScopeTemplate 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 CCMScopeTemplate 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 CCMScopeTemplate Object By Name
Gets the Network Registrar CCMScopeTemplate object by name.
Request:
GET /web-services/rest/resource/CCMScopeTemplate/{objectName}
objectName
: the string representation of the CCMScopeTemplate name property
Response:
Returns the CCMScopeTemplate object
Content-Type: application/xml, application/json
Put CCMScopeTemplate Object By Name
Modifies or creates the specified Network Registrar CCMScopeTemplate object.
Request:
PUT /web-services/rest/resource/CCMScopeTemplate/{objectName} 
Accept: application/xml, application/json 
objectName: the string representation of the CCMScopeTemplate 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 CCMScopeTemplate object, if created