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

GetAllItemsOptions

Synopsis

struct GetAllItemsOptions : ItemSelectionOptions {
    boolean *setArticleIds;
    boolean *geometryIds;
    boolean *positionNumbers;
    boolean *basketItems;
    TextFormat? textFormat;
    boolean? preservePlainText;
}

See also: ItemSelectionOptions, TextFormat

Can be used as argument of operation getAllItems (§getAllItems).

The optional attributes setArticleIds and geometryIds of type boolean control whether or not returned instances of complex type BasketItem contain set-article IDs (and set-article part IDs) and geometry IDs (if available).

The default value of these options is false.

positionNumbers

If the value of this field is true and field viewId contains the ID of a basket view then the basket items returned by operation getAllItems will return the position number of the returned view item.

The default value of this field is true.

basketItems

If the value of this field is true and field viewId contains the ID of a basket view then the basket items returned by operation getAllItems do not use field basketItemIds to return IDs of referenced basket items, but use field basketItems to return complete basket items.

Options setArticleIds and geometryIds may be used to control the content of these nested instances of BasketItem.

textFormat

Value None may be used as textFormat with operations getAllItems to suppress the return of item labels.

preservePlainText

The option preservePlainText is ignored if option textFormat is unset, set to Plain or None, or is ignored. Otherwise, if set to true, texts that are stored as plain text are returned unmodified instead of being converted to the requested format.