saveLayoutStructure
put
/ccadmin/v1/layouts/{id}/structure
Save Layout Structure. Persists the layout structure to the repository
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
ID of the layout.
Header Parameters
-
X-CC-Workset(optional): string
The ID of the workset that this change will appear in. If this header is missing, the change will be made in the default workset.
Root Schema : saveLayoutStructure_request
Type:
Show Source
object-
layout(optional):
object layout
Layout
Example:
{
"layout":{
"regions":[
{
"cssClass":"custom-header",
"width":12,
"repositoryId":"basicHeaderRegionCheckoutPage",
"widgets":[
{
"repositoryId":"basicHeaderWidgetInst"
}
]
},
{
"cssClass":"custom-body",
"width":6,
"repositoryId":"9colCheckoutBody",
"widgets":[
{
"repositoryId":"checkoutRegistrationInst"
},
{
"repositoryId":"checkoutCustomerDetailsInst"
},
{
"repositoryId":"checkoutPaymentDetailsInst"
}
]
},
{
"cssClass":"custom-body",
"width":6,
"repositoryId":"3colCheckoutSide",
"widgets":[
{
"repositoryId":"checkoutCartSummaryInst"
},
{
"repositoryId":"checkoutOrderSummaryInst"
}
]
},
{
"cssClass":"custom-body",
"width":12,
"repositoryId":"1colCyberSourcePaymentAuthorization",
"widgets":[
{
"repositoryId":"cyberSourcePaymentAuthorizationInst"
}
]
},
{
"cssClass":"custom-footer",
"width":12,
"repositoryId":"footerRegionCheckoutPage",
"widgets":[
{
"repositoryId":"footerInst"
}
]
}
]
}
}Nested Schema : items
Type:
Show Source
object-
cssClass(optional):
string
the custom CSS class for the region
-
repositoryId(optional):
string
the repository id of the region. A region will be created if this is omitted
-
widgets(optional):
array widgets
Widgets
-
width:
number
the width in columns (1 - 12) of the region
Nested Schema : items
Type:
Show Source
object-
repositoryId(optional):
string
the repository id of the widget instance
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : saveLayoutStructure_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.
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
Example Response (application/json)
{
"regions":[
{
"cssClass":"custom-header",
"name":"basicHeader",
"width":12,
"repositoryId":"basicHeaderRegionCheckoutPage",
"widgets":[
{
"displayName":"Basic Header",
"repositoryId":"basicHeaderWidgetInst",
"descriptor":{
"repositoryId":"basicHeaderWidget",
"minWidth":3,
"editableWidget":true
}
}
],
"height":300
},
{
"cssClass":"custom-body",
"name":"checkoutBody",
"width":9,
"repositoryId":"9colCheckoutBody",
"widgets":[
{
"displayName":"Checkout Registration",
"repositoryId":"checkoutRegistrationInst",
"descriptor":{
"repositoryId":"checkoutRegistration",
"minWidth":3,
"editableWidget":true
}
},
{
"displayName":"Checkout Customer Details",
"repositoryId":"checkoutCustomerDetailsInst",
"descriptor":{
"repositoryId":"checkoutCustomerDetails",
"minWidth":3,
"editableWidget":true
}
},
{
"displayName":"Checkout Payment Details",
"repositoryId":"checkoutPaymentDetailsInst",
"descriptor":{
"repositoryId":"checkoutPaymentDetails",
"minWidth":3,
"editableWidget":true
}
}
],
"height":300
},
{
"cssClass":"custom-body",
"name":"checkoutSidebar",
"width":3,
"repositoryId":"3colCheckoutSide",
"widgets":[
{
"displayName":"Checkout Cart Summary",
"repositoryId":"checkoutCartSummaryInst",
"descriptor":{
"repositoryId":"checkoutCartSummary",
"minWidth":3,
"editableWidget":true
}
},
{
"displayName":"Checkout Order Summary",
"repositoryId":"checkoutOrderSummaryInst",
"descriptor":{
"repositoryId":"checkoutOrderSummary",
"minWidth":3,
"editableWidget":true
}
}
],
"height":300
},
{
"cssClass":"custom-body",
"name":"cyberSourcePaymentAuthorization",
"width":12,
"repositoryId":"1colCyberSourcePaymentAuthorization",
"widgets":[
{
"displayName":"CyberSource Payment Authorization",
"repositoryId":"cyberSourcePaymentAuthorizationInst",
"descriptor":{
"repositoryId":"cyberSourcePaymentAuthorization",
"minWidth":3,
"editableWidget":false
}
}
],
"height":0
},
{
"cssClass":"custom-footer",
"name":"footer",
"width":12,
"repositoryId":"footerRegionCheckoutPage",
"widgets":[
{
"displayName":"Footer",
"repositoryId":"footerInst",
"descriptor":{
"repositoryId":"footer",
"minWidth":3,
"editableWidget":true
}
}
],
"height":300
}
],
"displayName":"Checkout",
"name":"CheckoutPageLayout",
"repositoryId":"checkoutPageLayout"
}400 Response
Following model is returned when layout id does not exist.
Root Schema : saveLayoutStructure_failureResponse
Type:
Show Source
object-
errorCode(optional):
string
Default Value:
32010Error code for message -
message(optional):
string
Default Value:
The specified layout {layoutId} does not existMessage explaining the error -
status(optional):
string
Default Value:
400HTTP status code for the error
Example Response (application/json)
{
"errorCode":"32010",
"message":"The specified layout {id} does not exist",
"status":"400"
}412 Response
ETag mismatch. Asset has been updated by another user.
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|
|------------------|------------------|
|32006|Error updating layout structure|
|32014|No widgets were specified for region (Occurs when 'widgets' is omitted from a region in the request)|
|32015|A layout must contain at least 1 region|
|32001|Error retrieving the layout by its ID.|
|32012|The specified widget does not exist|
|32013|No regions were specified for layout (Occurs when 'regions' is omitted from request)|
|32010|The specified layout does not exist|
|32011|The specified region does not exist|
|32009|Region width specified is smaller than minimum width for widget. (regionId)|
|32007|Region contains widgets. Unable to delete. (regionId)|
|32008|Region width must be between 1 and 12. (regionId)|
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