Jump to

• Request
• Response

Recompile active theme.

post

/ccadmin/v1/themes/recompileActive

Recompiles the current active theme.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returned when the operation succeeds.

Body ()

Root Schema : recompileActiveTheme_response

Type: array

The recompile active theme response.

Show Source

• Array of: object items

{
    "description":"The recompile active theme response.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "isAgentTheme":{
                "description":"Is this theme the agent theme.",
                "type":"boolean"
            },
            "thumbnail":{
                "description":"Optional thumbnail image of the theme.",
                "type":"string"
            },
            "theme_additional_fonts":{
                "description":"Lists additional fonts configured for the theme.",
                "type":"string"
            },
            "notes":{
                "description":"Notes of the theme",
                "type":"string"
            },
            "is_active":{
                "description":"Is the theme currently active",
                "type":"boolean"
            },
            "usingCodeView":{
                "description":"Indicates if Code View has been used to configure the theme.",
                "type":"boolean"
            },
            "is_default":{
                "description":"Is this the default theme.",
                "type":"boolean"
            },
            "associatedSites":{
                "description":"Sites associated with the theme.",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "repositoryId":{
                            "description":"Repository ID of associated site.",
                            "type":"string"
                        },
                        "name":{
                            "description":"The name of the associated site.",
                            "type":"string"
                        }
                    }
                }
            },
            "clone_parent_name":{
                "description":"Clone parent name of the theme.",
                "type":"string"
            },
            "repositoryId":{
                "description":"The repository Id of the theme.",
                "type":"string"
            },
            "name":{
                "description":"The name of the theme.",
                "type":"string"
            },
            "is_custom":{
                "description":"Is this theme a custom theme.",
                "type":"boolean"
            },
            "id":{
                "description":"The ID of the theme.",
                "type":"string"
            },
            "clone_parent_id":{
                "description":"The ID of the clone parent of the theme.",
                "type":"string"
            },
            "compilationStatuses":{
                "description":"The compilation status of the theme.",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "occurredAt":{
                            "description":"When did the compilation occur.",
                            "type":"string"
                        },
                        "repositoryId":{
                            "description":"The repository ID of the compilation.",
                            "type":"string"
                        },
                        "siteId":{
                            "description":"The site Id.",
                            "type":"string"
                        },
                        "details":{
                            "description":"Description of the compilation.",
                            "type":"string"
                        },
                        "id":{
                            "description":"ID of the compilation.",
                            "type":"string"
                        },
                        "status":{
                            "description":"The status of the compilation",
                            "type":"integer"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "isAgentTheme":{
            "description":"Is this theme the agent theme.",
            "type":"boolean"
        },
        "thumbnail":{
            "description":"Optional thumbnail image of the theme.",
            "type":"string"
        },
        "theme_additional_fonts":{
            "description":"Lists additional fonts configured for the theme.",
            "type":"string"
        },
        "notes":{
            "description":"Notes of the theme",
            "type":"string"
        },
        "is_active":{
            "description":"Is the theme currently active",
            "type":"boolean"
        },
        "usingCodeView":{
            "description":"Indicates if Code View has been used to configure the theme.",
            "type":"boolean"
        },
        "is_default":{
            "description":"Is this the default theme.",
            "type":"boolean"
        },
        "associatedSites":{
            "description":"Sites associated with the theme.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"Repository ID of associated site.",
                        "type":"string"
                    },
                    "name":{
                        "description":"The name of the associated site.",
                        "type":"string"
                    }
                }
            }
        },
        "clone_parent_name":{
            "description":"Clone parent name of the theme.",
            "type":"string"
        },
        "repositoryId":{
            "description":"The repository Id of the theme.",
            "type":"string"
        },
        "name":{
            "description":"The name of the theme.",
            "type":"string"
        },
        "is_custom":{
            "description":"Is this theme a custom theme.",
            "type":"boolean"
        },
        "id":{
            "description":"The ID of the theme.",
            "type":"string"
        },
        "clone_parent_id":{
            "description":"The ID of the clone parent of the theme.",
            "type":"string"
        },
        "compilationStatuses":{
            "description":"The compilation status of the theme.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "occurredAt":{
                        "description":"When did the compilation occur.",
                        "type":"string"
                    },
                    "repositoryId":{
                        "description":"The repository ID of the compilation.",
                        "type":"string"
                    },
                    "siteId":{
                        "description":"The site Id.",
                        "type":"string"
                    },
                    "details":{
                        "description":"Description of the compilation.",
                        "type":"string"
                    },
                    "id":{
                        "description":"ID of the compilation.",
                        "type":"string"
                    },
                    "status":{
                        "description":"The status of the compilation",
                        "type":"integer"
                    }
                }
            }
        }
    }
}

Nested Schema : associatedSites

Type: array

Sites associated with the theme.

Show Source

• Array of: object items

{
    "description":"Sites associated with the theme.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "repositoryId":{
                "description":"Repository ID of associated site.",
                "type":"string"
            },
            "name":{
                "description":"The name of the associated site.",
                "type":"string"
            }
        }
    }
}

Nested Schema : compilationStatuses

Type: array

The compilation status of the theme.

Show Source

• Array of: object items

{
    "description":"The compilation status of the theme.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "occurredAt":{
                "description":"When did the compilation occur.",
                "type":"string"
            },
            "repositoryId":{
                "description":"The repository ID of the compilation.",
                "type":"string"
            },
            "siteId":{
                "description":"The site Id.",
                "type":"string"
            },
            "details":{
                "description":"Description of the compilation.",
                "type":"string"
            },
            "id":{
                "description":"ID of the compilation.",
                "type":"string"
            },
            "status":{
                "description":"The status of the compilation",
                "type":"integer"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• name(optional): string
  The name of the associated site.
• repositoryId(optional): string
  Repository ID of associated site.

{
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"Repository ID of associated site.",
            "type":"string"
        },
        "name":{
            "description":"The name of the associated site.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "occurredAt":{
            "description":"When did the compilation occur.",
            "type":"string"
        },
        "repositoryId":{
            "description":"The repository ID of the compilation.",
            "type":"string"
        },
        "siteId":{
            "description":"The site Id.",
            "type":"string"
        },
        "details":{
            "description":"Description of the compilation.",
            "type":"string"
        },
        "id":{
            "description":"ID of the compilation.",
            "type":"string"
        },
        "status":{
            "description":"The status of the compilation",
            "type":"integer"
        }
    }
}

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,
        "id":"cloudLakeTheme",
        "clone_parent_id":null,
        "compilationStatuses":[
            {
                "occurredAt":"2021-09-17T10:04:32.000Z",
                "repositoryId":"100001",
                "siteId":"siteUS",
                "details":null,
                "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 Code	Description	Possible Fix
70000	Internal server error.	See returned error messages for more information.
70012	Error getting active theme.	See returned error messages for more information.
70010	Error setting active theme.	See returned error message for further information.
70004	Theme does not exist.	See returned error message for further information.
70021	Theme retrieval failed.	See returned error message for further information.

The error response:

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top