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
Path Parameters
Body ()
Root Schema : updateLayout_request
Type: object
Show Source
Example:
{
    "properties":{
        "seoMetadataLayoutPreviewTitle":null,
        "notes":"home update test",
        "seoMetaDescription":null,
        "seoMetaKeywords":null,
        "displayName":"Home",
        "pageTitle":null,
        "repositoryId":"homePageLayout",
        "layoutViewports":"xs,sm"
    }
}
Nested Schema : properties
Type: object
List of properties of the layout.
Show Source
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : updateLayout_response
Type: object
Show Source
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.|
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top