REST API for Oracle Commerce Cloud 22A

Retrieve themes

get

/ccadmin/v1/themes

Returns a list of themes. The list of themes returned can be filtered by specifying the type and includeagenttheme query params. You can filter by type and additionally filter to include or exclude agent themes.

The valid options for type are:

purchased - Return purchased themes only.
custom - Return custom themes only.

If the type query param is omitted, then themes are returned.

To include the agent theme pass query param includeagenttheme as true. The default is to exclude the agent theme.

Request

Supported Media Types

application/json

Query Parameters

includeagenttheme(optional): boolean

Set to true to include the agent theme in the results

Default Value: false
type(optional): string

One of custom or purchased

Response

Supported Media Types

application/json

200 Response

Returned when the operation succeeds.

Root Schema : getThemes_response

Type: object

Show Source

items(optional): array items

The list of all themes.

{
    "properties":{
        "items":{
            "description":"The list of all themes.",
            "type":"array",
            "items":{
                "type":"object",
                "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":"Optional notes of the theme.",
                        "type":"string"
                    },
                    "is_active":{
                        "description":"Indicates whether the 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 theme at a time is allowed to be set to true. By default this will be the 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"
                    },
                    "repositoryId":{
                        "description":"The repository ID of the theme.",
                        "type":"string"
                    },
                    "name":{
                        "description":"Theme name.",
                        "type":"string"
                    },
                    "is_custom":{
                        "description":"This boolean flag indicates if this is a custom theme.",
                        "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"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

The list of all themes.

Show Source

Array of: object items

{
    "description":"The list of all themes.",
    "type":"array",
    "items":{
        "type":"object",
        "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":"Optional notes of the theme.",
                "type":"string"
            },
            "is_active":{
                "description":"Indicates whether the 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 theme at a time is allowed to be set to true. By default this will be the 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"
            },
            "repositoryId":{
                "description":"The repository ID of the theme.",
                "type":"string"
            },
            "name":{
                "description":"Theme name.",
                "type":"string"
            },
            "is_custom":{
                "description":"This boolean flag indicates if this is a custom theme.",
                "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"
            }
        }
    }
}

Nested Schema : items

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

Indicates whether the theme is active.
is_custom(optional): boolean

This boolean flag indicates if this is a custom theme.
is_default(optional): boolean

Indicates if this is the default theme. Only one theme at a time is allowed to be set to true. By default this will be the 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

Optional 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":"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":"Optional notes of the theme.",
            "type":"string"
        },
        "is_active":{
            "description":"Indicates whether the 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 theme at a time is allowed to be set to true. By default this will be the 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"
        },
        "repositoryId":{
            "description":"The repository ID of the theme.",
            "type":"string"
        },
        "name":{
            "description":"Theme name.",
            "type":"string"
        },
        "is_custom":{
            "description":"This boolean flag indicates if this is a custom theme.",
            "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":"/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":"2020-04-07T15:19:47.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
20020	Internal error fetching themes.	See returned error messages for more information.

The error response:

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"
        }
    }
}