Retrieve an active theme
get
/ccadmin/v1/themes/active
Returns the active theme for the specified site, or the default theme if the site is not specified.
Request
Supported Media Types
- application/json
Query Parameters
-
site(optional): string
The ID of the site.
Response
Supported Media Types
- application/json
200 Response
Returned when the operation succeeds.
Root Schema : getActiveTheme_response
Type:
Show Source
object
-
items(optional):
array items
List of themes.
Nested Schema : items
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":null,
"is_active":true,
"usingCodeView":false,
"is_default":true,
"associatedSites":[
{
"repositoryId":"siteUS",
"name":"Commerce Cloud Site"
}
],
"clone_parent_name":"Cloud Lake Theme",
"repositoryId":"darkTheme",
"name":"Dark Theme",
"is_custom":true,
"id":"darkTheme",
"clone_parent_id":"100001",
"compilationStatuses":[
]
}
]
400 Response
Returned if the site ID referenced in the body is invalid.
Root Schema : getActiveTheme_400response
Type:
Show Source
object
-
errorCode(optional):
string
The OCC error code
-
message(optional):
string
The localized message describing the error
-
status(optional):
string
HTTP status code
Example Response (application/json)
{
"errorCode":"30014",
"message":"Site does not exist",
"status":"400"
}
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 | Theme internal error | See returned error messages for more information. |
30014 | Site with given ID does not exist on system | Ensure you have specified a valid site ID. |
70012 | Error fetching active theme | See returned error messages for more information. |
70021 | Internal error retrieving 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