To clear a global variable, use the URL <baseURL>/api/variable/{name}.
Table 10: Clear global variable request
Put |
<baseURL>/api/variable/{name} |
{"clear": true} |
Table 11: Clear global variable parameters
name |
Variable name (required). |
path |
string |
Body schema:
{clear (boolean): True to clear a variable.}
Example:
https://<Hostname>/AppServer/api/variable/FullSync
Body:
{"clear": true}
To set a set of global variables, use the URL <baseURL>/api/variables.
Table 12: Set a set of global variable request
Put |
<baseURL>/api/variables |
{"variables": { "variablename": <value> }} |
Table 13: Set global variable parameters
variables |
Variable names (required). |
body |
string |
Body schema:
Example:
https://<Hostname>/AppServer/api/variables
Body:
{"variables": {"FullSync": True, "MyVariable": 42}}
To clear a set of global variables, use the URL <baseURL>/api/variables/clear.
Table 14: Clear a set of global variable request
Put |
<baseURL>/api/variables/clear |
{"variables": [ "string" ]} |
Table 15: Clear global variable parameters
variables |
Variable names (required) |
body |
string |
Body schema:
{
"variables": [
"string"
]
}
Example:
https://<Hostname>/AppServer/api/variables/clear
Body:
{"variables": ["FullSync", "MyVariable"]}
The Application Server can be restricted to the pure REST API only. To do this, modify the Web.config file. All services necessary for login and status page are not affected by the switch-off.
Settings for the Application Server plugins in the Web.config file
<restapi>
<!-- Switch REST API part off -->
<!--<add key="off" value="true" />-->
</restapi>
<appserverapi>
<!-- Switch application server APIs off -->
<!--<add key="off" value="true" />-->
</appserverapi>