getLayout
get
/ccadmin/v1/layouts/{id}
Get Layout. Get a layout based on layout ID. Layout will have dynamic properties which change from one layout to another.
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 : getLayout_response
Type:
Show Source
object
-
description(optional):
string
The page description.
-
isPreview(optional):
boolean
Whether the server is in preview mode.
-
keywords(optional):
string
The keywords for the page.
-
layout(optional):
string
The layout id.
-
regions(optional):
array regions
The region data for all the regions of a page.
-
route(optional):
string
The page route.
-
title(optional):
string
The page title.
Example Response (application/json)
{
"defaultPage":true,
"seoMetaDescription":"",
"pageAddress":"home",
"seoMetaKeywords":"",
"_links":{
"self":{
"href":"/ccadminui/v1/layouts/homePageLayout"
}
},
"pageTitle":"",
"displayName":"Home Layout",
"repositoryId":"homePageLayout",
"layoutViewports":""
}
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.|
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