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

Retrieve a theme by ID

get

/ccadmin/v1/themes/{id}

Returns a particular theme by the ID specified.

Request

Supported Media Types
Path Parameters
Back to Top

Response

Supported Media Types

200 Response

Returned when the operation succeeds.
Body ()
Root Schema : getTheme_response
Type: object
Show Source
Nested Schema : theme_styles_color
Type: object
Color information of theme styles.
Show Source
Nested Schema : theme_styles_general
Type: object
General information of theme styles.
Show Source
Nested Schema : theme_styles_typography
Type: object
Typography information of theme styles.
Show Source
Example Response (application/json)
{
    "isAgentTheme":"false",
    "thumbnail":"/img/cloudlake.jpg",
    "theme_additional_fonts":{
    },
    "is_active":true,
    "theme_styles_color":{
        "@ButtonPrimaryTextColor":"#fff",
        "@ButtonPrimaryBackgroundColorTop":"#08C",
        "@SubNavigationTextColor":"#fff",
        "@ButtonPrimaryFontStyle":"normal",
        "@ButtonPrimaryFontWeight":"normal",
        "@SubNavigationLinkHoverColor":"#fff\n    ",
        "@NavigationLinkShadowColor":"#000",
        "@NavigationLinkColor":"#DFDFDF",
        "@LinkColor":"#0088cc",
        "@NavigationLinkColorHover":"#FFF",
        "@ButtonPrimaryBackgroundColor":"#08C",
        "@NavigationBorderColor":"#3D3F44",
        "@SubNavigationLinkColor":"#fff",
        "@NavigationBackgroundColor":"#4f5158",
        "@ButtonPrimaryBackgroundColorBottom":"#04C",
        "@ButtonPrimaryFontFamily":"@sansFontFamily",
        "@ButtonPrimaryTextDecoration":"none",
        "@ButtonPrimaryBorderColor":"#04C",
        "@SubNavigationBackgroundColor":"#fff",
        "@NavigationBackgroundColorBottom":"#34363a",
        "@NavigationBackgroundColorTop":"#676a74",
        "@ButtonPrimaryBorderRadius":"4px",
        "@LinkHoverColor":"#FFD303",
        "@SubNavigationBackgroundHoverColor":"#fff",
        "@TextColor":"#333"
    },
    "notes":"This is the Cloud Lake Theme.",
    "usingCodeView":false,
    "is_default":false,
    "associatedSites":[
    ],
    "theme_styles_typography":{
        "@H6LineHeight":"20px",
        "@H5FontFamily":"@sansFontFamily",
        "@H3FontFamily":"@sansFontFamily",
        "@H4FontWeight":"bold",
        "@ParagraphFontFamily":"@sansFontFamily",
        "@H1FontFamily":"@sansFontFamily",
        "@H2TextColor":"#333",
        "@SiteLineHeight":"20px",
        "@H1LineHeight":"40px",
        "@H6FontSize":"11.9px",
        "@SiteFontFamily":"@sansFontFamily",
        "@ParagraphFontWeight":"normal",
        "@H5FontSize":"14px",
        "@H4TextColor":"#333",
        "@H1TextColor":"#333",
        "@H4FontSize":"17.5px",
        "@H3LineHeight":"40px",
        "@H2FontWeight":"bold",
        "@H3FontSize":"24.5px",
        "@ParagraphLineHeight":"20px\n    ",
        "@H3TextColor":"#333",
        "@H3FontWeight":"bold",
        "@H4FontFamily":"@sansFontFamily",
        "@SiteFontSize":"14px",
        "@H2FontFamily":"@sansFontFamily",
        "@H5FontWeight":"normal",
        "@H6FontFamily":"@sansFontFamily",
        "@SiteFontWeight":"normal",
        "@H1FontSize":"38.5px",
        "@H5LineHeight":"20px",
        "@H2FontSize":"31.5px",
        "@H6TextColor":"#333",
        "@ParagraphTextColor":"#333",
        "@H2LineHeight":"40px",
        "@H6FontWeight":"normal",
        "@H5TextColor":"#333",
        "@H4LineHeight":"20px",
        "@H1FontWeight":"bold",
        "@ParagraphFontSize":"14px"
    },
    "clone_parent_name":null,
    "name":"Cloud Lake Theme",
    "repositoryId":"100001",
    "is_custom":false,
    "id":"100001",
    "theme_styles_general":{
        "@FooterBorderTopColor":"#bcd7e6\n    ",
        "@SiteBackgroundImageAttachment":"scroll",
        "@FooterBackgroundImageAttachment":"scroll",
        "@SiteBackgroundImageURL":"none",
        "@SiteBackgroundColorBottom":"transparent",
        "@FooterBackgroundColorBottom":"transparent",
        "@HeaderTopPaddingTop":"25px",
        "@HeaderBackgroundColorTop":"transparent",
        "@HeaderTopBackgroundColor":"#e2f5ff",
        "@ContentBackgroundColor":"#FFF",
        "@HeaderBackgroundImageAttachment":"scroll",
        "@FooterBackgroundImageURL":"none",
        "@FooterBackgroundImageRepeat":"repeat-x",
        "@HeaderBackgroundImageRepeat":"repeat-x",
        "@SiteBackgroundImagePosition":"topleft",
        "@SiteBackgroundImageRepeat":"no-repeat",
        "@SiteBackgroundColorTop":"transparent",
        "@HeaderBackgroundColorBottom":"transparent",
        "@HeaderBackgroundImagePosition":"topleft",
        "@HeaderTopBackgroundImageURL":"'/img/header-wrap.png'",
        "@FooterBackgroundColorTop":"transparent",
        "@HeaderTopBorderBottomColor":"#bcd7e6",
        "@HeaderBackgroundColor":"#FFF",
        "@HeaderBackgroundImageURL":"none",
        "@FooterBackgroundColor":"#e2f5ff",
        "@SiteBackgroundColor":"#FFF",
        "@FooterBackgroundImagePosition":"topleft"
    },
    "clone_parent_id":null,
    "compilationStatuses":[
    ]
}

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
70004The specified theme does not exist on system.Ensure you have specified a valid theme ID.
70021Internal error retrieving theme.See returned error messages for more information.

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