NewCustomSTKReport
HTTP Request Formats
POST api/CustomSTKReport
To specify the schedule the command shall be sent to:
POST api/schedule/{scheduleName}/CustomSTKReport
Description
The NewCustomSTKReport REST API command creates a new connection to STK. Further documentation of this is available on the "STK Custom Reports" page
Parameters
| JSON Parameters | Body Format | Description |
|---|---|---|
| Name | "Name" : "<Name>" | <Name> is a string of text that Astro Scheduler Engine will use to refer to the report |
| STKReportName | "STKReportName" : "<STKReportName>" | <STKReportName> is a string of text of the name of a report object in STK |
| Object1Type | "Object1Type" : "Radar" | Name of first object used in report. Possible options are "Aircraft","AreaTarget", "Chain", "Facility", "GroundVehicle", "LauchVehicle", "Missile", "Place", "Planet", "Radar", "Receiver", "Satellite", "Sensor", "Ship", "Star", "Target", and "Transmitter" . This parameter is required |
| Object2Type | "Object2Type" : "Target" | Name of first object used in report. Possible options are the same as Object1. This parameter is not used if the STK report only uses one object. |
| Style | "Style" : "Window" | The report style. Possible options are Window, Single, or Value. |
| FilterStart | "FilterStart" : "TRUE" | A boolean indicating whether the start time is filtered. Required for Single style reports |
| FilterStop | "FilterStop" : "TRUE" | A boolean indicating whether the stop time is filtered. Required for Single style reports |
| IsDegrees | "IsDegrees" : "TRUE" | A boolean indicating whether the units of the column are degrees. Required for Value style reports |
| Columns | "Columns" : "10" | An integer indicating the column number to use as the value from the report. Required for Value style reports |
| ApplyAccess | "ApplyAccess" : "TRUE" | A boolean indicating if access is also required. Required for Value style reports |
Examples
Creates a new custom report, "RoutineObservation", in the active schedule
POST api/CustomSTKReport
Body:
{
"Name" : "RoutineObservation",
"STKReportName" : "ObjHeight",
"Object1Type" : "GroundStation",
"Object2Type" : "Planet",
"Style" : "Window"
}
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
