Compile theme.
post
/ccadmin/v1/themes/{id}/compile
Compiles the given theme on the provided site.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The ID of the theme.
Root Schema : compileTheme_request
Type:
Show Source
object
-
siteId(optional):
string
The site ID to compile the theme for.
Example:
{
"siteId":"siteUS"
}
Response
Supported Media Types
- application/json
200 Response
Returned when the operation succeeds.
Nested Schema : items
Type:
Show Source
object
-
associatedSites(optional):
array associatedSites
Sites associated with the theme.
-
clone_parent_id(optional):
string
The ID of the clone parent of the theme.
-
clone_parent_name(optional):
string
Clone parent name of the theme.
-
compilationStatuses(optional):
array compilationStatuses
The compilation status of the theme.
-
id(optional):
string
The ID of the theme.
-
is_active(optional):
boolean
Is the theme currently active
-
is_custom(optional):
boolean
Is this theme a custom theme.
-
is_default(optional):
boolean
Is this the default theme.
-
isAgentTheme(optional):
boolean
Is this theme the agent theme.
-
name(optional):
string
The name of the theme.
-
notes(optional):
string
Notes of the theme
-
repositoryId(optional):
string
The 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.
Nested Schema : items
Type:
Show Source
object
-
name(optional):
string
The name of the associated site.
-
repositoryId(optional):
string
Repository ID of associated site.
Nested Schema : items
Type:
Show Source
object
-
details(optional):
string
Description of the compilation.
-
id(optional):
string
ID of the compilation.
-
occurredAt(optional):
string
When did the compilation occur.
-
repositoryId(optional):
string
The repository ID of the compilation.
-
siteId(optional):
string
The site Id.
-
status(optional):
integer
The status of the compilation
Example Response (application/json)
{
"isAgentTheme":false,
"thumbnail":"/img/cloudlake.jpg",
"theme_additional_fonts":{
},
"notes":null,
"is_active":true,
"usingCodeView":false,
"is_default":true,
"associatedSites":[
{
"repositoryId":"siteUS",
"name":"Commerce Cloud Site"
}
],
"clone_parent_name":null,
"repositoryId":"cloudLakeTheme",
"name":"Cloud Lake Theme",
"is_custom":false,
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccadmin/v1/themes/cloudLakeTheme/compile"
}
],
"id":"cloudLakeTheme",
"clone_parent_id":null,
"compilationStatuses":[
{
"occurredAt":"2021-09-24T13:30:02.978Z",
"repositoryId":"100001",
"siteId":"siteUS",
"details":"",
"id":"100001",
"status":101
}
]
}
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 |
---|---|---|
70000 | Internal server error. | See returned error messages for more information. |
70021 | Theme retrieval failed. | See returned error message for further information. |
70004 | Theme does not exist. | Ensure theme exists. |
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