1. REST API for Oracle Commerce Cloud 22A
  2. Tasks
  3. Admin
  4. Themes

Compile theme.

post

/ccadmin/v1/themes/{id}/compile

Compiles the given theme on the provided site.

Request

Supported Media Types
Path Parameters
Body ()
Root Schema : compileTheme_request
Type: object
Show Source
Example:
{
    "siteId":"siteUS"
}
Back to Top

Response

Supported Media Types

200 Response

Returned when the operation succeeds.
Body ()
Root Schema : compileTheme_response
Type: array
The recompile active theme response.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : associatedSites
Type: array
Sites associated with the theme.
Show Source
Nested Schema : compilationStatuses
Type: array
The compilation status of the theme.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
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:
Error CodeDescriptionPossible Fix
70000Internal server error.See returned error messages for more information.
70021Theme retrieval failed.See returned error message for further information.
70004Theme does not exist.Ensure theme exists.

The error response:
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top