URI
<uiConfig_uri>/commonsetting[.<format>]
Supported Methods
Parent Resource
Introduction
The site-wide common UI configuration resource. The common UI components in iPortal include the navigation bar, menu items, footer, etc.
Supported Methods:
- GET: Retrieve the site-wide common UI configuration in iPortal.
- PUT: Modify the site-wide common UI configuration in iPortal.
- HEAD: Check whether the commonSetting resource exists, or whether the permission can access the commonSetting resource.
Supported output formats: JSON.
Resource hierarchy
HTTP Request Method
Perform an HTTP request on the following URI. The json output format is used as an example, where supermapiportal is the server name.
http://supermapiportal:8190/iportal/web/uiconfig/commonsetting.json
GET Request
Retrieve the site-wide common UI configuration in iPortal.
Request Parameters
By setting the parameters, the UI configuration for the specified language will be returned. Request parameters must be included in the URI.
| Name | Type | Description |
| language | String | The language version of the configuration. Currently supports zh (Chinese) and en (English). |
Response Structure
The site-wide common UI configuration of iPortal consists of the following fields:
| Field | Type | Description |
| common | String | Common configuration. |
| header | String | Navigation bar configuration. |
| footer | String | Footer configuration. |
| languageConfig | String | Language configuration. |
| menus | String | Navigation bar menu configuration. |
Response Example
Perform a GET request on the commonSetting resource: http://localhost:8190/iportal/web/uiconfig/commonsetting.json. The returned json representation is as follows:
{
"common": {
"app": true,
"subTitle": "SuperMap iPortal 10i",
"beta": " ",
"desc": "You can easily customize almost all content on the portal homepage. For customization methods, see"
},
"footer": {
"title": "Powered by SuperMap iPortal 10i (10.0.0-linux64) © 2000-2026 BeijingSuperMapSoftware Co., Ltd."
},
"header": {
"isShowHelp": true,
"logo": "{webUiRoot}homePageImg/iportal_logo.svg",
"title": ""
},
"languageConfig": {
"language": [
{
"identity": "zh",
"title": "Chinese"
},
{
"identity": "en",
"title": "English"
}
],
"defaultLan": "zh"
},
"menus": [
{
"isCustomColumn": false,
"newUrl": "/home",
"isDefined": false,
"id": "headerHome",
"isVisible": false,
"title": "Homepage",
"url": ""
},
{
"isCustomColumn": false,
"isDefined": true,
"id": "mod_16",
"isVisible": true,
"title": "New Homepage",
"url": "{portalRoot}/web-ui/index.html"
},
{
"isCustomColumn": false,
"newUrl": "/resource-center",
"children": [
{
"isCustomColumn": false,
"newUrl": "/resource-center/map",
"isDefined": false,
"id": "childMod_Maps",
"isVisible": true,
"title": "Map",
"url": ""
},
{
"isCustomColumn": false,
"newUrl": "/resource-center/service",
"isDefined": false,
"id": "childMod_Services",
"isVisible": true,
"title": "Service",
"url": ""
},
{
"isCustomColumn": false,
"newUrl": "/resource-center/scene",
"isDefined": false,
"id": "childMod_Scene",
"isVisible": true,
"title": "scene",
"url": ""
},
{
"isCustomColumn": false,
"newUrl": "/resource-center/data",
"isDefined": true,
"id": "childMod_Datas",
"isVisible": true,
"title": "Data",
"url": ""
},
{
"isCustomColumn": false,
"newUrl": "/resource-center/mapdashboard",
"isDefined": true,
"id": "childMod_MapDashboards",
"isVisible": true,
"title": "Dashboard",
"url": ""
},
{
"isCustomColumn": false,
"newUrl": "/resource-center/insightsworkspace",
"isDefined": true,
"id": "childMod_Insights",
"isVisible": true,
"title": "Insights",
"url": ""
}
],
"isDefined": false,
"id": "headerResources",
"isVisible": true,
"title": "Resource Center",
"url": ""
},
{
"isCustomColumn": false,
"newUrl": "/app",
"isDefined": false,
"id": "headerApps",
"isVisible": true,
"title": "App Center",
"url": ""
},
{
"isCustomColumn": false,
"isDefined": true,
"id": "mod_0da2e3d625a",
"isVisible": true,
"title": "Data Insights",
"url": "{portalRoot}/apps/insights/edit.html"
},
{
"isCustomColumn": false,
"isDefined": true,
"id": "mod_16",
"isVisible": true,
"title": "Data Mapping",
"url": "{portalRoot}/apps/dataviz/edit.html"
},
{
"isCustomColumn": false,
"isDefined": false,
"id": "headerMapViews",
"isVisible": false,
"title": "Data Mapping",
"url": "{portalRoot}/apps/viewer?action=create"
},
{
"isCustomColumn": "{portalRoot}web/menus/Development Guide",
"isDefined": true,
"id": "mod_11",
"isVisible": false,
"title": "Development Guide",
"url": "http://iclient.supermapol.com/"
},
{
"isCustomColumn": false,
"isDefined": true,
"id": "mod_13",
"isVisible": true,
"title": "Map Dashboard",
"url": "{portalRoot}/apps/mapdashboard/index.html?action=create"
},
{
"isCustomColumn": false,
"isDefined": false,
"id": "mod_f2d02a332e3",
"isVisible": false,
"title": "groupGROUP",
"url": "{portalRoot}/web/groups"
},
{
"isCustomColumn": "{portalRoot}web/menus/Other Cloud Products",
"children": [
{
"isCustomColumn": false,
"isDefined": true,
"id": "childMod_1",
"isVisible": false,
"title": "iManager",
"url": "http://192.168.169.4:31111"
},
{
"isCustomColumn": false,
"isDefined": true,
"id": "childMod_2",
"isVisible": false,
"title": "iServer",
"url": "http://rdc.ispeco.com:8080/iserver"
},
{
"isCustomColumn": "{portalRoot}web/menus/SuperMap Online",
"isDefined": true,
"id": "childMod_3",
"isVisible": false,
"title": "SuperMap Online",
"url": "https://www.supermapol.com"
}
],
"isDefined": true,
"id": "mod_17",
"isVisible": false,
"title": "Other Cloud Products",
"url": "http://192.168.169.4:31111"
},
{
"isCustomColumn": false,
"isDefined": true,
"id": "mod_21",
"isVisible": true,
"title": "groupGROUP",
"url": "{portalRoot}/web-ui/groups"
},
{
"isCustomColumn": false,
"isDefined": true,
"id": "mod_22",
"isVisible": true,
"title": "New Management",
"url": "{portalRoot}/manager-ui/index.html"
}
]
}
PUT Request
Modify the site-wide common UI configuration in iPortal.
Request Parameters
When sending a request, you need to pass the following parameters in the request body:
| Field | Type | Description |
| common | String | Common configuration. |
| header | String | Navigation bar configuration. |
| footer | String | Footer configuration. |
| languageConfig | String | Language configuration. |
| menus | String | Navigation bar menu configuration. |
Response Structure
The returned resource representation structure is as follows:
| Field | Type | Description |
| succeed | boolean | Whether modifying the site-wide common UI configuration is successful. |
| error | HttpError | Error information. If the modification is successful, this field is not returned. |
Response Example
Modify the site-wide common UI configuration in iPortal. Perform a PUT request on the commonSetting resource: http://localhost/iportal/web/uiconfig/commonsetting.json. The request body is as follows:
{
"common": {
"app": true,
"subTitle": "SuperMap iPortal 10i",
"beta": " ",
"desc": "You can easily customize almost all content on the portal homepage. For customization methods, see"
},
"footer": {
"title": "Powered by SuperMap iPortal 10i (10.0.0-linux64) © 2000-2026 BeijingSuperMapSoftware Co., Ltd."
},
"header": {
"isShowHelp": true,
"logo": "{webUiRoot}homePageImg/iportal_logo.svg",
"title": ""
},
"languageConfig": {
"language": [
{
"identity": "zh",
"title": "Chinese"
},
{
"identity": "en",
"title": "English"
}
],
"defaultLan": "zh"
},
"menus": [
{
"isCustomColumn": false,
"newUrl": "/home",
"isDefined": false,
"id": "headerHome",
"isVisible": false,
"title": "Homepage",
"url": ""
},
{
"isCustomColumn": false,
"isDefined": true,
"id": "mod_16",
"isVisible": true,
"title": "New Homepage",
"url": "{portalRoot}/web-ui/index.html"
},
{
"isCustomColumn": false,
"newUrl": "/resource-center",
"children": [
{
"isCustomColumn": false,
"newUrl": "/resource-center/map",
"isDefined": false,
"id": "childMod_Maps",
"isVisible": true,
"title": "Map",
"url": ""
},
{
"isCustomColumn": false,
"newUrl": "/resource-center/service",
"isDefined": false,
"id": "childMod_Services",
"isVisible": true,
"title": "Service",
"url": ""
},
{
"isCustomColumn": false,
"newUrl": "/resource-center/scene",
"isDefined": false,
"id": "childMod_Scene",
"isVisible": true,
"title": "scene",
"url": ""
},
{
"isCustomColumn": false,
"newUrl": "/resource-center/data",
"isDefined": true,
"id": "childMod_Datas",
"isVisible": true,
"title": "Data",
"url": ""
},
{
"isCustomColumn": false,
"newUrl": "/resource-center/mapdashboard",
"isDefined": true,
"id": "childMod_MapDashboards",
"isVisible": true,
"title": "Dashboard",
"url": ""
},
{
"isCustomColumn": false,
"newUrl": "/resource-center/insightsworkspace",
"isDefined": true,
"id": "childMod_Insights",
"isVisible": true,
"title": "Insights",
"url": ""
}
],
"isDefined": false,
"id": "headerResources",
"isVisible": true,
"title": "Resource Center",
"url": ""
},
{
"isCustomColumn": false,
"newUrl": "/app",
"isDefined": false,
"id": "headerApps",
"isVisible": true,
"title": "App Center",
"url": ""
},
{
"isCustomColumn": false,
"isDefined": true,
"id": "mod_0da2e3d625a",
"isVisible": true,
"title": "Data Insights",
"url": "{portalRoot}/apps/insights/edit.html"
},
{
"isCustomColumn": false,
"isDefined": true,
"id": "mod_16",
"isVisible": true,
"title": "Data Mapping",
"url": "{portalRoot}/apps/dataviz/edit.html"
},
{
"isCustomColumn": false,
"isDefined": false,
"id": "headerMapViews",
"isVisible": false,
"title": "Data Mapping",
"url": "{portalRoot}/apps/viewer?action=create"
},
{
"isCustomColumn": "{portalRoot}web/menus/Development Guide",
"isDefined": true,
"id": "mod_11",
"isVisible": false,
"title": "Development Guide",
"url": "http://iclient.supermapol.com/"
},
{
"isCustomColumn": false,
"isDefined": true,
"id": "mod_13",
"isVisible": true,
"title": "Map Dashboard",
"url": "{portalRoot}/apps/mapdashboard/index.html?action=create"
},
{
"isCustomColumn": false,
"isDefined": false,
"id": "mod_f2d02a332e3",
"isVisible": false,
"title": "groupGROUP",
"url": "{portalRoot}/web/groups"
},
{
"isCustomColumn": false,
"isDefined": true,
"id": "mod_21",
"isVisible": true,
"title": "groupGROUP",
"url": "{portalRoot}/web-ui/groups"
}
]
}
The returned json representation is as follows:
{"succeed": true}
HEAD Request
Returns the same HTTP response headers as a GET request, but without a response entity. You can obtain the metadata information contained in the response message headers without transferring the entire response content. The metadata information includes media type, character encoding, compression encoding, entity content length, etc.
A HEAD request can be used to determine whether the commonSetting resource exists, or whether the client has permission to access the commonSetting resource. By performing a HEAD request on a URI with .<format> appended, you can also quickly determine whether the commonSetting resource supports the <format> representation.
See