Cisco Cisco Prime Collaboration 10.5 Developer's Guide

The following are submit and query helper objects:

• CupmApiList—A generic container used to return lists of objects to the client.

• CupmApiFilter—A specific filter used for Prime Collaboration Provisioning NBI list commands. Specifies

the object selection criteria and the object attribute names to return with each object.

The following are external functional objects:

• CupmApiResponseValue—The data structure returned synchronously when the client submits an NBI

request that passes basic validation. Contains the NBI ID.

• CupmApiResultValue—The data structure returned asynchronously when the server completes execution

of the NBI request.

• CupmApiStatus—An object in CupmApiResultValue stating the termination status of the NBI request. Also

the data returned when querying an NBI request.

• CupmApiFaultType—An extension of the WS-BaseFault specification. It is populated with error

information from the Prime Collaboration Provisioning server if a requests fails during the asynchronous

portion of its execution.

Object Keys

Objects will be uniquely identified by their key attributes. A managed object has only one attribute as its key.

Overview of Request Names

Prime Collaboration Provisioning NBI requests will always be in the form “verb noun.”

The following list contains the verbs for basic object management:

• Create

• Get

• Update

• Delete

• List

• Cancel

Special verbs are used for specialized commands, such as syncDomain or resetSubscriberServicePassword. The

noun for basic object management is the class.

The noun may describe an attribute or concept for specialize commands.

Overview of Object Attributes

The Prime Collaboration Provisioning NBI objects specified in the XSD files will always translate to Java POJO

files. Thus there will be a Java signature corresponding to every NBI request, and a Java Prime Collaboration

Provisioning NBI object for every XSD-defined object.