Jump to

• Request
• Response

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.

Body ()

Root Schema : cloneTheme_request

Type: object

Show Source

• name: string
  Name of the cloned theme.

{
    "properties":{
        "name":{
            "description":"Name of the cloned theme.",
            "type":"string"
        }
    },
    "required":[
        "name"
    ],
    "example":{
        "name":"ClonedTheme"
    }
}

Example:

{
    "name":"ClonedTheme"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returned when the operation succeeds.

Body ()

Root Schema : cloneTheme_response

Type: object

Show Source

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

{
    "properties":{
        "isAgentTheme":{
            "description":"Indicates if this is the theme used in the Agent UI. There is only one Agent theme on the system.",
            "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":"Whether theme is active.",
            "type":"boolean"
        },
        "usingCodeView":{
            "description":"Indicates if Code View has been used to configure the theme.",
            "type":"boolean"
        },
        "is_default":{
            "description":"Indicates if this is the default theme. Only one will have this set to true. By default this will be  Cloud Lake Theme.",
            "type":"boolean"
        },
        "associatedSites":{
            "description":"Lists the sites which have this as their configured theme.",
            "type":"string"
        },
        "clone_parent_name":{
            "description":"Clone parent name of the theme.",
            "type":"string"
        },
        "name":{
            "description":"Theme name.",
            "type":"string"
        },
        "repositoryId":{
            "description":"Repository ID of the theme.",
            "type":"string"
        },
        "is_custom":{
            "description":"Whether theme is custom or not.",
            "type":"boolean"
        },
        "id":{
            "description":"The ID of the theme.",
            "type":"string"
        },
        "clone_parent_id":{
            "description":"Clones the parent ID of the theme.",
            "type":"string"
        },
        "compilationStatuses":{
            "description":"Indicates status of  recent theme compilations for this theme.",
            "type":"string"
        }
    }
}

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:

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:

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