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>
To get a list of entities, you have the option to use a GET or POST request against the REST API. Both methods support to query by example. Simply provide the columns to query in the form Name=Value in the URL.
Detailed information about this topic