Cisco Cisco Prime Collaboration 11.0 Guide Du Développeur
© 2015 Cisco and/or its affiliates. All rights reserved. This document is Cisco Public.
Page 57 of 82
Throws:
GetApiStatusExcepton—If the server cannot execute the NBI request.
SyncReturn:
• CupmApiResponseValue—Contains
CupmApiResultValue, which contains CupmApiStatus and
CupmApiList. The list contains one object, the CupmApiStatus for the NBI request specified in the
request.
• CupmApiFaultType—Included if the NBI request fails.
AsyncReturn:
None—The command is synchronous.
Note: The command will fail if the server has purged the NBI request.
listApiStatus Java Signature
Returns the status of all outstanding NBI requests this client has submitted.
Syntax:
public ResponseReturn listApiStatus (CUPMServiceStub stub, CupmApiFilterValue filter, String
endPointReference, String idPrefix);
Parameters:
filter—Limited filtering of the NBI requests returned.
You can filter using the following attribute:
• status
• endPointReference—String to convert to an EndpointReference object that the asynchronous result
notification will be sent to.
• idPrefix—String that is added to the beginning of the internally generated numeric to form the unique NBI
identifier. A null or empty string is valid, resulting in an NBI identifier that is just the internally generated
numeric.
Returns:
CupmApiResponseValue—Object with NBI ID.
Throws:
ListApiStatusExcepton—If the server cannot execute the NBI request.