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

Retrieves the Agent theme

get

/ccadmin/v1/themes/agentThemeDetails

Returns the Agent theme which is displayed in the Agent UI.

See Use Agent Themes for more information on Agent themes.

Request

There are no request parameters for this operation.

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":true,
    "thumbnail":null,
    "theme_additional_fonts":{
    },
    "notes":"This is the Agent Theme.",
    "is_active":false,
    "theme_styles_color":{
        "@ButtonPrimarySize":"medium",
        "@ButtonSecondaryTextDecoration":"none",
        "@ButtonPrimaryTextColor":"#ffffff",
        "@SubNavigationTextColor":"#6F7178",
        "@ButtonPrimaryUseGradient":"false",
        "@ButtonPrimaryFontStyle":"normal",
        "@ButtonSecondaryFontFamily":"@sansFontFamily",
        "@ButtonPrimaryFontWeight":"normal",
        "@NavbarLinkColor":"#3D3D3D",
        "@NavbarLinkHoverColor":"#195D8D",
        "@NavbarTextColor":"#333333",
        "@mobileNavBarButtonColor":"#333333",
        "@SubNavigationLinkHoverColor":"#195D8D",
        "@NavbarBackgroundHoverColor":"#FFFFFF",
        "@SitePageBorderColor":"#CCD7DF",
        "@ButtonSecondaryUseGradient":"false",
        "@LinkVisitedColor":"#195d8d",
        "@LinkColor":"#195d8d",
        "@ButtonPrimaryBackgroundColor":"#0572ce",
        "@NavbarBackgroundColor":"#FFFFFF",
        "@SubNavigationLinkColor":"#3D3D3D",
        "@ButtonPrimaryFontFamily":"@sansFontFamily",
        "@ButtonPrimaryTextDecoration":"none",
        "@ButtonSecondaryBorderRadius":"4px",
        "@ButtonSecondaryFontStyle":"normal",
        "@ButtonSecondaryTextColor":"#3d3d3d",
        "@SubNavigationBackgroundColor":"#FFFFFF",
        "@ButtonSecondaryFontWeight":"normal",
        "@ButtonSecondaryBackgroundColor":"#ffffff",
        "@ButtonPrimaryBorderRadius":"4px",
        "@LinkHoverColor":"#114062",
        "@ButtonSecondarySize":"medium",
        "@SubNavigationBackgroundHoverColor":"#FFFFFF",
        "@TextColor":"#000000"
    },
    "usingCodeView":false,
    "is_default":false,
    "associatedSites":[
    ],
    "theme_styles_typography":{
        "@H6LineHeight":"150%",
        "@H5TextDecoration":"inherit",
        "@H3FontFamily":"inherit",
        "@H5FontStyle":"inherit",
        "@H2FontStyle":"inherit",
        "@H2TextColor":"inherit",
        "@SiteLineHeight":"150%",
        "@SiteFontFamily":"@sansFontFamily",
        "@H1TextAlign":"inherit",
        "@ParagraphFontWeight":"normal",
        "@H5FontSize":"1.00rem",
        "@H4TextAlign":"inherit",
        "@H1TextDecoration":"inherit",
        "@H3LineHeight":"150%",
        "@H2FontWeight":"bold",
        "@H3FontSize":"1.75rem",
        "@ParagraphLineHeight":"150%",
        "@H3TextColor":"inherit",
        "@H3TextAlign":"inherit",
        "@H4FontFamily":"inherit",
        "@SiteFontSize":"14px",
        "@SiteTextAlign":"left",
        "@H5FontWeight":"normal",
        "@H6FontFamily":"inherit",
        "@H1FontSize":"2.75rem",
        "@H6FontStyle":"inherit",
        "@H6TextDecoration":"inherit",
        "@H2TextDecoration":"inherit",
        "@ParagraphTextColor":"inherit",
        "@H1FontStyle":"inherit",
        "@ParagraphTextAlign":"inherit",
        "@H4LineHeight":"150%",
        "@H1FontWeight":"bold",
        "@SiteTextColor":"#000000",
        "@ParagraphFontSize":"1.00rem",
        "@H5FontFamily":"inherit",
        "@H4FontWeight":"bold",
        "@ParagraphFontFamily":"inherit",
        "@H1FontFamily":"inherit",
        "@H2TextAlign":"inherit",
        "@H1LineHeight":"150%",
        "@H6FontSize":"0.85rem",
        "@H3TextDecoration":"inherit",
        "@H4TextColor":"inherit",
        "@ParagraphFontStyle":"inherit",
        "@ParagraphTextDecoration":"inherit",
        "@H1TextColor":"inherit",
        "@SiteTextDecoration":"none",
        "@H4FontSize":"1.25rem",
        "@SiteFontStyle":"normal",
        "@H3FontWeight":"bold",
        "@H6TextAlign":"inherit",
        "@H4TextDecoration":"inherit",
        "@H2FontFamily":"inherit",
        "@H3FontStyle":"inherit",
        "@SiteFontWeight":"normal",
        "@H5LineHeight":"150%",
        "@H2FontSize":"2.25rem",
        "@H6TextColor":"inherit",
        "@H4FontStyle":"inherit",
        "@H2LineHeight":"150%",
        "@H5TextColor":"inherit",
        "@H5TextAlign":"inherit",
        "@H6FontWeight":"normal"
    },
    "clone_parent_name":"Cloud Lake Theme",
    "repositoryId":"AgentTheme",
    "name":"Agent Theme",
    "is_custom":true,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/themes/agentThemeDetails"
        }
    ],
    "id":"AgentTheme",
    "theme_styles_general":{
        "@SiteBackgroundImageAttachment":"scroll",
        "@FooterBackgroundImageAttachment":"scroll",
        "@FooterBorderTopColor":"#FFFFFF",
        "@SiteBackgroundImageURL":"none",
        "@SitePageBorderWidth":"1px",
        "@NavigationBackgroundImagePosition":"top left",
        "@HeaderBackgroundUseGradient":"false",
        "@SiteBackgroundColorBottom":"##000000",
        "@HeaderTopBackgroundImageAttachment":"scroll",
        "@HeaderTopBackgroundImagePosition":"top left",
        "@HeaderTopBackgroundImageRepeat":"repeat-x",
        "@HeaderTopPaddingTop":"25px",
        "@FooterBackgroundColorBottom":"#FFFFFF",
        "@HeaderTopBackgroundColorTop":"#FFFFFF",
        "@HeaderBackgroundColorTop":"#FFFFFF",
        "@NavigationBackgroundImageURL":"none",
        "@HeaderTopBackgroundColor":"#FFFFFF",
        "@HeaderBackgroundImageAttachment":"scroll",
        "@FooterBackgroundImageURL":"none",
        "@FooterBackgroundImageRepeat":"repeat-x",
        "@NavigationBackgroundColor":"#FFFFFF",
        "@NavigationBackgroundUseGradient":"false",
        "@SiteBackgroundImagePosition":"top left",
        "@HeaderBackgroundImageRepeat":"repeat-x",
        "@NavigationBackgroundImageRepeat":"no-repeat",
        "@SiteBackgroundImageRepeat":"no-repeat",
        "@TableHeaderColor":"#EBEBEB",
        "@FooterBackgroundUseGradient":"false",
        "@SiteBackgroundColorTop":"#000000",
        "@HeaderTopBackgroundUseGradient":"false",
        "@HeaderBackgroundColorBottom":"#FFFFFF",
        "@HeaderTopBackgroundColorBottom":"#FFFFFF",
        "@SitePageBackgroundColor":"#FFFFFF",
        "@HeaderBackgroundImagePosition":"top left",
        "@HeaderTopBackgroundImageURL":"none",
        "@HeaderTopBorderBottomColor":"#FFFFFF",
        "@FooterBackgroundColorTop":"#FFFFFF",
        "@HeaderBackgroundColor":"#FFFFFF",
        "@NavigationBackgroundColorBottom":"#FFFFFF",
        "@HeaderBackgroundImageURL":"none",
        "@NavigationBackgroundColorTop":"#FFFFFF",
        "@SiteBackgroundColor":"#f5f5f5",
        "@FooterBackgroundColor":"#FFFFFF",
        "@SitePageBorderStyle":"solid",
        "@NavigationBackgroundImageAttachment":"scroll",
        "@SiteBackgroundUseGradient":"false",
        "@FooterBackgroundImagePosition":"top left"
    },
    "clone_parent_id":"100001",
    "compilationStatuses":[
        {
            "occurredAt":"2020-04-07T15:20:27.000Z",
            "repositoryId":"100002",
            "siteId":null,
            "details":null,
            "id":"100002",
            "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
70021Internal error retrieving theme.See returned error messages for more information.
70026No agent theme exists on the system.An agent theme needs to be created.

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