updateLayout
put
/ccadmin/v1/layouts/{id}
Update Layout. Update a layout by layout ID and request parameters. 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.
Root Schema : updateLayout_request
Type:
Show Source
object
-
properties:
object properties
List of properties of the layout.
Example:
{
"properties":{
"urlSlug":"",
"defaultPage":false,
"notes":"home update test",
"seoMetaDescription":null,
"seoMetaKeywords":null,
"displayName":"Home",
"pageTitle":null,
"sites":[
"100001"
],
"skuIds":[
"productId: 123"
],
"target":100,
"seoMetadataLayoutPreviewTitle":null,
"layoutCollections":[
"Gift Shop / For Him / Under $25 (ca90042)"
],
"pageAddress":"aboutUs3",
"pageDisplayName":"CTEST",
"repositoryId":"homePageLayout",
"metaTags":"",
"orderStates":[
"FAILED_APPROVAL"
],
"layoutViewports":"xs,sm",
"links":[
"http://localhost:9080/occ-admin/"
],
"collectionId":[
"ca90042"
],
"contentType":""
}
}
Nested Schema : properties
Type:
object
List of properties of the layout.
Show Source
-
collectionId(optional):
array collectionId
ID for collection. Displayed on collection layouts
-
contentType(optional):
string
Used to target different pages for specific content types. Displayed on content layouts
-
defaultPage(optional):
boolean
Boolean if this page is the default page.
-
displayName(optional):
string
Display name of the layout. Displayed on all.
-
layoutCollections(optional):
array layoutCollections
The layout of the chosen selection. Displayed on Collection layouts.
-
layoutViewports(optional):
string
Viewport associations for the layout. Displayed on all layouts.
-
links(optional):
array links
Links to pages
-
metaTags(optional):
string
Tags which are used by search engines to determine the relevance of the given page to the search request. Displayed on all layouts.
-
notes(optional):
string
Notes of the layout. Displayed on all.
-
orderStates(optional):
array orderStates
Layout will only be used for order statuses you select. Displayed on Checkout layout.
-
pageAddress(optional):
string
The URL address of the page.
-
pageDisplayName(optional):
string
Name displayed on store for this layout.
-
pageTitle(optional):
string
Name of the collection. Displayed on all (except: Product, Collection)
-
repositoryId(optional):
string
Repository ID of the layout.
-
seoMetadataLayoutPreviewTitle(optional):
string
Layout preview title which is used by search engines to determine the relevance of the given page to the search request.
-
seoMetaDescription(optional):
string
Layout description which is used by search engines to determine the relevance of the given page to the search request. Displayed on only Home and Article Layouts.
-
seoMetaKeywords(optional):
string
keywords which are used by search engines to determine the relevance of the given page to the search request. Displayed on only Home and Article Layouts.
-
sites(optional):
array sites
Sites associated with this layout. Displayed on all layouts.
-
skuIds(optional):
array skuIds
ProductID's for up to 5 products
-
target(optional):
boolean
Setup for b2b (account )
-
urlSlug(optional):
string
Specific URL address of site or content item. Displayed on Content layouts
Nested Schema : collectionId
Type:
array
ID for collection. Displayed on collection layouts
Show Source
Nested Schema : layoutCollections
Type:
array
The layout of the chosen selection. Displayed on Collection layouts.
Show Source
Nested Schema : orderStates
Type:
array
Layout will only be used for order statuses you select. Displayed on Checkout layout.
Show Source
Nested Schema : sites
Type:
array
Sites associated with this layout. Displayed on all layouts.
Show Source
Nested Schema : items
Type:
object
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : updateLayout_response
Type:
Show Source
object
-
displayName(optional):
string
Display name of the layout.
-
notes(optional):
string
Notes of the layout.
-
pageTitle(optional):
string
Name of the collection.
-
repositoryId(optional):
string
Repository ID of the layout.
-
seoMetaDescription(optional):
string
Layout description which is used by search engines to determine the relevance of the given page to the search request.
-
seoMetaKeywords(optional):
string
keywords which are used by search engines to determine the relevance of the given page to the search request.
Example Response (application/json)
{
"seoMetaDescription":"",
"notes":"home update test",
"seoMetaKeywords":"",
"pageTitle":"",
"displayName":"Home",
"repositoryId":"homePageLayout"
}
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|
|------------------|------------------|
|32003|Error updating a layout.|
|25100|Internal Error|
|32020|The specified page address {0} must be unique.|
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