Cisco Cisco Prime Collaboration 10.6 Guía Del Desarrollador
© 2012 Cisco and/or its affiliates. All rights reserved. This document is Cisco Public.
Page 15 of 82
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
command.
6 lists the state codes for the CupmApiStatusValue Attribute.
Table 6: Status Code ENUMs for CupmApiStatusValue Attribute
State
Description
SUBMITTED
The Prime Collaboration Provisioning NBI request has been received by the
Prime Collaboration Provisioning server. The synchronous message exchange
is not yet completed.
Prime Collaboration Provisioning server. The synchronous message exchange
is not yet completed.
REJECTED
The Prime Collaboration Provisioning NBI request was rejected by the
NbiManager and an exception was thrown back to the client.
NbiManager and an exception was thrown back to the client.
PENDING
The Prime Collaboration Provisioning NBI request has been accepted by the
ApiManager and assigned an API ID. Execution is in progress.
ApiManager and assigned an API ID. Execution is in progress.
COMPLETED_SUCCESSFULLY The Prime Collaboration Provisioning NBI has completed successfully
COMPLETED_FAILURE
The Prime Collaboration Provisioning NBI failed. The failure could be partial or
total.
total.
For orders, an additional status object that provides information about each product detail step in the order is
attached.
Complete Object Definition File: Common.xsd
CupmApiFilterValue
The CupmApiFilter has three sections:
Object Selection Criteria for primary object
—Defines which object instances to return.
o A generic metadata structure specifying attribute names and values for selection of the data.
o
And/Or flag indicating if the above criterion is to be applied with a logical ‘and’ or a logical ‘or’.
Object Selection Criteria for associated object
—If the object type in the list selection has one or more
associated objects, you can select one of these objects and apply selection criteria to this object in
addition to the list object type.
o A string containing the associated object type.
o A generic metadata structure specifying attribute names and regular expressions for selection of
the data. The and/or flag in the first selection criteria applies here as well.
Object Attributes Returned Criteria
—Specifies which attributes of the selected objects should be returned.