Jump to

• Request
• Response

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

Body ()

Root Schema : updateHiddenWidgetTypes_request

Type: object

Show Source

• widgetDescriptors(optional): array widgetDescriptors
  Array of widget type IDs and a show / hide flag for site studio.

{
    "properties":{
        "widgetDescriptors":{
            "description":"Array of widget type IDs and a show / hide flag for site studio.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "hidden":{
                        "description":"Flag true - this widget should be hidden in site studio, false it should be shown in site studio",
                        "type":"boolean"
                    },
                    "widgetType":{
                        "description":"The widget type ID",
                        "type":"string"
                    }
                }
            }
        }
    },
    "example":{
        "widgetDescriptors":[
            {
                "hiddenFromSiteStudio":true,
                "widgetType":"productDetails"
            },
            {
                "hiddenFromSiteStudio":false,
                "widgetType":"heroWidget"
            }
        ]
    }
}

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

• Array of: object items

{
    "description":"Array of widget type IDs and a show / hide flag for site studio.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "hidden":{
                "description":"Flag true - this widget should be hidden in site studio, false it should be shown in site studio",
                "type":"boolean"
            },
            "widgetType":{
                "description":"The widget type ID",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• hidden(optional): boolean
  Flag true - this widget should be hidden in site studio, false it should be shown in site studio
• widgetType(optional): string
  The widget type ID

{
    "type":"object",
    "properties":{
        "hidden":{
            "description":"Flag true - this widget should be hidden in site studio, false it should be shown in site studio",
            "type":"boolean"
        },
        "widgetType":{
            "description":"The widget type ID",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : updateHiddenWidgetTypes_response

Show Source

{
    "properties":{
    }
}

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

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top