This operation returns the values for global parameters.
Request
Syntax
POST webservice/CommServ/GlobalParams HTTP/1.1 Host: host name Accept: application/xml Authtoken: authentication token Content-type: application/xml <get_global_param_values.xml>
where <webservice> is the root path used to route the API requests to the Web Server.
For more information, see Available Web Services for REST API.
Request Headers
|
Name |
Description |
|---|---|
|
Host |
The host name of the Web Server or the Command Center used in the API request. |
|
Accept |
The format of the response. Valid values are: application/xml or application/json. |
|
Authtoken |
The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication. |
|
Content-type |
The media type contained in the request body. |
XML
Download the get_global_param_values.xml file required for this request. The following table displays the parameter for the file.
|
Parameter |
Description |
Element |
|---|---|---|
|
val |
The name of the global parameter. To return the values for multiple global parameters, add the following element and attribute for each global parameter: For a list of global parameter names, see the Additional Settings website. Additional settings with a category of CommServDB.GxGlobalParam are valid values for the val parameter. |
globalParamsRequestList |
Response
Response Parameter
|
Parameter |
Description |
Element |
|---|---|---|
|
name |
The name of the global parameter. |
globalParamsResultList |
|
value |
The values for the global parameter. |
globalParamsResultList |
Examples
Sample Request
POST webservice/CommServ/GlobalParams HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc60f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef768fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f3233d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/xml
<Api_GetGlobalParamsRequest>
<globalParamsRequestList val="CI_STATE_FAILED"/>
<globalParamsRequestList val="CI_STATE_SKIPPED" />
<globalParamsRequestList val="AppMgrThreadIdleTimeout"/>
</Api_GetGlobalParamsRequest>Sample Response
<?xml version="1.0" encoding="UTF-8" ?>
<Api_GetGlobalParamsResponse>
<globalParamsResultList name="AppMgrThreadIdleTimeout" value="7200" />
<globalParamsResultList name="CI_STATE_FAILED" value="2,16,1016,2016" />
<globalParamsResultList name="CI_STATE_SKIPPED" value="17" />
</Api_GetGlobalParamsResponse>