Clone a theme by ID
post
/ccadmin/v1/themes/{id}/clone
Returns a copy of the theme specified by the ID with the name specified in the request payload. This is the only method of creating a new theme.
Once cloned, the theme can be assigned as the theme of one or more sites, or it can be set as the agent theme.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The ID of the theme.
Root Schema : cloneTheme_request
Type:
Show Source
object
-
name:
string
Name of the cloned theme.
Example:
{
"name":"ClonedTheme"
}
Response
Supported Media Types
- application/json
200 Response
Returned when the operation succeeds.
Root Schema : cloneTheme_response
Type:
Show Source
object
-
associatedSites(optional):
string
Lists the sites which have this as their configured theme.
-
clone_parent_id(optional):
string
Clones the parent ID of the theme.
-
clone_parent_name(optional):
string
Clone parent name of the theme.
-
compilationStatuses(optional):
string
Indicates status of recent theme compilations for this theme.
-
id(optional):
string
The ID of the theme.
-
is_active(optional):
boolean
Whether theme is active.
-
is_custom(optional):
boolean
Whether theme is custom or not.
-
is_default(optional):
boolean
Indicates if this is the default theme. Only one will have this set to true. By default this will be Cloud Lake Theme.
-
isAgentTheme(optional):
boolean
Indicates if this is the theme used in the Agent UI. There is only one Agent theme on the system.
-
name(optional):
string
Theme name.
-
notes(optional):
string
Notes of the theme.
-
repositoryId(optional):
string
Repository ID of the theme.
-
theme_additional_fonts(optional):
string
Lists additional fonts configured for the theme.
-
thumbnail(optional):
string
Optional thumbnail image of the theme.
-
usingCodeView(optional):
boolean
Indicates if Code View has been used to configure the theme.
Example Response (application/json)
{
"isAgentTheme":false,
"thumbnail":null,
"theme_additional_fonts":{
},
"notes":"",
"is_active":false,
"usingCodeView":false,
"is_default":false,
"associatedSites":[
],
"clone_parent_name":"Dark Theme",
"repositoryId":"100001",
"name":"testClone",
"is_custom":true,
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccadminui/v1/themes/darkTheme/clone"
}
],
"id":"100001",
"clone_parent_id":"darkTheme",
"compilationStatuses":[
]
}
Default Response
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
The error response:
Error Code | Description | Possible Fix |
---|---|---|
20306 | Name for new theme already exists. | Choose a new, unique name. |
20309 | New theme name required. | Ensure theme name has been specified in the request payload body. |
70004 | Specified theme in URI does not exist. | Ensure a valid theme ID has been specified. |
70014 | Internal error when creating new theme. | See returned error messages for more information. |
The error response:
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