Performs retrieval of general settings that can be used to control the configurator display

get

/ccstore/v1/cpq/configurations/uiSettings

This endpoint retrieves settings that can be used to control the UI that is rendered for the configurator.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

200 Response

General settings for displaying a configurator UI.
Body ()
Root Schema : UISettingsResponse
Type: object
Show Source
Example:
{
    "generalSiteSettings":{
        "stickyModelConfigs":"Yes",
        "buttonAlignment":"right",
        "showBmLogo":"No",
        "guestAccess":"Yes",
        "includeLanguagePreference":"No",
        "showOverloadBanner":"Yes",
        "buttonPosition":"both"
    },
    "configSettings":{
        "configDialogThreshhold":"5",
        "cfgHideZeroTotalPrice":"No",
        "configIntegrationExpiration":"30",
        "cfgPriceAllPgs":"Yes",
        "cfgSparesSelected":"Yes",
        "configHeaderSize":"8",
        "ajaxLoadingDialogDelay":"1000",
        "configTimeout":"2",
        "hideMissing":"No",
        "otherTablesHeight":"20",
        "configTimeoutAction":"Log Only",
        "cfgSparesDisplayTotal":"Yes",
        "cfgSparesEndPage":"Yes",
        "enableConfigAutoSave":"Yes",
        "paginationForVerticalArrays":"No",
        "verticalArraysHeight":"20",
        "sumConfigSpareQuantities":"No",
        "ssplResultSetLimit":"1000",
        "cfgRetainSparesSelected":"No"
    }
}
Nested Schema : configSettings
Type: object
Show Source
Nested Schema : generalSiteSettings
Type: object
Show Source

400 Response

Bad request input data
Body ()
Root Schema : Error
Type: object
Show Source
Back to Top