getSchemaForWidgetDescriptor
get
/ccadmin/v1/widgetDescriptors/{id}/schema
Get Schema For Widget Descriptor. Retuirns the Widget Descriptor Schema.
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 : getSchemaForWidgetDescriptor_response
Type:
Show Source
object
-
editableWidget(optional):
boolean
Whether the widget is editable
-
minWidth(optional):
integer
Whether the minimum width
-
repositoryId(optional):
string
The Repository ID
Example Response (application/json)
{
"repositoryId":"headerWidget",
"minWidth":1,
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccadminui/v1/widgetDescriptors/headerWidget/schema?lastModifiedTime=1440513589000&shippingGroupCount=1&paymentGroupCount=1&locale=es&state=SUBMITTED&links=%5Bobject%20Object%5D&shippingGroups=%5Bobject%20Object%5D&commerceItems=%5Bobject%20Object%5D&id=o30427&siteId=siteUS&priceInfo=%5Bobject%20Object%5D&paymentGroups=%5Bobject%20Object%5D&taxPriceInfo=%5Bobject%20Object%5D&profileId=110018&creationTime=1440513587000&salesChannel=default&relationships=%5Bobject%20Object%5D&totalCommerceItemCount=1&___etag___=eyJoYXNoIjoiZTBWYXZhT2xaR0xlN0U2NEFrRVZOb2d1emZUaFVCdlZwZ1dISFJLUXViaz0iLCJ1cmkiOiIvY2NhZG1pbnVpL3YxL29yZGVycy9vMzA0MjciLCJ2ZXJzaW9uIjowfQ%3D%3D"
}
],
"editableWidget":true
}
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