Cisco Cisco Prime Collaboration Provisioning 11.5 Developer's Guide
© 2016 Cisco and/or its affiliates. All rights reserved. This document is Cisco Public.
Page 56 of 82
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:
ListProductAttributeChoiceException
—If the server cannot execute the NBI request.
ASyncReturn:
CupmApiResultValue, containing CupmApiStatus and CupmApiList. CupmApiList contains the choice lists
requested for the product attributes.
CupmApiFaultType
—Included if the NBI request fails.
Prime Collaboration Provisioning NBI Status Queries
getApiStatus Java Signature
Returns the status of a specific NBI request. If the execution of the command has been completed, an attached
CupmApiResultValue is also returned.
Syntax:
public ResponseReturn getApiStatus (CUPMServiceStub stub, String apiId, String endPointReference, String
idPrefix);
Parameters:
apiId
—The NBI ID of the command status to return.
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
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.