URI
<portal_uri>/config/system[.<format>]
Supported methods
Parent resource
Introduction
The systemConfig resource is the system-level configuration information resource. By sending a GET request to the systemConfig resource, you can query the system-level configuration information of iPortal. The system-level configuration information includes the JDK bitness and version used by iPortal, the operating system type, whether CAS single sign-on is enabled, etc.
Supported methods:
- GET:Queries the system-level configuration information of iPortal.
- HEAD: Checks whether the systemConfig resource exists or whether the permission can access the systemConfig resource.
Supported output formats:RJSON,JSON,XML.
Resource hierarchy
HTTP request methods
Perform an HTTP request on the following URI, using rjson output format as an example, where supermapiportal is the server name.
http://supermapiportal:8190/iportal/web/config/system.rjson
GET request
Queries the system-level configuration information of iPortal.
Request parameters
If no parameters are set, all system-level configuration information is returned. After setting parameters, the specified configuration information is returned. Request parameters must be included in the URI.
| Name | Type | Description |
| scope | String[] | Specifies the system-level configuration items to query. |
Response structure
Performing a GET request on the systemConfig resource returns all system-level configuration information of iPortal. If specific items are specified in the URI when sending the GET request, only the specified configuration items are returned. The system-level configuration consists of the following fields:
| Field | Type | Description |
| oauthConfig | OAuthConfig[] | Third-party login information for iPortal. |
| oracleDriverExist | Boolean | Whether iPortal includes the Oracle driver. |
| casSetting | Map<String, Object> | The CAS single sign-on configuration. |
| java.version | String | The JDK version used by iPortal. |
| casEnable | Boolean | Whether CAS single sign-on is enabled in iPortal. |
| jdkBit | String | The JDK bit version used by iPortal. |
| osName | String | The operating system type. |
| keycloakEnable | Boolean | Whether Keycloak single sign-on is enabled. |
Response example
Performing a GET request on the systemConfig resource: http://localhostl:8190/iportal/web/config/system.rjson . The rjson format resource representation is as follows:
{
"oauthConfig": {
"loginConfigs": [
{
"buttonText": null,
"loginIcon": null,
"clientID": "",
"loginType": "WEIBO",
"clientSecret": "",
"id": 1,
"redirectDomain": "iptl.supermap.io",
"enabled": true
},
{
"buttonText": null,
"loginIcon": null,
"clientID": "",
"loginType": "QQ",
"clientSecret": "",
"id": 2,
"redirectDomain": "iptl.supermap.io",
"enabled": true
}
]
},
"oracleDriverExist": false,
"isSuperMapOL": false,
"java.version": "1.8.0_202",
"casEnable": false,
"jdkBit": "64",
"casSetting": {
"loginUrl": "http://{ip}:{port}/cas/login?service=http://{ip}:{port}/{contextPath}/shiro-cas",
"isReserveSystemAccount": true,
"enabled": false
},
"osName": "win",
"version": "1.0.0",
"keycloakEnable": false
}
HEAD request
Returns the same HTTP response headers as a GET request, but without the response entity. Metadata information contained in the response headers can be obtained without transferring the entire response content. Metadata includes media type, character encoding, content encoding, and content length.
HEAD requests can be used to determine whether the systemConfig resource exists or whether the client has permission to access the systemConfig resource. By performing a HEAD request on a URI with .<format>, you can also quickly determine whether the systemConfig resource supports the <format> format representation.