Cisco Cisco Prime Collaboration 10.6 Guida Dello Sviluppatore

Page 45 of 82



responseType

—String to specify that the API call should be synchronous. This API works only in

synchronous mode.

Returns:

CupmApiResponseValue

—Object with NBI ID.

Throws:

cancelDNWithServiceException

—If the server cannot execute the NBI request.

SyncReturn:



CupmApiResultValue

—Contains CupmApiStatus only.



CupmApiFaultType

—Included if the NBI request fails.

Overview of NBI Object Metadata

In most Prime Collaboration Provisioning NBI top-level objects, the majority of the data is metadata. For the

DeviceValue, DomainValue, ServiceAreaValue, and SubscriberValue objects, only the key attributes and attributes

that must be unique are specified at the top level as unique tags.

All other data is specified as metadata pair objects. The metadata object name is context-sensitive. For example,

Device will have cmProperties metadata for Call Processors and umpProperties metadata for Unified Message

Processors.

The metadata object is complex, and if the data always has only a single value, the object contains two strings, the

propertyName and the propertyValue. Value property names are defined with an enumeration that is associated

with the metadata object.

If the metadata object has one or more properties that can be assigned to multiple values, the object contains a

string, an array of strings or objects, and an enumeration for action. The action ADD, which is the default, is used

to add an additional value to the set of already assigned values. The action REMOVE is used to delete the

specified value from the currently assigned array of values. An action assignment is only required in update

requests.

Work Order Management Commands and Queries

In the Prime Collaboration Provisioning NBI, there is no concept of a prospect work order. All work orders are

immediately submitted if NbiManager accepts the NBI request and if the optional validation checking is successful.

In the Prime Collaboration Provisioning NBI, there is no Work Order ID. The work orders submitted by NBI

requests are identified by their NBI ID.