getLayoutStructure

get

/ccadmin/v1/layouts/{id}/structure

Get Layout Structure. Returns the structure of a layout including regions and widgets based on the id

Request

Supported Media Types
Path Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : getLayoutStructure_response
Type: object
Show Source
Nested Schema : regions
Type: array
Regions
Show Source
Nested Schema : widgetPages
Type: object
Widget Pages
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : widgets
Type: array
Widgets
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : descriptor
Type: object
Descriptor
Show Source
Nested Schema : footerInst
Type: array
Footer Widget Instance
Show Source
Nested Schema : headerWidgetInst
Type: array
Header Widget Instance
Show Source
Nested Schema : heroWidgetInst
Type: array
Hero Widget Instance
Show Source
Nested Schema : megaMenuInst
Type: array
Mega Menu Instance
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
{
    "layout":{
        "regions":[
            {
                "name":"header",
                "width":12,
                "repositoryId":"headerRegionHomePage",
                "widgets":[
                    {
                        "displayName":"Header Widget",
                        "repositoryId":"headerWidgetInst",
                        "descriptor":{
                            "repositoryId":"headerWidget",
                            "minWidth":1,
                            "editableWidget":true
                        }
                    }
                ],
                "height":300
            },
            {
                "name":"megaMenu",
                "width":12,
                "repositoryId":"megaMenuRegionHomePage",
                "widgets":[
                    {
                        "displayName":"Collection Navigation Widget",
                        "repositoryId":"megaMenuInst",
                        "descriptor":{
                            "repositoryId":"megaMenu",
                            "minWidth":1,
                            "editableWidget":true
                        }
                    }
                ],
                "height":300
            },
            {
                "name":"hero",
                "width":12,
                "repositoryId":"heroRegion12col",
                "widgets":[
                    {
                        "displayName":"Hero",
                        "repositoryId":"heroWidgetInst",
                        "descriptor":{
                            "repositoryId":"heroWidget",
                            "minWidth":1,
                            "editableWidget":true
                        }
                    }
                ],
                "height":300
            },
            {
                "name":"footer",
                "width":12,
                "repositoryId":"footerRegionHomePage",
                "widgets":[
                    {
                        "displayName":"Footer Widget",
                        "repositoryId":"footerInst",
                        "descriptor":{
                            "repositoryId":"footer",
                            "minWidth":1,
                            "editableWidget":true
                        }
                    }
                ],
                "height":300
            }
        ],
        "displayName":"Home Layout",
        "name":"homePageLayout",
        "repositoryId":"homePageLayout"
    },
    "_links":{
        "self":{
            "href":"/ccadminui/v1/layouts/homePageLayout/structure"
        }
    },
    "widgetPages":{
        "headerWidgetInst":[
            {
                "repositoryId":"404page"
            },
            {
                "repositoryId":"aboutUsPage"
            },
            {
                "repositoryId":"categoryPage"
            },
            {
                "repositoryId":"contactUsPage"
            },
            {
                "repositoryId":"homePage"
            },
            {
                "repositoryId":"noSearchResultsPage"
            },
            {
                "repositoryId":"orderHistoryPage"
            },
            {
                "repositoryId":"privacyPage"
            },
            {
                "repositoryId":"productPage"
            },
            {
                "repositoryId":"profilePage"
            },
            {
                "repositoryId":"returnsPage"
            },
            {
                "repositoryId":"searchResultsPage"
            },
            {
                "repositoryId":"shippingPage"
            },
            {
                "repositoryId":"shoppingCartSummaryPage"
            },
            {
                "repositoryId":"signupPage"
            }
        ],
        "megaMenuInst":[
            {
                "repositoryId":"aboutUsPage"
            },
            {
                "repositoryId":"categoryPage"
            },
            {
                "repositoryId":"contactUsPage"
            },
            {
                "repositoryId":"homePage"
            },
            {
                "repositoryId":"noSearchResultsPage"
            },
            {
                "repositoryId":"orderHistoryPage"
            },
            {
                "repositoryId":"privacyPage"
            },
            {
                "repositoryId":"productPage"
            },
            {
                "repositoryId":"profilePage"
            },
            {
                "repositoryId":"returnsPage"
            },
            {
                "repositoryId":"searchResultsPage"
            },
            {
                "repositoryId":"shippingPage"
            },
            {
                "repositoryId":"shoppingCartSummaryPage"
            },
            {
                "repositoryId":"signupPage"
            }
        ],
        "footerInst":[
            {
                "repositoryId":"checkoutConfirmationPage"
            },
            {
                "repositoryId":"privacyPage"
            },
            {
                "repositoryId":"aboutUsPage"
            },
            {
                "repositoryId":"shoppingCartSummaryPage"
            },
            {
                "repositoryId":"checkoutPage"
            },
            {
                "repositoryId":"orderHistoryPage"
            },
            {
                "repositoryId":"returnsPage"
            },
            {
                "repositoryId":"profilePage"
            },
            {
                "repositoryId":"contactUsPage"
            },
            {
                "repositoryId":"categoryPage"
            },
            {
                "repositoryId":"searchResultsPage"
            },
            {
                "repositoryId":"404page"
            },
            {
                "repositoryId":"signupPage"
            },
            {
                "repositoryId":"productPage"
            },
            {
                "repositoryId":"noSearchResultsPage"
            },
            {
                "repositoryId":"homePage"
            },
            {
                "repositoryId":"shippingPage"
            }
        ],
        "heroWidgetInst":[
            {
                "repositoryId":"homePage"
            }
        ]
    }
}

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |32001|Error retrieving the layout by its ID.| |32010|The specified layout does not exist|
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top