REST API - GET Client Additional Settings

This operation returns a list of additional settings at the client level.

Request

Syntax

GET <webservice>/Client/{clientId}/AdditionalSettings HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>

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 Parameters

Name	Description	Required
clientId	The client ID for the client. If the client ID is not known, use the GET Client API to retrieve it.	Yes

Request Headers

Name	Description
Host	The host name of the Web Server or Web Console 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.

Response

Response Parameters

Parameter	Description	Element
_type_	The level where the additional settings were created. Valid value is CLIENT_ENTITY.	client
type	Valid values is GALAXY.	client
keyName	The name of the additional setting.	regKeys
type	The data type of the additional setting.	regKeys
value	The user-assigned value of the additional setting.	regKeys
relativepath	The category of the additional setting, for example, CommServeDB.Console.	regKeys
deleted	Indicates whether or not the additional setting was deleted. Valid values are: 1, deleted 0, not deleted	regKeys
enabled	Indicates whether or not the additional setting is enabled. Valid values are: 1, enabled 0, disabled	regKeys
passwordVal		regKeys
comment	Comments entered for the additional setting.	regKeys
hidden	Indicates whether or not the additional setting is hidden. Valid values are True/False.	regKeys

Examples

Sample Request

GET <webservice>/Client/24/AdditionalSettings HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
 <EVGui_RegistryTaskResp>
   <returnValue>0</returnValue>
   <client>
     <_type_>CLIENT_ENTITY</_type_>
     <type>GALAXY</type>
   </client>
   <regKeys>
     <keyName>nPreferredIPFamily</keyName>
     <type>INTEGER</type>
     <value>1</value>
     <relativepath>Session</relativepath>
     <deleted>0</deleted>
     <enabled>1</enabled>
     <passwordVal></passwordVal>
     <comment></comment>
     <sourceEntity>
        <_type_>ROOT_ENTITY</_type_>
        <type>GALAXY</type>
        <srmReportSet>0</srmReportSet>
        <srmReportType>0</srmReportType>
        <consumeLicense>true</consumeLicense>
        <clientSidePackage>true</clientSidePackage>
     </sourceEntity>
     <hidden>false</hidden>
   </regKeys>
 </EVGui_RegistryTaskResp>