SetConfigOptions
HTTP Request Format
POST api/Config
Description
The SetConfigOptions REST API command edits the Astro Scheduler Engine configuration options (available through the GUI under the File > Configuration menu selection). One or more of the optional attributes may be included in the command.
Parameters
All parameters are optional.
| JSON Parameters | Body Format | Parameters Values |
|---|---|---|
| AutoValidate | "AutoValidate" : "TRUE" | Boolean indicating if Auto Validation is active |
| DisplayErrorMessage | "DisplayErrorMessage" : "TRUE" | Boolean indicating if error messages will be displayed |
| NaturalSort | "NaturalSort" : "TRUE" | Boolean indicating if natural sort is enabled for Astro Scheduler Engine |
| UserDirectory | "UserDirectory" : "<AbsoluteFileNamePath>" | <AbsoluteFileNamePath> is a string defining the user directory for Astro Scheduler Engine |
| EventLogging | "EventLogging" : "TRUE" | Boolean indicating if event logging is enabled Note: Events will still appear on the bottom of Astro Scheduler Engine |
| TimelineView | "TimelineView" : "TRUE" | Boolean indicating if the timeline view will be enabled for STK animations |
| ConnectCommandLogging | "ConnectCommandLogging" : "TRUE" | Boolean indicating if connect command logging is enabled |
| SocketConnection | "SocketConnection" : "TRUE" | Boolean indicating if a socket connection to STK is enabled |
| ShowGUI | "ShowGUI" : "TRUE" | Boolean indicating if the Astro Scheduler Engine GUI is enabled |
| GraphicsOn | "GraphicsOn" : "TRUE" | Boolean indicating if graphics are enabled |
| UseDayOfYear | "UseDayOfYear" : "TRUE" | Boolean indicating if Astro Scheduler Engine is in day of year mode |
| ApiReturnDataEnabled | "ApiReturnDataEnabled" : "TRUE" | Boolean indicating if return data through the socket is enabled |
| CostUnits | "CostUnits" : "<CostUnits>" | String of the units to be used for Cost |
| AdvancedCSVExport | "AdvancedCSVExport" : "TRUE" | Boolean indicating if the Advanced CSV report is being used |
| STKServer | "STKServer" : "<STKServer>" | String defining the STK server |
| STKPort | "STKPort" : <STKPort> | Integer defining the STK port |
| MaxCOMConnectionsToSTK | "MaxCOMConnectionsToSTK" : <MaxCOMConnectionsToSTK> | Integer defining the number of concurrent COM connections allowed between Astro Scheduler Engine and STK, which will limit the number of STK instances started. -1 is used for unlimited. |
| STKTimestep | "STKTimestep" : "<STKTimestep>" | String defining the default STK report timestep |
| EnableTCP | "EnableTCP" : "TRUE" | Boolean indicating if TCP connections are enabled |
| TCPPort | "TCPPort" : "<TCPPort>" | String defining the TCP port |
| EnableREST | "EnableREST" : "TRUE" | Boolean indicating if REST is enabled |
| RESTUrl | "EnableREST" : "<EnableREST>" | String defining the REST URL |
| RESTDirectory | "RESTDirectory" : "<RESTDirectory>" | String defining the REST directory |
| LicensePath | Astro Scheduler Engine license file path | String defining the license file path |
Examples
Disables all Astro Scheduler Engine popups
POST api/Config
Body:
{
"AutoValidate" : "FALSE",
"DisplayErrorMessage" : "FALSE"
}
Return Message
If activated, a standard response for a successful HTTP response shall appear.
Group Membership
This command belongs to the following group(s):
Version
12.3
