UpdateOrbitData
HTTP Request Formats
POST api/resource/{resourceName}/OrbitData
To specify the schedule the command shall be sent to:
POST api/schedule/{scheduleName}/resource/{resourceName}/OrbitData
Description
The UpdateOrbitData REST API command updates the orbit data but the specified object in the associated STK scenario. Accepted file types are .tle | .e | .oem. Additional details on merging orbit data and validation are described on the Resource help page.
Parameters
| JSON Parameters | Body Format | Description |
|---|---|---|
| OrbitDataPath | "OrbitDataPath" : "C:\\OrbitData\\newdata.tle" | The parameter is a string of text of the path of the orbit data file. More information on the acceptable file path formats can be found here. |
| ShouldMerge | "ShouldMerge": "TRUE" | Optional boolean (TRUE/FALSE) defining if new orbit data should be merged with existing data. If set to FALSE, Astro Scheduler Engine will completely replace the existing orbit data with the new data. Default is TRUE |
| RecreatePossibilities | "RecreatePossibilities": "TRUE" | Optional Boolean (TRUE/FALSE) defining if tasks using this resource should recreate their possibilities to take the updated orbit data into account. Default is TRUE |
| RetainAssignments | "RetainAssignments": "Adjust" | If RecreatePossibilities is true, specifies if assignments in affected tasks should be retained when possibilities are recreated, or if they should be adjusted to fit within the new timeslots. If RecreatePossibilities is false, this will have no effect and no assignments will be modified. Valid values are True, False, or Adjust. |
| RetainChildSettings | "RetainChildSettings": "TRUE" | Optional Boolean (TRUE/FALSE) If RecreatePossibilities is true, specifies if changes saved to child tasks should be attempted to be preserved. If RecreatePossibilities is false, this will have no effect and no changes will be lost. Default is FALSE |
Examples
Merge the orbit data of the FUSE resource in the active schedule with the file "newdata.tle" located at "C:\OrbitData\"
POST api/resource/FUSE/OrbitData
Body:
{
"OrbitDataPath" : "C:\\OrbitData\\newdata.tle",
"ShouldMerge": "TRUE"
}
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.5
