Cisco Cisco Prime Collaboration 10.5 User Guide
© 2012-2014 Cisco and/or its affiliates. All rights reserved. This document is Cisco Public.
Page 15 of 2
If the NBI request returns data, additional objects are in this container. This object is used for returning all queries
handled under enumeration.
It is also used for returning prepopulation choice lists.
Complete Object Definition File: Common.xsd
CupmApiResponseValue
The ApiReponse object is the synchronously returned object for all Prime Collaboration Provisioning NBI requests
that are successfully submitted to the Prime Collaboration Provisioning server.
Table 3: CupmApiResponseValue Object Attributes
Attribute
Name
Name
Attribute Type
Description
ApiId
String
Unique ID within Prime Collaboration Provisioning server generated by the Prime Collaboration
Provisioning server when accepting a new NBI request. Prime Collaboration Provisioning server assigns
a long integer that is incremented with each new NBI request. The integer resets after 10 minutes. All
NBI requests have a parameter that adds an optional string to the beginning of the generated number.
Provisioning server when accepting a new NBI request. Prime Collaboration Provisioning server assigns
a long integer that is incremented with each new NBI request. The integer resets after 10 minutes. All
NBI requests have a parameter that adds an optional string to the beginning of the generated number.
startTime
time/date
UTC time when server accepted NBI request.
Result
CupmApiResultValue Not used in initial release.
The framework will support synchronous execution of the Prime Collaboration Provisioning NBI request.
This attribute will always be null.
This attribute will always be null.
Complete Object Definition File: Common.xsd
CupmApiResultValue
Table 4: CupmApiResultValue Object Attributes
Attribute
Name
Name
Attribute Type
Description
Status
CupmApiStatusValue Associated CupmApiStatus object describing the final status of the NBI request as executed by Prime
Collaboration Provisioning. Note that the NBI ID is in this object.
data
CupmApiListValue
Associated CupmApiList object containing any data the NBI request was to return.
error
CupmApiResultValue
If the NBI request fails after the response was sent, an NBI exception object will be present and
describe the problem. If the NBI request executed successfully, this will be null.
describe the problem. If the NBI request executed successfully, this will be null.
Complete Object Definition File: Common.xsd
CupmApiStatusValue
Table 5: CupmApiStatusValue Object Attributes
Attribute Name
Attribute Type
Description
apiId
String
NBI ID
Status
ENUM
Status of the NBI request
Message
String
Any informatory or warning message from a successfully executed NBI request.
startTime
time/date
UTC time when server accepted NBI request
completeTime
time/date
UTC time when server completed NBI request
OrderStatusValue OrderStatus
An attachment (any type) for the SubmitOrder NBI