Jump to

• Request
• Response

Update the Agent theme source

put

/ccadmin/v1/themes/agentThemeSource

Updates the style and variable LESS code of the Agent theme

Request

Supported Media Types

• application/json

Body ()

Root Schema : updateThemeSource_request

Type: object

Show Source

• styles: string
  The theme styles LESS code.
• variables: string
  The theme variables LESS code.

{
    "properties":{
        "variables":{
            "description":"The theme variables LESS code.",
            "type":"string"
        },
        "styles":{
            "description":"The theme styles LESS code.",
            "type":"string"
        }
    },
    "required":[
        "variables",
        "styles"
    ],
    "example":{
        "variables":"\n\n/***** Typography *****/\n\n@H1FontFamily : inherit;\n@H1FontSize : 2.75rem;\n@H1FontStyle : inherit;\n@H1FontWeight : bold;\n@H1LineHeight : 100%;\n@H1TextAlign : inherit;\n@H1TextColor : inherit;\n@H1TextDecoration : inherit;\n@H2FontFamily : inherit;\n@H2FontSize : 2.25rem;\n@H2FontStyle : inherit;\n@H2FontWeight : bold;\n@H2LineHeight : inherit;\n@H2TextAlign : inherit;\n@H2TextColor : inherit;\n@H2TextDecoration : inherit;\n@H3FontFamily : inherit;\n@H3FontSize : 1.75rem;\n@H3FontStyle : inherit;\n@H3FontWeight : bold;\n@H3LineHeight : inherit;\n@H3TextAlign : inherit;\n@H3TextColor : inherit;\n@H3TextDecoration : inherit;\n@H4FontFamily : inherit;\n@H4FontSize : 1.25rem;\n@H4FontStyle : inherit;\n@H4FontWeight : bold;\n@H4LineHeight : inherit;\n@H4TextAlign : inherit;\n@H4TextColor : inherit;\n@H4TextDecoration : inherit;\n@H5FontFamily : inherit;\n@H5FontSize : 1.00rem;\n@H5FontStyle : inherit;\n@H5FontWeight : normal;\n@H5LineHeight : inherit;\n@H5TextAlign : inherit;\n@H5TextColor : inherit;\n@H5TextDecoration : inherit;\n@H6FontFamily : inherit;\n@H6FontSize : 0.85rem;\n@H6FontStyle : inherit;\n@H6FontWeight : normal;\n@H6LineHeight : inherit;\n@H6TextAlign : inherit;\n@H6TextColor : inherit;\n@H6TextDecoration : inherit;\n@ParagraphFontFamily : inherit;\n@ParagraphFontSize : 1.00rem;\n@ParagraphFontStyle : inherit;\n@ParagraphFontWeight : normal;\n@ParagraphLineHeight : inherit;\n@ParagraphTextAlign : inherit;\n@ParagraphTextColor : inherit;\n@ParagraphTextDecoration : inherit;\n@SiteFontFamily : @sansFontFamily;\n@SiteFontSize : 14px;\n@SiteFontStyle : normal;\n@SiteFontWeight : normal;\n@SiteLineHeight : 150%;\n@SiteTextAlign : left;\n@SiteTextColor : #333;\n@SiteTextDecoration : none;\n\n\n/***** Colors *****/\n\n@ButtonPrimaryBackgroundColor : #195d8e;\n@ButtonPrimaryBorderRadius : 4px;\n@ButtonPrimaryFontFamily : @sansFontFamily;\n@ButtonPrimaryFontStyle : normal;\n@ButtonPrimaryFontWeight : normal;\n@ButtonPrimarySize : medium;\n@ButtonPrimaryTextColor : #ffffff;\n@ButtonPrimaryTextDecoration : none;\n@ButtonPrimaryUseGradient : false;\n@ButtonSecondaryBackgroundColor : #f7f7f7;\n@ButtonSecondaryBorderRadius : 4px;\n@ButtonSecondaryFontFamily : @sansFontFamily;\n@ButtonSecondaryFontStyle : normal;\n@ButtonSecondaryFontWeight : normal;\n@ButtonSecondarySize : medium;\n@ButtonSecondaryTextColor : #3d3d3e;\n@ButtonSecondaryTextDecoration : none;\n@ButtonSecondaryUseGradient : false;\n@LinkColor : #195d8d;\n@LinkHoverColor : #114062;\n@NavbarBackgroundColor : #fff;\n@NavbarBackgroundHoverColor : #fff;\n@NavbarLinkColor : #3D3D3D;\n@NavbarLinkHoverColor : #195D8D;\n@NavbarTextColor : #333333;\n@NavigationBackgroundColor : #FFF;\n@NavigationBackgroundColorBottom : #FFF;\n@NavigationBackgroundColorTop : #FFF;\n@NavigationBackgroundImageAttachment : scroll;\n@NavigationBackgroundImagePosition : top left;\n@NavigationBackgroundImageRepeat : no-repeat;\n@NavigationBackgroundImageURL : none;\n@NavigationBackgroundUseGradient : false;\n@NavigationPageBackgroundColor : #FFF;\n@SubNavigationBackgroundColor : #fff;\n@SubNavigationBackgroundHoverColor : #FFF;\n@SubNavigationLinkColor : #3D3D3D;\n@SubNavigationLinkHoverColor : #195D8D;\n@SubNavigationTextColor : #6F7178;\n@TextColor : #333;\n\n\n/***** General *****/\n\n@FooterBackgroundColor : none;\n@FooterBackgroundColorBottom : #FFF;\n@FooterBackgroundColorTop : #FFF;\n@FooterBackgroundImageAttachment : scroll;\n@FooterBackgroundImagePosition : top left;\n@FooterBackgroundImageRepeat : repeat-x;\n@FooterBackgroundImageURL : none;\n@FooterBackgroundUseGradient : false;\n@FooterBorderTopColor : #bcd7e6;\n@HeaderBackgroundColor : #FFF;\n@HeaderBackgroundColorBottom : #FFF;\n@HeaderBackgroundColorTop : #FFF;\n@HeaderBackgroundImageAttachment : scroll;\n@HeaderBackgroundImagePosition : bottom center;\n@HeaderBackgroundImageRepeat : repeat-x;\n@HeaderBackgroundImageURL : url(/img/header-btm-line.png);\n@HeaderBackgroundUseGradient : false;\n@HeaderTopBackgroundColor : #F5F5F5;\n@HeaderTopBackgroundColorBottom : #FFF;\n@HeaderTopBackgroundColorTop : #FFF;\n@HeaderTopBackgroundImageAttachment : scroll;\n@HeaderTopBackgroundImagePosition : top left;\n@HeaderTopBackgroundImageRepeat : repeat-x;\n@HeaderTopBackgroundImageURL : url(/img/header-wrap.png);\n@HeaderTopBackgroundUseGradient : false;\n@HeaderTopBorderBottomColor : #bcd7e6;\n@HeaderTopPaddingTop : 25px;\n@SiteBackgroundColor : #FFF;\n@SiteBackgroundColorBottom : #FFF;\n@SiteBackgroundColorTop : #FFF;\n@SiteBackgroundImageAttachment : scroll;\n@SiteBackgroundImagePosition : top left;\n@SiteBackgroundImageRepeat : no-repeat;\n@SiteBackgroundImageURL : url(/file/media/sitestudio/Clocks-v2-05.png);\n@SiteBackgroundUseGradient : false;\n@SitePageBackgroundColor : #FFF;\n",
        "styles":"/******************************************************************************\r\n    MIXINS\r\n******************************************************************************/\r\n.background-styles (@BackgroundColor, @BackgroundImageURL, @BackgroundImageRepeat, @BackgroundImagePosition, @BackgroundColorTop, @BackgroundColorBottom, @BackgroundImageAttachment) {\r\n\r\n  background: @BackgroundImageURL @BackgroundImagePosition @BackgroundImageRepeat, -moz-linear-gradient(top, @BackgroundColorTop 0%, @BackgroundColorBottom 100%);\r\n  background: @BackgroundImageURL @BackgroundImagePosition @BackgroundImageRepeat, -webkit-gradient(linear, left top, left bottom, color-stop(0%,@BackgroundColorTop), color-stop(100%,@BackgroundColorBottom));\r\n  filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='@BackgroundColorTop', endColorstr='@BackgroundColorBottom',GradientType=0 );\r\n}\r\n\r\n/******************************************************************************\r\n    GENERAL STYLES\r\n******************************************************************************/\r\nhtml {\r\n  font-size:            @SiteFontSize;\r\n}\r\n\r\nbody {\r\n\r\n  background: @SiteBackgroundColor @SiteBackgroundImageURL @SiteBackgroundImagePosition @SiteBackgroundImageRepeat;\r\n\r\n  .SiteBackground() when (@SiteBackgroundUseGradient) {\r\n    .background-styles (@SiteBackgroundColor, @SiteBackgroundImageURL, @SiteBackgroundImageRepeat, @SiteBackgroundImagePosition, @SiteBackgroundColorTop, @SiteBackgroundColorBottom, @SiteBackgroundImageAttachment);\r\n  }\r\n  .SiteBackground;\r\n\r\n  background-attachment: @SiteBackgroundImageAttachment;\r\n\r\n  color:                @TextColor;\r\n  font-family:          @SiteFontFamily;\r\n  font-size:            1rem;\r\n  font-style:           @SiteFontStyle;\r\n  font-weight:          @SiteFontWeight;\r\n  line-height:          @SiteLineHeight;\r\n  text-align:           @SiteTextAlign;\r\n  text-decoration:      @SiteTextDecoration;\r\n}\r\n\r\n#main {\r\n  background-color:     @SitePageBackgroundColor;\r\n}\r\n\r\n/******************************************************************************\r\n    LINK STYLES\r\n******************************************************************************/\r\n\r\na:link    {color:@LinkColor;}       /* unvisited link */\r\na:visited {color:@LinkColor;}       /* visited link */\r\na:hover   {color:@LinkHoverColor;}  /* mouse over link */\r\n\r\n/******************************************************************************\r\n    TYPOGRAPHY STYLES\r\n******************************************************************************/\r\n\r\nh1 {\r\n\r\n  color:           @H1TextColor;\r\n  line-height:     @H1LineHeight;\r\n  font-family:     @H1FontFamily;\r\n  font-size:       @H1FontSize;\r\n  font-weight:     @H1FontWeight;\r\n  font-style:      @H1FontStyle;\r\n  text-align:      @H1TextAlign;\r\n  text-decoration: @H1TextDecoration;\r\n\r\n}\r\n\r\nh2 {\r\n\r\n  color:           @H2TextColor;\r\n  font-family:     @H2FontFamily;\r\n  font-size:       @H2FontSize;\r\n  font-style:      @H2FontStyle;\r\n  font-weight:     @H2FontWeight;\r\n  line-height:     @H2LineHeight;\r\n  text-align:      @H2TextAlign;\r\n  text-decoration: @H2TextDecoration;\r\n\r\n}\r\n\r\nh3 {\r\n\r\n  color:           @H3TextColor;\r\n  font-family:     @H3FontFamily;\r\n  font-size:       @H3FontSize;\r\n  font-style:      @H3FontStyle;\r\n  font-weight:     @H3FontWeight;\r\n  line-height:     @H3LineHeight;\r\n  text-align:      @H3TextAlign;\r\n  text-decoration: @H3TextDecoration;\r\n\r\n}\r\n\r\nh4 {\r\n\r\n  color:           @H4TextColor;\r\n  font-family:     @H4FontFamily;\r\n  font-size:       @H4FontSize;\r\n  font-style:      @H4FontStyle;\r\n  font-weight:     @H4FontWeight;\r\n  line-height:     @H4LineHeight;\r\n  text-align:      @H4TextAlign;\r\n  text-decoration: @H4TextDecoration;\r\n}\r\n\r\nh5 {\r\n  color:           @H5TextColor;\r\n  font-family:     @H5FontFamily;\r\n  font-size:       @H5FontSize;\r\n  font-style:      @H5FontStyle;\r\n  font-weight:     @H5FontWeight;\r\n  line-height:     @H5LineHeight;\r\n  text-align:      @H5TextAlign;\r\n  text-decoration: @H5TextDecoration;\r\n}\r\n\r\nh6 {\r\n  color:           @H6TextColor;\r\n  font-family:     @H6FontFamily;\r\n  font-size:       @H6FontSize;\r\n  font-style:      @H6FontStyle;\r\n  font-weight:     @H6FontWeight;\r\n  line-height:     @H6LineHeight;\r\n  text-align:      @H6TextAlign;\r\n  text-decoration: @H6TextDecoration;\r\n}\r\n\r\np {\r\n\r\n  color:           @ParagraphTextColor;\r\n  font-family:     @ParagraphFontFamily;\r\n  font-size:       @ParagraphFontSize;\r\n  font-style:      @ParagraphFontStyle;\r\n  font-weight:     @ParagraphFontWeight;\r\n  line-height:     @ParagraphLineHeight;\r\n  text-align:      @ParagraphTextAlign;\r\n  text-decoration: @ParagraphTextDecoration;\r\n\r\n}\r\n\r\n/******************************************************************************\r\n    BUTTON STYLES\r\n******************************************************************************/\r\n\r\n// Primary buttons\r\n.cc-button-primary {\r\n  .ccButton(@ButtonPrimarySize, @ButtonPrimaryBorderRadius,\r\n    @ButtonPrimaryBackgroundColor, @ButtonPrimaryFontFamily,\r\n    @ButtonPrimaryFontWeight, @ButtonPrimaryFontStyle,\r\n    @ButtonPrimaryTextDecoration, @ButtonPrimaryTextColor,\r\n    @ButtonPrimaryUseGradient);\r\n}\r\n\r\n// Secondary buttons\r\n.cc-button-secondary {\r\n  .ccButton(@ButtonSecondarySize, @ButtonSecondaryBorderRadius,\r\n    @ButtonSecondaryBackgroundColor, @ButtonSecondaryFontFamily,\r\n    @ButtonSecondaryFontWeight, @ButtonSecondaryFontStyle,\r\n    @ButtonSecondaryTextDecoration, @ButtonSecondaryTextColor,\r\n    @ButtonSecondaryUseGradient);\r\n}\r\n\r\n/******************************************************************************\r\n    HEADER STYLES\r\n******************************************************************************/\r\n\r\n#region-header #siteHead {\r\n\r\n  background: @HeaderBackgroundColor @HeaderBackgroundImageURL @HeaderBackgroundImagePosition @HeaderBackgroundImageRepeat;\r\n  background-attachment: @HeaderBackgroundImageAttachment;\r\n\r\n  .HeaderBackground() when (@HeaderBackgroundUseGradient) {\r\n    .background-styles (@HeaderBackgroundColor, @HeaderBackgroundImageURL, @HeaderBackgroundImageRepeat, @HeaderBackgroundImagePosition, @HeaderBackgroundColorTop, @HeaderBackgroundColorBottom, @HeaderBackgroundImageAttachment);\r\n  }\r\n  .HeaderBackground;\r\n}\r\n\r\n.header-background {\r\n    background: @HeaderTopBackgroundColor @HeaderTopBackgroundImageURL @HeaderTopBackgroundImagePosition @HeaderTopBackgroundImageRepeat;\r\n  background-attachment: @HeaderTopBackgroundImageAttachment;\r\n\r\n  .HeaderTopBackground() when (@HeaderTopBackgroundUseGradient) {\r\n    .background-styles (@HeaderTopBackgroundColor, @HeaderTopBackgroundImageURL, @HeaderTopBackgroundImageRepeat, @HeaderTopBackgroundImagePosition, @HeaderTopBackgroundColorTop, @HeaderTopBackgroundColorBottom, @HeaderTopBackgroundImageAttachment);\r\n  }\r\n  .HeaderTopBackground;\r\n}\r\n\r\n\r\n/******************************************************************************\r\n    FOOTER STYLES\r\n******************************************************************************/\r\n\r\nfooter.footer {\r\n  background: @FooterBackgroundColor @FooterBackgroundImageURL @FooterBackgroundImagePosition @FooterBackgroundImageRepeat;\r\n  background-attachment: @FooterBackgroundImageAttachment;\r\n\r\n  .FooterBackground() when (@FooterBackgroundUseGradient) {\r\n    .background-styles (@FooterBackgroundColor, @FooterBackgroundImageURL, @FooterBackgroundImageRepeat, @FooterBackgroundImagePosition, @FooterBackgroundColorTop, @FooterBackgroundColorBottom, @FooterBackgroundImageAttachment);\r\n  }\r\n  .FooterBackground;\r\n}\r\n\r\n\r\n\r\n"
    }
}

Example:

{
    "variables":"\n\n/***** Typography *****/\n\n@H1FontFamily : inherit;\n@H1FontSize : 2.75rem;\n@H1FontStyle : inherit;\n@H1FontWeight : bold;\n@H1LineHeight : 100%;\n@H1TextAlign : inherit;\n@H1TextColor : inherit;\n@H1TextDecoration : inherit;\n@H2FontFamily : inherit;\n@H2FontSize : 2.25rem;\n@H2FontStyle : inherit;\n@H2FontWeight : bold;\n@H2LineHeight : inherit;\n@H2TextAlign : inherit;\n@H2TextColor : inherit;\n@H2TextDecoration : inherit;\n@H3FontFamily : inherit;\n@H3FontSize : 1.75rem;\n@H3FontStyle : inherit;\n@H3FontWeight : bold;\n@H3LineHeight : inherit;\n@H3TextAlign : inherit;\n@H3TextColor : inherit;\n@H3TextDecoration : inherit;\n@H4FontFamily : inherit;\n@H4FontSize : 1.25rem;\n@H4FontStyle : inherit;\n@H4FontWeight : bold;\n@H4LineHeight : inherit;\n@H4TextAlign : inherit;\n@H4TextColor : inherit;\n@H4TextDecoration : inherit;\n@H5FontFamily : inherit;\n@H5FontSize : 1.00rem;\n@H5FontStyle : inherit;\n@H5FontWeight : normal;\n@H5LineHeight : inherit;\n@H5TextAlign : inherit;\n@H5TextColor : inherit;\n@H5TextDecoration : inherit;\n@H6FontFamily : inherit;\n@H6FontSize : 0.85rem;\n@H6FontStyle : inherit;\n@H6FontWeight : normal;\n@H6LineHeight : inherit;\n@H6TextAlign : inherit;\n@H6TextColor : inherit;\n@H6TextDecoration : inherit;\n@ParagraphFontFamily : inherit;\n@ParagraphFontSize : 1.00rem;\n@ParagraphFontStyle : inherit;\n@ParagraphFontWeight : normal;\n@ParagraphLineHeight : inherit;\n@ParagraphTextAlign : inherit;\n@ParagraphTextColor : inherit;\n@ParagraphTextDecoration : inherit;\n@SiteFontFamily : @sansFontFamily;\n@SiteFontSize : 14px;\n@SiteFontStyle : normal;\n@SiteFontWeight : normal;\n@SiteLineHeight : 150%;\n@SiteTextAlign : left;\n@SiteTextColor : #333;\n@SiteTextDecoration : none;\n\n\n/***** Colors *****/\n\n@ButtonPrimaryBackgroundColor : #195d8e;\n@ButtonPrimaryBorderRadius : 4px;\n@ButtonPrimaryFontFamily : @sansFontFamily;\n@ButtonPrimaryFontStyle : normal;\n@ButtonPrimaryFontWeight : normal;\n@ButtonPrimarySize : medium;\n@ButtonPrimaryTextColor : #ffffff;\n@ButtonPrimaryTextDecoration : none;\n@ButtonPrimaryUseGradient : false;\n@ButtonSecondaryBackgroundColor : #f7f7f7;\n@ButtonSecondaryBorderRadius : 4px;\n@ButtonSecondaryFontFamily : @sansFontFamily;\n@ButtonSecondaryFontStyle : normal;\n@ButtonSecondaryFontWeight : normal;\n@ButtonSecondarySize : medium;\n@ButtonSecondaryTextColor : #3d3d3e;\n@ButtonSecondaryTextDecoration : none;\n@ButtonSecondaryUseGradient : false;\n@LinkColor : #195d8d;\n@LinkHoverColor : #114062;\n@NavbarBackgroundColor : #fff;\n@NavbarBackgroundHoverColor : #fff;\n@NavbarLinkColor : #3D3D3D;\n@NavbarLinkHoverColor : #195D8D;\n@NavbarTextColor : #333333;\n@NavigationBackgroundColor : #FFF;\n@NavigationBackgroundColorBottom : #FFF;\n@NavigationBackgroundColorTop : #FFF;\n@NavigationBackgroundImageAttachment : scroll;\n@NavigationBackgroundImagePosition : top left;\n@NavigationBackgroundImageRepeat : no-repeat;\n@NavigationBackgroundImageURL : none;\n@NavigationBackgroundUseGradient : false;\n@NavigationPageBackgroundColor : #FFF;\n@SubNavigationBackgroundColor : #fff;\n@SubNavigationBackgroundHoverColor : #FFF;\n@SubNavigationLinkColor : #3D3D3D;\n@SubNavigationLinkHoverColor : #195D8D;\n@SubNavigationTextColor : #6F7178;\n@TextColor : #333;\n\n\n/***** General *****/\n\n@FooterBackgroundColor : none;\n@FooterBackgroundColorBottom : #FFF;\n@FooterBackgroundColorTop : #FFF;\n@FooterBackgroundImageAttachment : scroll;\n@FooterBackgroundImagePosition : top left;\n@FooterBackgroundImageRepeat : repeat-x;\n@FooterBackgroundImageURL : none;\n@FooterBackgroundUseGradient : false;\n@FooterBorderTopColor : #bcd7e6;\n@HeaderBackgroundColor : #FFF;\n@HeaderBackgroundColorBottom : #FFF;\n@HeaderBackgroundColorTop : #FFF;\n@HeaderBackgroundImageAttachment : scroll;\n@HeaderBackgroundImagePosition : bottom center;\n@HeaderBackgroundImageRepeat : repeat-x;\n@HeaderBackgroundImageURL : url(/img/header-btm-line.png);\n@HeaderBackgroundUseGradient : false;\n@HeaderTopBackgroundColor : #F5F5F5;\n@HeaderTopBackgroundColorBottom : #FFF;\n@HeaderTopBackgroundColorTop : #FFF;\n@HeaderTopBackgroundImageAttachment : scroll;\n@HeaderTopBackgroundImagePosition : top left;\n@HeaderTopBackgroundImageRepeat : repeat-x;\n@HeaderTopBackgroundImageURL : url(/img/header-wrap.png);\n@HeaderTopBackgroundUseGradient : false;\n@HeaderTopBorderBottomColor : #bcd7e6;\n@HeaderTopPaddingTop : 25px;\n@SiteBackgroundColor : #FFF;\n@SiteBackgroundColorBottom : #FFF;\n@SiteBackgroundColorTop : #FFF;\n@SiteBackgroundImageAttachment : scroll;\n@SiteBackgroundImagePosition : top left;\n@SiteBackgroundImageRepeat : no-repeat;\n@SiteBackgroundImageURL : url(/file/media/sitestudio/Clocks-v2-05.png);\n@SiteBackgroundUseGradient : false;\n@SitePageBackgroundColor : #FFF;\n",
    "styles":"/******************************************************************************\r\n    MIXINS\r\n******************************************************************************/\r\n.background-styles (@BackgroundColor, @BackgroundImageURL, @BackgroundImageRepeat, @BackgroundImagePosition, @BackgroundColorTop, @BackgroundColorBottom, @BackgroundImageAttachment) {\r\n\r\n  background: @BackgroundImageURL @BackgroundImagePosition @BackgroundImageRepeat, -moz-linear-gradient(top, @BackgroundColorTop 0%, @BackgroundColorBottom 100%);\r\n  background: @BackgroundImageURL @BackgroundImagePosition @BackgroundImageRepeat, -webkit-gradient(linear, left top, left bottom, color-stop(0%,@BackgroundColorTop), color-stop(100%,@BackgroundColorBottom));\r\n  filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='@BackgroundColorTop', endColorstr='@BackgroundColorBottom',GradientType=0 );\r\n}\r\n\r\n/******************************************************************************\r\n    GENERAL STYLES\r\n******************************************************************************/\r\nhtml {\r\n  font-size:            @SiteFontSize;\r\n}\r\n\r\nbody {\r\n\r\n  background: @SiteBackgroundColor @SiteBackgroundImageURL @SiteBackgroundImagePosition @SiteBackgroundImageRepeat;\r\n\r\n  .SiteBackground() when (@SiteBackgroundUseGradient) {\r\n    .background-styles (@SiteBackgroundColor, @SiteBackgroundImageURL, @SiteBackgroundImageRepeat, @SiteBackgroundImagePosition, @SiteBackgroundColorTop, @SiteBackgroundColorBottom, @SiteBackgroundImageAttachment);\r\n  }\r\n  .SiteBackground;\r\n\r\n  background-attachment: @SiteBackgroundImageAttachment;\r\n\r\n  color:                @TextColor;\r\n  font-family:          @SiteFontFamily;\r\n  font-size:            1rem;\r\n  font-style:           @SiteFontStyle;\r\n  font-weight:          @SiteFontWeight;\r\n  line-height:          @SiteLineHeight;\r\n  text-align:           @SiteTextAlign;\r\n  text-decoration:      @SiteTextDecoration;\r\n}\r\n\r\n#main {\r\n  background-color:     @SitePageBackgroundColor;\r\n}\r\n\r\n/******************************************************************************\r\n    LINK STYLES\r\n******************************************************************************/\r\n\r\na:link    {color:@LinkColor;}       /* unvisited link */\r\na:visited {color:@LinkColor;}       /* visited link */\r\na:hover   {color:@LinkHoverColor;}  /* mouse over link */\r\n\r\n/******************************************************************************\r\n    TYPOGRAPHY STYLES\r\n******************************************************************************/\r\n\r\nh1 {\r\n\r\n  color:           @H1TextColor;\r\n  line-height:     @H1LineHeight;\r\n  font-family:     @H1FontFamily;\r\n  font-size:       @H1FontSize;\r\n  font-weight:     @H1FontWeight;\r\n  font-style:      @H1FontStyle;\r\n  text-align:      @H1TextAlign;\r\n  text-decoration: @H1TextDecoration;\r\n\r\n}\r\n\r\nh2 {\r\n\r\n  color:           @H2TextColor;\r\n  font-family:     @H2FontFamily;\r\n  font-size:       @H2FontSize;\r\n  font-style:      @H2FontStyle;\r\n  font-weight:     @H2FontWeight;\r\n  line-height:     @H2LineHeight;\r\n  text-align:      @H2TextAlign;\r\n  text-decoration: @H2TextDecoration;\r\n\r\n}\r\n\r\nh3 {\r\n\r\n  color:           @H3TextColor;\r\n  font-family:     @H3FontFamily;\r\n  font-size:       @H3FontSize;\r\n  font-style:      @H3FontStyle;\r\n  font-weight:     @H3FontWeight;\r\n  line-height:     @H3LineHeight;\r\n  text-align:      @H3TextAlign;\r\n  text-decoration: @H3TextDecoration;\r\n\r\n}\r\n\r\nh4 {\r\n\r\n  color:           @H4TextColor;\r\n  font-family:     @H4FontFamily;\r\n  font-size:       @H4FontSize;\r\n  font-style:      @H4FontStyle;\r\n  font-weight:     @H4FontWeight;\r\n  line-height:     @H4LineHeight;\r\n  text-align:      @H4TextAlign;\r\n  text-decoration: @H4TextDecoration;\r\n}\r\n\r\nh5 {\r\n  color:           @H5TextColor;\r\n  font-family:     @H5FontFamily;\r\n  font-size:       @H5FontSize;\r\n  font-style:      @H5FontStyle;\r\n  font-weight:     @H5FontWeight;\r\n  line-height:     @H5LineHeight;\r\n  text-align:      @H5TextAlign;\r\n  text-decoration: @H5TextDecoration;\r\n}\r\n\r\nh6 {\r\n  color:           @H6TextColor;\r\n  font-family:     @H6FontFamily;\r\n  font-size:       @H6FontSize;\r\n  font-style:      @H6FontStyle;\r\n  font-weight:     @H6FontWeight;\r\n  line-height:     @H6LineHeight;\r\n  text-align:      @H6TextAlign;\r\n  text-decoration: @H6TextDecoration;\r\n}\r\n\r\np {\r\n\r\n  color:           @ParagraphTextColor;\r\n  font-family:     @ParagraphFontFamily;\r\n  font-size:       @ParagraphFontSize;\r\n  font-style:      @ParagraphFontStyle;\r\n  font-weight:     @ParagraphFontWeight;\r\n  line-height:     @ParagraphLineHeight;\r\n  text-align:      @ParagraphTextAlign;\r\n  text-decoration: @ParagraphTextDecoration;\r\n\r\n}\r\n\r\n/******************************************************************************\r\n    BUTTON STYLES\r\n******************************************************************************/\r\n\r\n// Primary buttons\r\n.cc-button-primary {\r\n  .ccButton(@ButtonPrimarySize, @ButtonPrimaryBorderRadius,\r\n    @ButtonPrimaryBackgroundColor, @ButtonPrimaryFontFamily,\r\n    @ButtonPrimaryFontWeight, @ButtonPrimaryFontStyle,\r\n    @ButtonPrimaryTextDecoration, @ButtonPrimaryTextColor,\r\n    @ButtonPrimaryUseGradient);\r\n}\r\n\r\n// Secondary buttons\r\n.cc-button-secondary {\r\n  .ccButton(@ButtonSecondarySize, @ButtonSecondaryBorderRadius,\r\n    @ButtonSecondaryBackgroundColor, @ButtonSecondaryFontFamily,\r\n    @ButtonSecondaryFontWeight, @ButtonSecondaryFontStyle,\r\n    @ButtonSecondaryTextDecoration, @ButtonSecondaryTextColor,\r\n    @ButtonSecondaryUseGradient);\r\n}\r\n\r\n/******************************************************************************\r\n    HEADER STYLES\r\n******************************************************************************/\r\n\r\n#region-header #siteHead {\r\n\r\n  background: @HeaderBackgroundColor @HeaderBackgroundImageURL @HeaderBackgroundImagePosition @HeaderBackgroundImageRepeat;\r\n  background-attachment: @HeaderBackgroundImageAttachment;\r\n\r\n  .HeaderBackground() when (@HeaderBackgroundUseGradient) {\r\n    .background-styles (@HeaderBackgroundColor, @HeaderBackgroundImageURL, @HeaderBackgroundImageRepeat, @HeaderBackgroundImagePosition, @HeaderBackgroundColorTop, @HeaderBackgroundColorBottom, @HeaderBackgroundImageAttachment);\r\n  }\r\n  .HeaderBackground;\r\n}\r\n\r\n.header-background {\r\n    background: @HeaderTopBackgroundColor @HeaderTopBackgroundImageURL @HeaderTopBackgroundImagePosition @HeaderTopBackgroundImageRepeat;\r\n  background-attachment: @HeaderTopBackgroundImageAttachment;\r\n\r\n  .HeaderTopBackground() when (@HeaderTopBackgroundUseGradient) {\r\n    .background-styles (@HeaderTopBackgroundColor, @HeaderTopBackgroundImageURL, @HeaderTopBackgroundImageRepeat, @HeaderTopBackgroundImagePosition, @HeaderTopBackgroundColorTop, @HeaderTopBackgroundColorBottom, @HeaderTopBackgroundImageAttachment);\r\n  }\r\n  .HeaderTopBackground;\r\n}\r\n\r\n\r\n/******************************************************************************\r\n    FOOTER STYLES\r\n******************************************************************************/\r\n\r\nfooter.footer {\r\n  background: @FooterBackgroundColor @FooterBackgroundImageURL @FooterBackgroundImagePosition @FooterBackgroundImageRepeat;\r\n  background-attachment: @FooterBackgroundImageAttachment;\r\n\r\n  .FooterBackground() when (@FooterBackgroundUseGradient) {\r\n    .background-styles (@FooterBackgroundColor, @FooterBackgroundImageURL, @FooterBackgroundImageRepeat, @FooterBackgroundImagePosition, @FooterBackgroundColorTop, @FooterBackgroundColorBottom, @FooterBackgroundImageAttachment);\r\n  }\r\n  .FooterBackground;\r\n}\r\n\r\n\r\n\r\n"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returned when the operation succeeds.

Body ()

Root Schema : updateThemeSource_response

Type: object

Show Source

• styles(optional): string
  The theme styles LESS code.
• variables(optional): string
  The theme variables LESS code.

{
    "properties":{
        "variables":{
            "description":"The theme variables LESS code.",
            "type":"string"
        },
        "styles":{
            "description":"The theme styles LESS code.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "variables":"\n\n/***** Typography *****/\n\n@H1FontFamily : inherit;\n@H1FontSize : 2.75rem;\n@H1FontStyle : inherit;\n@H1FontWeight : bold;\n@H1LineHeight : 100%;\n@H1TextAlign : inherit;\n@H1TextColor : inherit;\n@H1TextDecoration : inherit;\n@H2FontFamily : inherit;\n@H2FontSize : 2.25rem;\n@H2FontStyle : inherit;\n@H2FontWeight : bold;\n@H2LineHeight : inherit;\n@H2TextAlign : inherit;\n@H2TextColor : inherit;\n@H2TextDecoration : inherit;\n@H3FontFamily : inherit;\n@H3FontSize : 1.75rem;\n@H3FontStyle : inherit;\n@H3FontWeight : bold;\n@H3LineHeight : inherit;\n@H3TextAlign : inherit;\n@H3TextColor : inherit;\n@H3TextDecoration : inherit;\n@H4FontFamily : inherit;\n@H4FontSize : 1.25rem;\n@H4FontStyle : inherit;\n@H4FontWeight : bold;\n@H4LineHeight : inherit;\n@H4TextAlign : inherit;\n@H4TextColor : inherit;\n@H4TextDecoration : inherit;\n@H5FontFamily : inherit;\n@H5FontSize : 1.00rem;\n@H5FontStyle : inherit;\n@H5FontWeight : normal;\n@H5LineHeight : inherit;\n@H5TextAlign : inherit;\n@H5TextColor : inherit;\n@H5TextDecoration : inherit;\n@H6FontFamily : inherit;\n@H6FontSize : 0.85rem;\n@H6FontStyle : inherit;\n@H6FontWeight : normal;\n@H6LineHeight : inherit;\n@H6TextAlign : inherit;\n@H6TextColor : inherit;\n@H6TextDecoration : inherit;\n@ParagraphFontFamily : inherit;\n@ParagraphFontSize : 1.00rem;\n@ParagraphFontStyle : inherit;\n@ParagraphFontWeight : normal;\n@ParagraphLineHeight : inherit;\n@ParagraphTextAlign : inherit;\n@ParagraphTextColor : inherit;\n@ParagraphTextDecoration : inherit;\n@SiteFontFamily : @sansFontFamily;\n@SiteFontSize : 14px;\n@SiteFontStyle : normal;\n@SiteFontWeight : normal;\n@SiteLineHeight : 150%;\n@SiteTextAlign : left;\n@SiteTextColor : #333;\n@SiteTextDecoration : none;\n\n\n/***** Colors *****/\n\n@ButtonPrimaryBackgroundColor : #195d8e;\n@ButtonPrimaryBorderRadius : 4px;\n@ButtonPrimaryFontFamily : @sansFontFamily;\n@ButtonPrimaryFontStyle : normal;\n@ButtonPrimaryFontWeight : normal;\n@ButtonPrimarySize : medium;\n@ButtonPrimaryTextColor : #ffffff;\n@ButtonPrimaryTextDecoration : none;\n@ButtonPrimaryUseGradient : false;\n@ButtonSecondaryBackgroundColor : #f7f7f7;\n@ButtonSecondaryBorderRadius : 4px;\n@ButtonSecondaryFontFamily : @sansFontFamily;\n@ButtonSecondaryFontStyle : normal;\n@ButtonSecondaryFontWeight : normal;\n@ButtonSecondarySize : medium;\n@ButtonSecondaryTextColor : #3d3d3e;\n@ButtonSecondaryTextDecoration : none;\n@ButtonSecondaryUseGradient : false;\n@LinkColor : #195d8d;\n@LinkHoverColor : #114062;\n@NavbarBackgroundColor : #fff;\n@NavbarBackgroundHoverColor : #fff;\n@NavbarLinkColor : #3D3D3D;\n@NavbarLinkHoverColor : #195D8D;\n@NavbarTextColor : #333333;\n@NavigationBackgroundColor : #FFF;\n@NavigationBackgroundColorBottom : #FFF;\n@NavigationBackgroundColorTop : #FFF;\n@NavigationBackgroundImageAttachment : scroll;\n@NavigationBackgroundImagePosition : top left;\n@NavigationBackgroundImageRepeat : no-repeat;\n@NavigationBackgroundImageURL : none;\n@NavigationBackgroundUseGradient : false;\n@NavigationPageBackgroundColor : #FFF;\n@SubNavigationBackgroundColor : #fff;\n@SubNavigationBackgroundHoverColor : #FFF;\n@SubNavigationLinkColor : #3D3D3D;\n@SubNavigationLinkHoverColor : #195D8D;\n@SubNavigationTextColor : #6F7178;\n@TextColor : #333;\n\n\n/***** General *****/\n\n@FooterBackgroundColor : none;\n@FooterBackgroundColorBottom : #FFF;\n@FooterBackgroundColorTop : #FFF;\n@FooterBackgroundImageAttachment : scroll;\n@FooterBackgroundImagePosition : top left;\n@FooterBackgroundImageRepeat : repeat-x;\n@FooterBackgroundImageURL : none;\n@FooterBackgroundUseGradient : false;\n@FooterBorderTopColor : #bcd7e6;\n@HeaderBackgroundColor : #FFF;\n@HeaderBackgroundColorBottom : #FFF;\n@HeaderBackgroundColorTop : #FFF;\n@HeaderBackgroundImageAttachment : scroll;\n@HeaderBackgroundImagePosition : bottom center;\n@HeaderBackgroundImageRepeat : repeat-x;\n@HeaderBackgroundImageURL : url(/img/header-btm-line.png);\n@HeaderBackgroundUseGradient : false;\n@HeaderTopBackgroundColor : #F5F5F5;\n@HeaderTopBackgroundColorBottom : #FFF;\n@HeaderTopBackgroundColorTop : #FFF;\n@HeaderTopBackgroundImageAttachment : scroll;\n@HeaderTopBackgroundImagePosition : top left;\n@HeaderTopBackgroundImageRepeat : repeat-x;\n@HeaderTopBackgroundImageURL : url(/img/header-wrap.png);\n@HeaderTopBackgroundUseGradient : false;\n@HeaderTopBorderBottomColor : #bcd7e6;\n@HeaderTopPaddingTop : 25px;\n@SiteBackgroundColor : #FFF;\n@SiteBackgroundColorBottom : #FFF;\n@SiteBackgroundColorTop : #FFF;\n@SiteBackgroundImageAttachment : scroll;\n@SiteBackgroundImagePosition : top left;\n@SiteBackgroundImageRepeat : no-repeat;\n@SiteBackgroundImageURL : url(/file/media/sitestudio/Clocks-v2-05.png);\n@SiteBackgroundUseGradient : false;\n@SitePageBackgroundColor : #FFF;\n",
    "styles":"/******************************************************************************\r\n    MIXINS\r\n******************************************************************************/\r\n.background-styles (@BackgroundColor, @BackgroundImageURL, @BackgroundImageRepeat, @BackgroundImagePosition, @BackgroundColorTop, @BackgroundColorBottom, @BackgroundImageAttachment) {\r\n\r\n  background: @BackgroundImageURL @BackgroundImagePosition @BackgroundImageRepeat, -moz-linear-gradient(top, @BackgroundColorTop 0%, @BackgroundColorBottom 100%);\r\n  background: @BackgroundImageURL @BackgroundImagePosition @BackgroundImageRepeat, -webkit-gradient(linear, left top, left bottom, color-stop(0%,@BackgroundColorTop), color-stop(100%,@BackgroundColorBottom));\r\n  filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='@BackgroundColorTop', endColorstr='@BackgroundColorBottom',GradientType=0 );\r\n}\r\n\r\n/******************************************************************************\r\n    GENERAL STYLES\r\n******************************************************************************/\r\nhtml {\r\n  font-size:            @SiteFontSize;\r\n}\r\n\r\nbody {\r\n\r\n  background: @SiteBackgroundColor @SiteBackgroundImageURL @SiteBackgroundImagePosition @SiteBackgroundImageRepeat;\r\n\r\n  .SiteBackground() when (@SiteBackgroundUseGradient) {\r\n    .background-styles (@SiteBackgroundColor, @SiteBackgroundImageURL, @SiteBackgroundImageRepeat, @SiteBackgroundImagePosition, @SiteBackgroundColorTop, @SiteBackgroundColorBottom, @SiteBackgroundImageAttachment);\r\n  }\r\n  .SiteBackground;\r\n\r\n  background-attachment: @SiteBackgroundImageAttachment;\r\n\r\n  color:                @TextColor;\r\n  font-family:          @SiteFontFamily;\r\n  font-size:            1rem;\r\n  font-style:           @SiteFontStyle;\r\n  font-weight:          @SiteFontWeight;\r\n  line-height:          @SiteLineHeight;\r\n  text-align:           @SiteTextAlign;\r\n  text-decoration:      @SiteTextDecoration;\r\n}\r\n\r\n#main {\r\n  background-color:     @SitePageBackgroundColor;\r\n}\r\n\r\n/******************************************************************************\r\n    LINK STYLES\r\n******************************************************************************/\r\n\r\na:link    {color:@LinkColor;}       /* unvisited link */\r\na:visited {color:@LinkColor;}       /* visited link */\r\na:hover   {color:@LinkHoverColor;}  /* mouse over link */\r\n\r\n/******************************************************************************\r\n    TYPOGRAPHY STYLES\r\n******************************************************************************/\r\n\r\nh1 {\r\n\r\n  color:           @H1TextColor;\r\n  line-height:     @H1LineHeight;\r\n  font-family:     @H1FontFamily;\r\n  font-size:       @H1FontSize;\r\n  font-weight:     @H1FontWeight;\r\n  font-style:      @H1FontStyle;\r\n  text-align:      @H1TextAlign;\r\n  text-decoration: @H1TextDecoration;\r\n\r\n}\r\n\r\nh2 {\r\n\r\n  color:           @H2TextColor;\r\n  font-family:     @H2FontFamily;\r\n  font-size:       @H2FontSize;\r\n  font-style:      @H2FontStyle;\r\n  font-weight:     @H2FontWeight;\r\n  line-height:     @H2LineHeight;\r\n  text-align:      @H2TextAlign;\r\n  text-decoration: @H2TextDecoration;\r\n\r\n}\r\n\r\nh3 {\r\n\r\n  color:           @H3TextColor;\r\n  font-family:     @H3FontFamily;\r\n  font-size:       @H3FontSize;\r\n  font-style:      @H3FontStyle;\r\n  font-weight:     @H3FontWeight;\r\n  line-height:     @H3LineHeight;\r\n  text-align:      @H3TextAlign;\r\n  text-decoration: @H3TextDecoration;\r\n\r\n}\r\n\r\nh4 {\r\n\r\n  color:           @H4TextColor;\r\n  font-family:     @H4FontFamily;\r\n  font-size:       @H4FontSize;\r\n  font-style:      @H4FontStyle;\r\n  font-weight:     @H4FontWeight;\r\n  line-height:     @H4LineHeight;\r\n  text-align:      @H4TextAlign;\r\n  text-decoration: @H4TextDecoration;\r\n}\r\n\r\nh5 {\r\n  color:           @H5TextColor;\r\n  font-family:     @H5FontFamily;\r\n  font-size:       @H5FontSize;\r\n  font-style:      @H5FontStyle;\r\n  font-weight:     @H5FontWeight;\r\n  line-height:     @H5LineHeight;\r\n  text-align:      @H5TextAlign;\r\n  text-decoration: @H5TextDecoration;\r\n}\r\n\r\nh6 {\r\n  color:           @H6TextColor;\r\n  font-family:     @H6FontFamily;\r\n  font-size:       @H6FontSize;\r\n  font-style:      @H6FontStyle;\r\n  font-weight:     @H6FontWeight;\r\n  line-height:     @H6LineHeight;\r\n  text-align:      @H6TextAlign;\r\n  text-decoration: @H6TextDecoration;\r\n}\r\n\r\np {\r\n\r\n  color:           @ParagraphTextColor;\r\n  font-family:     @ParagraphFontFamily;\r\n  font-size:       @ParagraphFontSize;\r\n  font-style:      @ParagraphFontStyle;\r\n  font-weight:     @ParagraphFontWeight;\r\n  line-height:     @ParagraphLineHeight;\r\n  text-align:      @ParagraphTextAlign;\r\n  text-decoration: @ParagraphTextDecoration;\r\n\r\n}\r\n\r\n/******************************************************************************\r\n    BUTTON STYLES\r\n******************************************************************************/\r\n\r\n// Primary buttons\r\n.cc-button-primary {\r\n  .ccButton(@ButtonPrimarySize, @ButtonPrimaryBorderRadius,\r\n    @ButtonPrimaryBackgroundColor, @ButtonPrimaryFontFamily,\r\n    @ButtonPrimaryFontWeight, @ButtonPrimaryFontStyle,\r\n    @ButtonPrimaryTextDecoration, @ButtonPrimaryTextColor,\r\n    @ButtonPrimaryUseGradient);\r\n}\r\n\r\n// Secondary buttons\r\n.cc-button-secondary {\r\n  .ccButton(@ButtonSecondarySize, @ButtonSecondaryBorderRadius,\r\n    @ButtonSecondaryBackgroundColor, @ButtonSecondaryFontFamily,\r\n    @ButtonSecondaryFontWeight, @ButtonSecondaryFontStyle,\r\n    @ButtonSecondaryTextDecoration, @ButtonSecondaryTextColor,\r\n    @ButtonSecondaryUseGradient);\r\n}\r\n\r\n/******************************************************************************\r\n    HEADER STYLES\r\n******************************************************************************/\r\n\r\n#region-header #siteHead {\r\n\r\n  background: @HeaderBackgroundColor @HeaderBackgroundImageURL @HeaderBackgroundImagePosition @HeaderBackgroundImageRepeat;\r\n  background-attachment: @HeaderBackgroundImageAttachment;\r\n\r\n  .HeaderBackground() when (@HeaderBackgroundUseGradient) {\r\n    .background-styles (@HeaderBackgroundColor, @HeaderBackgroundImageURL, @HeaderBackgroundImageRepeat, @HeaderBackgroundImagePosition, @HeaderBackgroundColorTop, @HeaderBackgroundColorBottom, @HeaderBackgroundImageAttachment);\r\n  }\r\n  .HeaderBackground;\r\n}\r\n\r\n.header-background {\r\n    background: @HeaderTopBackgroundColor @HeaderTopBackgroundImageURL @HeaderTopBackgroundImagePosition @HeaderTopBackgroundImageRepeat;\r\n  background-attachment: @HeaderTopBackgroundImageAttachment;\r\n\r\n  .HeaderTopBackground() when (@HeaderTopBackgroundUseGradient) {\r\n    .background-styles (@HeaderTopBackgroundColor, @HeaderTopBackgroundImageURL, @HeaderTopBackgroundImageRepeat, @HeaderTopBackgroundImagePosition, @HeaderTopBackgroundColorTop, @HeaderTopBackgroundColorBottom, @HeaderTopBackgroundImageAttachment);\r\n  }\r\n  .HeaderTopBackground;\r\n}\r\n\r\n\r\n/******************************************************************************\r\n    FOOTER STYLES\r\n******************************************************************************/\r\n\r\nfooter.footer {\r\n  background: @FooterBackgroundColor @FooterBackgroundImageURL @FooterBackgroundImagePosition @FooterBackgroundImageRepeat;\r\n  background-attachment: @FooterBackgroundImageAttachment;\r\n\r\n  .FooterBackground() when (@FooterBackgroundUseGradient) {\r\n    .background-styles (@FooterBackgroundColor, @FooterBackgroundImageURL, @FooterBackgroundImageRepeat, @FooterBackgroundImagePosition, @FooterBackgroundColorTop, @FooterBackgroundColorBottom, @FooterBackgroundImageAttachment);\r\n  }\r\n  .FooterBackground;\r\n}\r\n\r\n\r\n\r\n"
}

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 further information.
70018	Internam error updating theme.	See returned error messages for more information.
70025	Error compiling less file due to syntax	Ensure the syntax of the uploaded source code is correct.
70026	No agent theme exists on the system.	An agent theme needs to be created.

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