UpdateAzElMask
HTTP Request Formats
PATCH api/resource/{resourceName}/AzElMask
To specify the schedule the command shall be sent to:
PATCH api/schedule/{scheduleName}/resource/{resourceName}/AzElMask
Description
The UpdateAzElMask REST API command updates the azimuth-elevation mask for the specified object in the associated STK scenario. Accepted file types is .aem.
Parameters
| JSON Parameters | Body Format | Description |
|---|---|---|
| MaskFilePath | "MaskFilePath" : "C:\\Data\\newdata.tle" | The parameter is a string of text of the path of the azimuth-elevation mask file. More information on the acceptable file path formats can be found here. |
| RecreatePossibilities | "RecreatePossibilities": "TRUE" | Optional Boolean (TRUE/FALSE) defining if tasks using this resource should recreate their possibilities to take the updated mask 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
Update the azimuth-elevation mask of the FUSE resource in the active schedule with the file "newdata.aem" located at "C:\Data\"
PATCH api/resource/FUSE/AzElMask
Body:
{
"MaskFilePath" : "C:\\Data\\newdata.aem",
}
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.8
