Cisco Cisco Prime Collaboration 10.5 Developer's Guide

 

 

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

13 

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 

Complete Object Definition File: Device.xsd 

Key attribute: domainID 

Complete Object Definition File: Domain.xsd 

Key attributes: serviceAreaID 

Complete Object Definition File: ServiceArea.xsd 

For querying, any object in Inventory Manager can be referenced. 

Key attribute: The InventoryItem object will be set to a Prime Collaboration Provisioning IM object type. There is a 

metadata attribute name and value for the object type’s key attributes. You must specify the IM class name and the 

attribute value which will uniquely identify the object in the case of a get API or a list API. Multiple instances are 

returned if there are no other attributes provided. 

Complete Object Definition File: InventoryItem.xsd 

For querying, any configured infrastructure product or any subscriber service product can be returned in a get or a 

list request. 

Key Attribute: The key attributes for the get service requests are specified as an array of metadata in an attribute 

called keyAttribute. Refer to the services table in this document for specific keys for specific products. Another way 

to determine the keys for a product is to list all products for a device or a subscriber. The list will return only the 

keys and their values. 

Complete Object Definition File: Order.xsd 

The work order ID is only used internally within the Prime Collaboration Provisioning server. Orders submitted 

through the user interface or batch provisioning will generate an order ID for tracking purposes. 

The Prime Collaboration Provisioning client uses the NBI ID to query the work order. The getOrder API allows you 

to take either the order ID or the NBI ID for tracking purposes.