Cisco Cisco Prime Collaboration 10.5 User Guide

 

 

© 2012-2014 Cisco and/or its affiliates. All rights reserved. This document is Cisco Public. 

Page 13 of 78 

 

Overview of Request Arguments 

Create NBI requests will always take the managed object as an argument. Key attributes and mandatory attributes 

for creation must be specified in the object. All other attributes may be specified with their initial settings. 

Get NBI requests will always take the managed object as the first argument. The client sets only the specific 

attributes that define a unique key. Metadata attributes are not required or expected. 

Delete NBI requests will always take the managed object as the first argument. The client sets only the specific 

attribute(s) that define a unique key. Metadata attributes are not required or expected. 

Update NBI requests will take managed object as the first argument. The user must set the attributes that are 

specifically defined in the object. The only metadata attributes that need be specified are those the client wants to 

change. 

For removing a specific value from attributes that have multiple values, there is an action attribute that is a peer of 

the attribute to be updated. Set the action attribute to REMOVE. The values to be removed are specified by their 

key attributes. 

List NBI requests take a CupmApiFilter object as the argument. The filter contains metadata pairs of attribute name 

and value that define the selection criteria. The metadata can be grouped to support one ‘and’ or one ‘or’ query. A 

null filter is allowed for generating a list of all instances of that object. The filter also has a flag indicating whether 

the client wants a list of object keys returned, a specified set of attributes returned, or a list of complete objects 

returned. Default is to return only the object keys. 

Configurable Properties 

The metadata configurable properties in the objects Domain, Device, Service Area, and Subscriber are defined by 

enumerations in the XSD files. Please refer to the html documentation provided for details.  

You can find the html files in the SDK in the subdirectory html-doc folder. In the html-doc folder there are 

subdirectories that support the requests for that object or category. For example, for createDevice, listDevice, and 

so on, you go to the Device folder. Click the html file in the appropriate directory to display the documentation. 

Prime Collaboration Provisioning NBI Objects 

 

Objects are traditionally supported by an interface with the naming convention <object>Value. 

Key attribute: deviceName