Cisco Cisco Prime Collaboration 10.6 開発者ガイド

ページ / 82
 
 
© 2012 Cisco and/or its affiliates. All rights reserved. This document is Cisco Public. 
Page 54 of 82 
Syntax
public ResponseReturn getInventoryItem (CUPMServiceStub stub, InventoryItemValue item, String 
endPointReference, String idPrefix); 
Note : To execute this API in synchronous mode, you must set the responseType 
attribute to “sync”. 
Parameters
 
item
—An InventoryItem object that specifies the object type to retrieve, and the attribute keys and unique 
values for those keys. 
 
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. 
  responseType (optional)
— String to identify whether the API call should be synchronous or not. 
Returns: 
CupmApiResponseValue
—Object with NBI ID. 
Throws: 
GetInventoryItemException
—If server cannot execute NBI request. 
ASyncReturn: 
 
CupmApiResultValue
—Contains CupmApiStatus and CupmApiList. The CupmApiList contains the one 
InventoryItem object selected. 
 
CupmApiFaultType
—Included if the NBI request fails. 
listInventoryItem Java Signature 
Retrieves a list of inventory items from the Prime Collaboration Provisioning database, based on the filter selection. 
Note that the filter can also select based on associated objects (one level of association only). Supports pagination 
while fetching the inventory items. 
 
Syntax
public ResponseReturn listInventoryItem (CUPMServiceStub stub, CupmApiFilterValue filter, String 
endPointReference, String idPrefix); 
Note : To execute this API in synchronous mode, you must set the responseType attribute to “sync”. 
Parameters
 
filter
—Specifies which InventoryItem objects to return and which attributes to include.