SetScheduleOptions
HTTP Request Formats
POST api/Options
To specify the schedule the command shall be sent to:
POST api/schedule/{scheduleName}/Options
Description
The SetScheduleOptions REST API command edits the general schedule options for the active schedule.
Parameters
All parameters are optional
| JSON Parameter | Body Format | Parameters Values |
|---|---|---|
| Schedule Parameters | ||
| Description | "Description" : "Example Description" | String description of schedule. Empty string is allowed. |
| StartTime | "StartTime" : "<StartTime>" | <StartTime> in one of the formats listed on the DateFormats page. |
| StopTime | "StopTime" : "<StopTime>" | <StopTime> in one of the formats listed on the DateFormats page. |
| BufferTimesApply | "BufferTimesApply" : "TRUE" | A boolean that indicates whether or not buffer time should be applied to the
schedule
|
| BufferTimesUseRealtime | "BufferTimesUseRealtime" : "TRUE" | A boolean that indicates that the buffer times are to be calculated from real time.This parameter only applies if BufferTimesApply is set to True |
| BufferTimeEpoch | "BufferTimeEpoch" : "<BufferTime>" | <BufferTime> is the time where buffer times are calculated from. It can either be a date in any of the date formats listed on the DateFormats page.This parameter only applies if BufferTimesApply is set to True and BufferTimesUseRealtime is set to False |
| BufferTimesSplitTasks | "BufferTimesSplitTasks" : "TRUE" | <BufferTimesSplitTasks> is a boolean that indicates whether buffer times should affect individual assignments or entire tasks. This parameter only applies if IsApplicable is set to True |
| Algorithm Parameters | ||
| Algorithm | "Algorithm" : "One-Pass" | "One-Pass", "Sequential", "Multi-Pass", "Neural", "Random", "Squeaky-Wheel", "Greedy", or "Custom"
NOTE: A "Custom" algorithm file path needs to be defined using the CustomAlgorithmFilePath option below before deconflicting the schedule. |
| CustomAlgorithmFilePath | "CustomAlgorithmFilePath" : "<FilePath>" | '<FilePath>' is the file path for a custom algorithm file. The file
path can be an absolute path (ex. C:/AstroScheduler/Custom.xml) or a relative path (ex. .\Custom.xml) from
the current schedule file saved location. NOTE: This command must be sent before setting Astro Scheduler Engine's algorithm to Custom, or Astro Scheduler Engine will give an error message when deconflicting the schedule. |
| BestOf | "BestOf" : "10" | BestOf may be any integer value >=0. Integer indicates number of Random and/or Neural runs compared for schedule solution optimization when these algorithms are selected. |
| RandomSeed | "RandomSeed" : "100" | Seed may be any integer value >= 0 or -1. The seed will set the random values to allow the algorithm to be deterministic. This applies only to Multi-Pass, Random ,Neural, and Squeaky-Wheel. A value of -1 indicates that the seed will not be set, and the value will be randomly set by Astro Scheduler Engine. |
| MaximizeAvgMultiSegScores | "MaximizeAvgMultiSegScores" : "TRUE" | TRUE The scheduling algorithms will prefer assignments that maximize the average score of used timeslot segments. FALSE (default) The scheduling algorithms will prefer assignments that minimize the total number of used timeslot segments. |
| ExpandEnabled | "ExpandEnabled" : "FALSE" | Boolean TRUE (default) Maximize tasks will be expanded as normal. |
| EarlyExpandEnabled | "EarlyExpandEnabled" : "FALSE" | Boolean TRUE (default) When possible, task assignments will be expanded earlier than their original
start time. |
| ExpandAssignmentsFirst | "ExpandAssignmentsFirst" : "FALSE" | Boolean TRUE Tasks will be maximized before attempting to assign other tasks. |
| Task Priority Parameters | ||
| TaskPriority | "TaskPriority" : { "Min" : "1", "Max" : "10" "Convention" : "HIGHER_NUMBER_HIGHER_PRIORITY" }
| Min and Max values are integers >= 0 Convention parameter is "HIGHER_NUMBER_HIGHER_PRIORITY" or "LOWER_NUMBER_HIGHER_PRIORITY"; HIGHER_NUMBER_HIGHER_PRIORITY means that higher number have higher priority, while LOWER_NUMBER_HIGHER_PRIORITY means that lower numbers have a higher priority. |
| Resource Priority Parameters | ||
| ResourcePriority | "ResourcePriority" : { "Min" : "1", "Max" : "10" "Convention" : "HIGHER_NUMBER_HIGHER_PRIORITY" } | Min and Max values are integers >= 0 All are optional |
| Timeslot Score Parameters | ||
| TimeslotScore | "TimeslotScore" : { "MinScore" : "1", "MaxScore" : "10" } | MinScore and MaxScore values are integers from -2,147,483,648 to 2,147,483,647. Higher values make the slot more desirable. All are optional |
| FOM Parameters | ||
| FOM | "FOM" : { "Assign" : "1", "Dur" : "1" "PP" : "1" "PN" : "1" "Early" : "1" "MaxDur" : "1" "PT" : "1" } | All parameters are Figure of Merit (FOM) constants and can be any integer value >=0. All are optional |
| STK Parameters | ||
| StkScenario | "StkScenario" : "<FilePath>" "StkScenarioForcing" : true | '<FilePath>' value must be in single quotes. The STK scenario file path can be an absolute path (ex. C:/AstroScheduler/Scenario.vdf) or a relative path (ex. .\Scenario.vdf) from the current schedule file saved location. StkScenarioForcing is an optional parameter that causes the schedule to switch to a new Scenario path even if the file isn't found. |
| StkTimestep | "StkTimestep" : "30" | Sets STK's simulation time step size. Real number, in seconds, >0. |
| SetTimeFromStk | "SetTimeFromStk" : "TRUE" | TRUE will set schedule start/stop times from STK scenario start/stop times when scenario is loaded. FALSE (default) will set STK start/stop times from schedule start/stop times when scenario is loaded. |
| Notes Parameters | ||
| Notes | "Notes" : "<Notes>" | <Notes> value can contain special character codes, including carriage returns and line feeds. |
| RFI Deprioritization Parameters | ||
| RfiDeprioritizationBehavior | "RfiDeprioritizationBehavior": "<None|Blackout|Minimized|Offset>" "RfiDeprioritizationOffset":30 | Determines how timeslots are changed when affected by RFI. The Offset parameter is a double that is only read if the Behavior value is set to "Offset". |
Examples
Changes the values of the StopTime, Algorithm, TaskPriority, and FOM attributes in the active schedule to 2002/07/30_13:06:59, Multi-Pass, 1-10-low, and 5-3-12-20-1-1-1, respectively
POST api/Options
Body:
{
"StopTime" : "2002/07/30_13:06:59",
"Algorithm" : "Multi-Pass"
"TaskPriority" : {
"Min" : "1",
"Max" : "10"
"Convention" : "LOWER_NUMBER_HIGHER_PRIORITY" }
"FOM" : {
"Assign" : "5",
"Dur" : "3"
"PP" : "12"
"PN" : "50"
"Early" : "1"
"MaxDur" : "1"
"PT" : "1" }
}
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
