getLayout
get
/ccagent/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
- application/json
Path Parameters
Query Parameters
-
layoutsRendered(optional): string
Contains the list of layout ids rendered on the client. If any id in it matches the requested page's layout id, then only region ids are returned.
-
pageParam(optional): string
Page param (for example pageParam=cat90016).
-
usePageId(optional): string
Use specific repository id for page, rather than the default.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getLayout_response
Type:
Show Source
object
-
defaultPage(optional):
boolean
Display true if default page is set.
-
displayName(optional):
string
Display name of the layout.
-
layoutViewports(optional):
string
Viewport associations.
-
pageAddress(optional):
string
Display the address of the page.
-
PageTitle(optional):
string
Display title of the page.
-
repositoryId(optional):
string
The repository ID of the layout.
-
seoMetaDescription(optional):
string
Display meta Description.
-
seoMetaKeywords(optional):
string
Display meta keywords.
Example Response (application/json)
{
"layout":"agentCustomerSearchLayout",
"regions":[
{
"width":12,
"id":"12colAgentCustomerSearchRegion",
"widgets":[
{
"id":"agentNavigationInst_v1"
},
{
"id":"agentNotificationsInst"
}
]
},
{
"width":12,
"id":"SecondaryNavigationRegionForCustomerSearch",
"widgets":[
{
"id":"secondaryNavigationCustomerSearchAndSelfRegistrationWidgetInst"
}
]
},
{
"width":12,
"id":"agentCustomerRegistrationRegion",
"widgets":[
{
"id":"agentCustomerRegistrationInst_v1"
}
]
},
{
"width":12,
"id":"popupStackCustomerSearch",
"widgets":[
]
},
{
"id":"globalWidgetsRegion0"
},
{
"id":"globalWidgetsRegion1"
}
],
"route":"/agentCustomerSearch",
"noindex":false,
"isPreview":true,
"metaTags":[
],
"links":[
{
"rel":"self",
"href":"/ccagentui/v1/pages/layout/agentCustomerSearch?layoutsRendered=agentCustomerSearchLayout"
}
],
"title":"Commerce Cloud Site",
"layoutName":"Customer Search Layout - Agent"
}
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