getConfigDefinitionForWidgetDescriptor
get
/ccadmin/v1/widgetDescriptors/{id}/config
Get Config Definition For Widget Descriptor. Get the Config Definition for the Widget Descriptor
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
the widget type id
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getConfigDefinitionForWidgetDescriptor_response
Type:
Show Source
object
-
items(optional):
object items
response
Nested Schema : items
Type:
Show Source
object
-
defaultValue(optional):
string
The default value.
-
displayAsCheckboxes(optional):
boolean
When value is a list, display this list as checkboxes
-
displayOnInstances(optional):
string
Display on instances.
-
helpText(optional):
string
The help text to be displayed Design Studio.
-
label(optional):
string
The label to be displayed in Design Studio.
-
maxLength(optional):
integer
Maximum length of the string value.
-
minLength(optional):
integer
Maximum length of the string value.
-
name(optional):
string
Name of the value.
-
options(optional):
array options
Array of options to choose.
-
regexText(optional):
string
Regular expression text for validation.
-
repositoryId(optional):
string
The Repository Id
-
required(optional):
boolean
Validation is this value field required.
-
type(optional):
string
The type of this value it can be text.
Nested Schema : items
Type:
Show Source
object
-
displayText(optional):
string
The option display text
-
value(optional):
string
The option value
Example Response (application/json)
{
"values":[
{
"helpText":"Enter the number of items you want to display in the mini cart before scrolling is required.",
"defaultValue":"3",
"minLength":0,
"label":"Number of items in mini cart before scrolling",
"type":"text",
"required":true,
"displayOnInstances":null,
"name":"miniCartNumberOfItems",
"repositoryId":"100004",
"options":[
],
"regexText":null,
"displayAsCheckboxes":false,
"maxLength":1000
},
{
"helpText":"Set whether mini-cart should be displayed for 'add to cart' notification.",
"defaultValue":"true",
"minLength":0,
"label":"Display Mini-Cart",
"type":"checkbox",
"required":false,
"displayOnInstances":null,
"name":"displayMiniCart",
"repositoryId":"100005",
"options":[
],
"regexText":null,
"displayAsCheckboxes":false,
"maxLength":1000
},
{
"helpText":"Set the duration for the display of the mini-cart (in secs).",
"defaultValue":"5",
"minLength":0,
"label":"Duration (in secs)",
"type":"text",
"required":true,
"displayOnInstances":null,
"name":"miniCartDuration",
"repositoryId":"100006",
"options":[
],
"regexText":null,
"displayAsCheckboxes":false,
"maxLength":1000
}
],
"repositoryId":"headerWidget",
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccadminui/v1/widgetDescriptors/headerWidget/config"
}
],
"___etag___":"eyJoYXNoIjoiaG5KcDB0QU83eGphc0dKYVVlRXR5UUZGSG1acldFRWU2cGVGV1lXd25aRT0iLCJ1cmkiOiIvY2NhZG1pbnVpL3YxL3dpZGdldERlc2NyaXB0b3JzL2hlYWRlcldpZGdldC9jb25maWciLCJ2ZXJzaW9uIjowfQ=="
}
Default Response
The error response
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code