updateHiddenWidgetTypes
put
/ccadmin/v1/widgetDescriptors/hidden
Update Hidden Widget Types. Set whether a Widget Type will be visible in the Site Studio component library
Request
Supported Media Types
- application/json
Root Schema : updateHiddenWidgetTypes_request
Type:
Show Source
object
-
widgetDescriptors(optional):
array widgetDescriptors
Array of widget type IDs and a show / hide flag for site studio.
Example:
{
"widgetDescriptors":[
{
"hiddenFromSiteStudio":true,
"widgetType":"productDetails"
},
{
"hiddenFromSiteStudio":false,
"widgetType":"heroWidget"
}
]
}
Nested Schema : widgetDescriptors
Type:
array
Array of widget type IDs and a show / hide flag for site studio.
Show Source
Nested Schema : items
Type:
Show Source
object
- hidden(optional): boolean
-
widgetType(optional):
string
The widget type ID
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Example Response (application/json)
{
"items":[
{
"isLatestVersion":true,
"displayName":"Hero",
"availableToAllPages":true,
"jsEditable":false,
"minWidth":1,
"version":1,
"layouts":[
],
"widgetType":"heroWidget",
"latestVersion":1,
"repositoryId":"heroWidget",
"hiddenFromSiteStudio":false,
"editableWidget":true,
"id":"heroWidget",
"defaultLayout":null,
"pageTypes":[
],
"configurable":false
},
{
"isLatestVersion":true,
"displayName":"Product Details",
"availableToAllPages":false,
"jsEditable":false,
"minWidth":1,
"version":1,
"layouts":[
{
"name":"productDetailsDefaultLayout",
"repositoryId":"productDetailsDefaultLayout",
"description":"Default Panel",
"sourceLocation":"productDetailsDefaultLayout/widget.template",
"id":"productDetailsDefaultLayout"
}
],
"widgetType":"productDetails",
"latestVersion":1,
"repositoryId":"productDetails",
"hiddenFromSiteStudio":true,
"editableWidget":true,
"id":"productDetails",
"defaultLayout":{
"name":"productDetailsDefaultLayout",
"repositoryId":"productDetailsDefaultLayout",
"description":"Default Panel",
"sourceLocation":"productDetailsDefaultLayout/widget.template",
"id":"productDetailsDefaultLayout"
},
"pageTypes":[
{
"repositoryId":"productPageType",
"alias":"/product",
"id":"productPageType",
"shortName":"product"
}
],
"configurable":false
}
]
}
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