Skip to content
pCon.configurator onlineDocumentation
Esc
↑↓navigate↵open⌘Jpreview
On this page

getItemAppData

Synopsis

string*[] getItemAppData(SessionId sessionId,
    BItemId itemId,
    string appKey,
    string[]  paths)
throws BasketServiceFault;

See also: SessionId, BItemId, BasketServiceFault

The getItemAppData operation is used to fetch application-specific (or client-specific) data attached to a basket item which has either been read by the loadSession (§loadSession) operation as part of the project file, or previously attached to the basket item by the setItemAppData (§setItemAppData) operation. For more information, see §Application-Specific Data.

The itemId parameter must identify a basket item that is part of the basket item tree maintained by the basket service for the session identified by the sessionId parameter.

A BasketServicFault is returned if one of the following conditions occurs:

  • The sessionId parameter is not a valid string representation of an UUID or does not represent an open session.

  • The itemId parameter does not represent an UUID.

  • The itemId parameter does not identify a basket item.

  • One of the elements of data contains an invalid location path.