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 TopResponse
Supported Media Types
- application/json
200 Response
General settings for displaying a configurator UI.
Root Schema : UISettingsResponse
Type:
Show Source
object
-
configSettings:
object configSettings
-
generalSiteSettings:
object generalSiteSettings
-
links:
array links
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:
Show Source
object
-
ajaxLoadingDialogDelay:
string
-
cfgHideZeroTotalPrice:
string
-
cfgPriceAllPgs:
string
-
cfgRetainSparesSelected:
string
-
cfgSparesDisplayTotal:
string
-
cfgSparesEndPage:
string
-
cfgSparesSelected:
string
-
configDialogThreshhold:
string
-
configHeaderSize:
string
-
configIntegrationExpiration:
string
-
configTimeout:
string
-
configTimeoutAction:
string
-
displayEditableFieldIconsInArrays:
string
-
enableConfigAutoSave:
string
-
hideMissing:
string
-
horizontalArraysHeight:
string
-
otherTablesHeight:
string
-
ssplResultSetLimit:
string
-
sumConfigSpareQuantities:
string
-
verticalArraysHeight:
string
400 Response
Bad request input data
Root Schema : Error
Type:
Show Source
object
-
message:
string
The error message
-
status:
string
The Error code