themeSetting

URI

<themes_uri>/{name}[.<format>]

支持的方法

GET、PUT、HEAD

父资源

themes

介绍

iPortal 某种主题风格的具体配置资源。iPortal 的主题风格是指导航栏、侧边栏、页脚、按钮等全站通用的 UI 组件的前景/背景色。

支持的方法：

支持的表述格式：JSON。

资源层次

HTTP 请求方法

对如下 URI 执行 HTTP 请求，以 json 输出格式为例加以说明，其中，supermapiportal 是服务器名。

http://supermapiportal:8190/iportal/web/uiconfig/themes/{name}.json

GET 请求

获取指定的 iPortal 主题风格配置。

响应结构

iPortal 主题风格的配置包括以下字段：

字段 类型 说明
header String 导航栏的主题风格。
resourceHeader String 资源中心二级导航栏的主题风格。
resourceAside String 资源中心侧边栏的主题风格。
body String 页面主体的主题风格。
button String 按钮的主题风格。
footer String 页脚的主题风格。

响应示例

对 themeSetting 资源：http://localhost:8190/iportal/web/uiconfig/themes/ThemeSetting_blue.json 执行 GET 请求，返回的 json 格式的资源表述如下：

{

    "themeSetting":{

        "header":{

            "backgroundColor":"rgb(255, 255, 255)",

            "color":"rgb(51, 51, 51)",

            "hoverBackgroundColor":"#efefef",

            "hoverMenuFontColor":"#0161b7",

            "hoverLoginFontColor":"#0161b7"

        },

        "resourceHeader":{

            "backgroundImage": "{webUiRoot}reaource-center-img/banner-map.png",

            "backgroundColor": "#ffffff",

            "color":"#ffffff",

            "hoverBannerFontColor":"#ffffff"

        },

        "resourceAside":{

            "borderColor": "#E5E5E5",

            "activeBackgroundColor": "#f4f4f4"

        },

        "body":{

            "backgroundColor":"#f4f4f4"

        },

        "button":{

            "primaryColor":"#127fdc",

            "textColor":"rgba(0, 0, 0, .65)",

            "borderColorBase": "#d9d9d9"

        },

        "footer":{

            "backgroundColor": "rgb(255, 255, 255)",

            "color":"rgb(51, 51, 51)",

            "borderColor":"#f4f4f4"

        }

    }

}

PUT 请求

修改指定的 iPortal 主题风格。

请求参数

发送请求时，需要在请求体中传递如下参数：

名称 类型 含义
header String 导航栏的主题风格。
resourceHeader String 资源中心二级导航栏的主题风格。
resourceAside String 资源中心侧边栏的主题风格。
body String 页面主体的主题风格。
button String 按钮的主题风格。
footer String 页脚的主题风格。

响应结构

返回的资源表述结构如下：

字段 类型 说明
succeed boolean 修改主题风格是否成功。
error HttpError 出错信息，如果修改成功，则没有本字段。

响应示例

修改 iPortal 中全站主题风格，对 themeSetting 资源：http://localhost/iportal/web/uiconfig/themes/ThemeSetting_blue.json 执行 PUT 请求，发送请求体如下：

{

    "themeSetting": {

        "header": {

            "backgroundColor": "#181818",

            "color": "#ffffff",

            "hoverBackgroundColor": "#3E3D3D",

            "hoverMenuFontColor": "#ffffff",

            "hoverLoginFontColor": "#FB6800"

        },

        "resourceHeader": {

            "backgroundImage": "",

            "backgroundColor": "#ffffff",

            "color": "rgb(51, 51, 51)",

            "hoverBannerFontColor": "#FB6800"

        },

        "resourceAside": {

            "borderColor": "#E5E5E5",

            "activeBackgroundColor": "#FFF0E6"

        },

        "body": {

            "backgroundColor": "#f4f4f4"

        },

        "button": {

            "primaryColor": "#FB6800",

            "textColor": "rgba(0, 0, 0, .65)",

            "borderColorBase": "#d9d9d9"

        },

        "footer": {

            "backgroundColor": "#333333",

            "color": "#999999",

            "borderColor": "#FB6800"

        }

    }

}

则返回的 json 格式的资源表述如下：

{"succeed": true}

HEAD 请求

返回跟 GET 请求一样的 HTTP 响应头，但是没有响应实体。可以在不必传输整个响应内容的情况下，获取包含在响应消息头中的元数据信息。元数据信息包括媒体类型，字符编码，压缩编码，实体内容长度等。

HEAD 请求可以用来判断 themeSetting 资源是否存在，或者客户端是否有权限访问 themeSetting 资源。通过对加.<format>的 URI 执行 HEAD 请求，还可以快速判断 themeSetting 资源是否支持<format>格式的表述。

请参见