getLayout

get

/ccstore/v1/pages/layout/{path: .*}

Get Layout. Returns the layout(regions) of a specific page. If the layout ids are added to layoutsRendered parameter and included in the request and if it matches the current page's layout id, then only the region ids for the requested layout are returned, because regions are stored in the simple-cache.js on the client.

Request

Supported Media Types
Path Parameters
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : getLayout_response
Type: object
Show Source
Example Response (application/json)
{
    "layout":"homePageLayout",
    "regions":[
        {
            "id":"headerRegionHomePage"
        },
        {
            "id":"megaMenuRegionHomePage"
        },
        {
            "id":"footerRegionHomePage"
        },
        {
            "id":"globalWidgetsRegion0"
        }
    ],
    "route":"/home",
    "isPreview":true,
    "keywords":"",
    "viewports":"",
    "metaTags":[
    ],
    "description":"",
    "title":"Commerce Cloud Site"
}

Default Response

The error response
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