Jump to

• Request
• Response

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

• application/json

200 Response

General settings for displaying a configurator UI.

Body ()

Root Schema : UISettingsResponse

Type: object

Show Source

• configSettings: object configSettings
• generalSiteSettings: object generalSiteSettings
• links: array links

{
    "type":"object",
    "properties":{
        "generalSiteSettings":{
            "type":"object",
            "properties":{
                "stickyModelConfigs":{
                    "type":"string"
                },
                "buttonAlignment":{
                    "type":"string"
                },
                "showBmLogo":{
                    "type":"string"
                },
                "guestAccess":{
                    "type":"string"
                },
                "includeLanguagePreference":{
                    "type":"string"
                },
                "showOverloadBanner":{
                    "type":"string"
                },
                "includeShoppingCartBanner":{
                    "type":"string"
                },
                "buttonPosition":{
                    "type":"string"
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "rel":{
                        "type":"string"
                    },
                    "href":{
                        "type":"string"
                    }
                }
            }
        },
        "configSettings":{
            "type":"object",
            "properties":{
                "configDialogThreshhold":{
                    "type":"string"
                },
                "cfgHideZeroTotalPrice":{
                    "type":"string"
                },
                "configIntegrationExpiration":{
                    "type":"string"
                },
                "cfgPriceAllPgs":{
                    "type":"string"
                },
                "displayEditableFieldIconsInArrays":{
                    "type":"string"
                },
                "cfgSparesSelected":{
                    "type":"string"
                },
                "configHeaderSize":{
                    "type":"string"
                },
                "ajaxLoadingDialogDelay":{
                    "type":"string"
                },
                "configTimeout":{
                    "type":"string"
                },
                "hideMissing":{
                    "type":"string"
                },
                "otherTablesHeight":{
                    "type":"string"
                },
                "horizontalArraysHeight":{
                    "type":"string"
                },
                "configTimeoutAction":{
                    "type":"string"
                },
                "cfgSparesDisplayTotal":{
                    "type":"string"
                },
                "cfgSparesEndPage":{
                    "type":"string"
                },
                "enableConfigAutoSave":{
                    "type":"string"
                },
                "verticalArraysHeight":{
                    "type":"string"
                },
                "sumConfigSpareQuantities":{
                    "type":"string"
                },
                "ssplResultSetLimit":{
                    "type":"string"
                },
                "cfgRetainSparesSelected":{
                    "type":"string"
                }
            }
        }
    },
    "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"
        }
    }
}

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

• 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

{
    "type":"object",
    "properties":{
        "configDialogThreshhold":{
            "type":"string"
        },
        "cfgHideZeroTotalPrice":{
            "type":"string"
        },
        "configIntegrationExpiration":{
            "type":"string"
        },
        "cfgPriceAllPgs":{
            "type":"string"
        },
        "displayEditableFieldIconsInArrays":{
            "type":"string"
        },
        "cfgSparesSelected":{
            "type":"string"
        },
        "configHeaderSize":{
            "type":"string"
        },
        "ajaxLoadingDialogDelay":{
            "type":"string"
        },
        "configTimeout":{
            "type":"string"
        },
        "hideMissing":{
            "type":"string"
        },
        "otherTablesHeight":{
            "type":"string"
        },
        "horizontalArraysHeight":{
            "type":"string"
        },
        "configTimeoutAction":{
            "type":"string"
        },
        "cfgSparesDisplayTotal":{
            "type":"string"
        },
        "cfgSparesEndPage":{
            "type":"string"
        },
        "enableConfigAutoSave":{
            "type":"string"
        },
        "verticalArraysHeight":{
            "type":"string"
        },
        "sumConfigSpareQuantities":{
            "type":"string"
        },
        "ssplResultSetLimit":{
            "type":"string"
        },
        "cfgRetainSparesSelected":{
            "type":"string"
        }
    }
}

Nested Schema : generalSiteSettings

Type: object

Show Source

• buttonAlignment: string
• buttonPosition: string
• guestAccess: string
• includeLanguagePreference: string
• includeShoppingCartBanner: string
• showBmLogo: string
• showOverloadBanner: string
• stickyModelConfigs: string

{
    "type":"object",
    "properties":{
        "stickyModelConfigs":{
            "type":"string"
        },
        "buttonAlignment":{
            "type":"string"
        },
        "showBmLogo":{
            "type":"string"
        },
        "guestAccess":{
            "type":"string"
        },
        "includeLanguagePreference":{
            "type":"string"
        },
        "showOverloadBanner":{
            "type":"string"
        },
        "includeShoppingCartBanner":{
            "type":"string"
        },
        "buttonPosition":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "rel":{
                "type":"string"
            },
            "href":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• href: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

400 Response

Bad request input data

Body ()

Root Schema : Error

Type: object

Show Source

• message: string
  The error message
• status: string
  The Error code

{
    "type":"object",
    "properties":{
        "message":{
            "description":"The error message",
            "type":"string"
        },
        "status":{
            "description":"The Error code",
            "type":"string"
        }
    }
}

Back to Top