IngestSTKObjects
HTTP Request Formats
POST api/IngestSTKObjects
To specify the schedule the command shall be sent to:
POST api/schedule/{scheduleName}/IngestSTKObjects
Description
The IngestSTKObjects REST API command creates resources in Astro Scheduler Engine. If you send an "ObjectType", Astro Scheduler Engine creates one resource for each object of the specified type in the associated STK scenario. If you send paths, one resource is created per object whose path is sent. Only one parameter type should be sent.
Parameters
JSON Parameters | Body Format | Description |
---|---|---|
ObjectType | "ObjectType" : "Aircraft" | Parameter options are Aircraft, AreaTarget, Chain, Facility, GroundVehicle, LaunchVehicle, Missile, Planet, Radar, Receiver, Satellite, Sensor, Ship, Star, Target, Transmitter, or All. |
PathList | "PathList": ["C:\\Scenarios\\MyScenario\\Satellites\\HUBBLE"] | Parameter is a list of strings that match existing objects in STK |
AllObjects | "AllObjects" : "TRUE" | Optional boolean will ingest all resources from STK |
Examples
Creates an Astro Scheduler Engine resource for each facility object in the STK scenario
POST api/IngestSTKObjects
Body:
{
"ObjectType" : "Facility"
}
Creates an Astro Scheduler Engine resource for the "HESSI" satellite.
POST api/IngestSTKObjects
Body:
{
"PathList" : [" \\Scenarios\\Tutorial\\Satellites\\HESSI", "\\Scenarios\\Tutorial\\Satellites\\FUSE"]
}
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