deleteLayout
delete
/ccadmin/v1/layouts/{id}
Delete Layout. Deletes a layout
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.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
400 Response
Error response thrown when cannot retrieve a layout.
Root Schema : deleteLayout_failureResponse
Type:
Show Source
object
-
errorCode(optional):
string
Default Value:
32010
Error code for message -
message(optional):
string
Default Value:
The specified layout {layoutId} does not exist
Message explaining the error -
status(optional):
string
Default Value:
400
HTTP status code for the error
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|
|------------------|------------------|
|32017|Error deleting layout. ({0})|
|32001|Error retrieving the layout by its ID.|
|32010|The specified layout does not exist|
|32018|Specified layout is set as default. Unable to delete.|
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