updateHiddenComponentTypes
put
/ccadmin/v1/components/hidden
Update Hidden Component Types. Endpoint for updating the hidden-from-studio-site flag on component descriptors which match the type in the input list.
Request
Supported Media Types
- application/json
Root Schema : updateHiddenComponentTypes_request
Type:
Show Source
object
-
widgetDescriptors(optional):
array widgetDescriptors
Contains the components to be hidden or unhidden.
Example:
{
"widgetDescriptors":[
{
"hiddenFromSiteStudio":true,
"widgetType":"600003"
}
]
}
Nested Schema : widgetDescriptors
Type:
array
Contains the components to be hidden or unhidden.
Show Source
Nested Schema : items
Type:
Show Source
object
- hiddenFromSiteStudio(optional): boolean
-
widgetType(optional):
string
The ID of the component to be hidden/unhidden.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : updateHiddenComponentTypes_response
Type:
Show Source
object
-
repositoryId(optional):
string
The component ID of the widget.
Example Response (application/json)
{
"repositoryId":"600003",
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccadmin/v1/components/hidden"
}
]
}
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