Jump to

• Request
• Response

cloneLayout

post

/ccadmin/v1/layouts/{id}

Clone Layout. Clones a layout from the specified id

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string
  ID of the layout.

Header Parameters

• X-CC-Workset: 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.

Body ()

Root Schema : cloneLayout_request

Type: object

Show Source

• properties(required): object properties
  The properties to be saved with this layout

{
    "properties":{
        "properties":{
            "description":"The properties to be saved with this layout",
            "type":"object",
            "properties":{
                "defaultPage":{
                    "description":"whether or not this layout should be the default for the layout type",
                    "type":"boolean"
                },
                "notes":{
                    "description":"the notes associated with this layout",
                    "type":"string"
                },
                "displayName":{
                    "description":"the display name of the layout",
                    "type":"string"
                }
            },
            "required":[
                "notes",
                "displayName"
            ]
        }
    },
    "required":[
        "properties"
    ],
    "example":{
        "properties":{
            "defaultPage":true,
            "notes":"Testing new layout",
            "displayName":"New Cart Layout"
        }
    }
}

Example:

{
    "properties":{
        "defaultPage":true,
        "notes":"Testing new layout",
        "displayName":"New Cart Layout"
    }
}

Nested Schema : properties

Type: object

The properties to be saved with this layout

Show Source

• defaultPage: boolean
  whether or not this layout should be the default for the layout type
• displayName(required): string
  the display name of the layout
• notes(required): string
  the notes associated with this layout

{
    "description":"The properties to be saved with this layout",
    "type":"object",
    "properties":{
        "defaultPage":{
            "description":"whether or not this layout should be the default for the layout type",
            "type":"boolean"
        },
        "notes":{
            "description":"the notes associated with this layout",
            "type":"string"
        },
        "displayName":{
            "description":"the display name of the layout",
            "type":"string"
        }
    },
    "required":[
        "notes",
        "displayName"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : cloneLayout_response

Type: object

Show Source

• defaultPage: boolean
  Default page set or not
• displayName: string
  New Cart Layout
• layout: object layout
  Layout Information
• name: string
  New Cart Layout
• pageType: string
  cart
• pageTypeItem: object pageTypeItem
  Page Type Item
• repositoryId: string
  repository id
• route: string
  New Cart Layout

{
    "properties":{
        "layout":{
            "description":"Layout Information",
            "type":"object",
            "properties":{
                "displayName":{
                    "description":"New Cart Layout",
                    "type":"string"
                },
                "name":{
                    "description":"Shopping CartSummary Page Layout",
                    "type":"string"
                },
                "repositoryId":{
                    "description":"repository id",
                    "type":"string"
                }
            }
        },
        "defaultPage":{
            "description":"Default page set or not",
            "type":"boolean"
        },
        "pageType":{
            "description":"cart",
            "type":"string"
        },
        "route":{
            "description":"New Cart Layout",
            "type":"string"
        },
        "displayName":{
            "description":"New Cart Layout",
            "type":"string"
        },
        "name":{
            "description":"New Cart Layout",
            "type":"string"
        },
        "repositoryId":{
            "description":"repository id",
            "type":"string"
        },
        "pageTypeItem":{
            "description":"Page Type Item",
            "type":"object",
            "properties":{
                "repositoryId":{
                    "description":"shopping Cart Summary Page Type",
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : layout

Type: object

Layout Information

Show Source

• displayName: string
  New Cart Layout
• name: string
  Shopping CartSummary Page Layout
• repositoryId: string
  repository id

{
    "description":"Layout Information",
    "type":"object",
    "properties":{
        "displayName":{
            "description":"New Cart Layout",
            "type":"string"
        },
        "name":{
            "description":"Shopping CartSummary Page Layout",
            "type":"string"
        },
        "repositoryId":{
            "description":"repository id",
            "type":"string"
        }
    }
}

Nested Schema : pageTypeItem

Type: object

Page Type Item

Show Source

• repositoryId: string
  shopping Cart Summary Page Type

{
    "description":"Page Type Item",
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"shopping Cart Summary Page Type",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "layout":{
        "displayName":"New Cart Layout",
        "name":"ShoppingCartSummaryPageLayout",
        "repositoryId":"pl400002"
    },
    "defaultPage":true,
    "pageType":"cart",
    "route":"/New Cart Layout",
    "displayName":"New Cart Layout",
    "name":"New Cart Layout",
    "repositoryId":"pa100001",
    "pageTypeItem":{
        "repositoryId":"shoppingCartSummaryPageType"
    }
}

400 Response

Following model is returned when layout id does not exist.

Body ()

Root Schema : cloneLayout_failureResponse

Type: object

Show Source

• errorCode: string
  Default Value: 32010

  Error code for message
• message: string
  Default Value: The specified layout {layoutId} does not exist

  Message explaining the error
• status: string
  Default Value: 400

  HTTP status code for the error

{
    "properties":{
        "errorCode":{
            "default":"32010",
            "description":"Error code for message",
            "type":"string"
        },
        "message":{
            "default":"The specified layout {layoutId} does not exist",
            "description":"Message explaining the error",
            "type":"string"
        },
        "status":{
            "default":"400",
            "description":"HTTP status code for the error",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "errorCode":"32010",
    "message":"The specified layout {id} does not exist",
    "status":"400"
}

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| |------------------|------------------| |32016|Error cloning layout. ({0})| |32003|Error updating the configuration of a layout.| |32001|Error retrieving the layout by its ID.| |20032|No product id specified on item| |32010|The specified layout does not exist| |25100|Internal Error| |20030|internal Error| |32020|The specified page address {0} must be unique.| |32019|The specified display name must be unique|

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• errors: array errors
  An optional list of errors if multiple errors were encountered
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code
• type: string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top