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
- application/json
Path Parameters
-
id: string
ID of the layout.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getLayoutStructure_response
Type:
Show Source
object-
displayName(optional):
string
Display name of the layout.
-
name(optional):
string
internal name of the layout
-
regions(optional):
array regions
Regions
-
repositoryId(optional):
string
The repository ID of the layout.
-
widgetPages(optional):
object widgetPages
Widget Pages
Nested Schema : widgetPages
Type:
objectWidget Pages
Show Source
- footerInst(optional): array footerInst
-
headerWidgetInst(optional):
array headerWidgetInst
Header Widget Instance
-
heroWidgetInst(optional):
array heroWidgetInst
Hero Widget Instance
-
megaMenuInst(optional):
array megaMenuInst
Mega Menu Instance
Nested Schema : items
Type:
Show Source
object-
cssClass(optional):
string
the custom CSS class for the region
-
height(optional):
number
The height of the region (not currently used)
-
name(optional):
string
the internal name of the region
-
repositoryId(optional):
string
the repository id of the region
-
widgets(optional):
array widgets
Widgets
-
width(optional):
number
the width in columns (1 - 12) of the region
Nested Schema : items
Type:
Show Source
object-
descriptor(optional):
object descriptor
Descriptor
-
displayName(optional):
string
The display name of the widget instance
-
repositoryId(optional):
string
the repository id of the widget instance
Nested Schema : descriptor
Type:
objectDescriptor
Show Source
-
editableWidget(optional):
boolean
Whether or not this widget type can be edited
-
minWidth(optional):
number
The minimum width of the widget type
-
repositoryId(optional):
string
The repository id of the widget type
Nested Schema : items
Type:
Show Source
object-
repositoryId(optional):
string
Repository id of page.
Nested Schema : items
Type:
Show Source
object-
repositoryId(optional):
string
Repository id of page.
Nested Schema : items
Type:
Show Source
object-
repositoryId(optional):
string
Repository id of page.
Example Response (application/json)
{
"layout":{
"regions":[
{
"cssClass":null,
"name":"header",
"width":12,
"repositoryId":"headerRegionHomePage",
"widgets":[
{
"displayName":"Header Widget",
"repositoryId":"headerWidgetInst",
"descriptor":{
"repositoryId":"headerWidget",
"minWidth":1,
"editableWidget":true
}
}
],
"height":300
},
{
"cssClass":null,
"name":"megaMenu",
"width":12,
"repositoryId":"megaMenuRegionHomePage",
"widgets":[
{
"displayName":"Collection Navigation Widget",
"repositoryId":"megaMenuInst",
"descriptor":{
"repositoryId":"megaMenu",
"minWidth":1,
"editableWidget":true
}
}
],
"height":300
},
{
"cssClass":null,
"name":"hero",
"width":12,
"repositoryId":"heroRegion12col",
"widgets":[
{
"displayName":"Hero",
"repositoryId":"heroWidgetInst",
"descriptor":{
"repositoryId":"heroWidget",
"minWidth":1,
"editableWidget":true
}
}
],
"height":300
},
{
"cssClass":null,
"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|
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:
arrayAn 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