ExportToCSV
HTTP Request Formats
POST api/ExportToCSV
To specify the schedule the command shall be sent to:
POST api/schedule/{scheduleName}/ExportToCSV
Description
The ExportToCSV REST API command saves the current Data view as a CSV file.
Parameters
| JSON Parameters | Body Format | Description |
|---|---|---|
| Id | "Id" : "C:\\Myfiles\\Schedulefiles\\testfile.txt" | Parameter is a string defining the path to write the CSV file to |
| IncludeTimeslots | "IncludeTimeslots": "TRUE" | Optional boolean to include all timeslots for tasks, rather than just the assignments for the tasks. This also adds a Type column to differentiate timeslots |
| ResourceSetupTime | "ResourceSetupTime": "TRUE" | Optional boolean that adds a Resource Setup Time column, which contains semicolon delimited setup time information for all resources in the assignment. |
| MinMaxElevation | "MinMaxElevation": "TRUE" | Optional boolean that adds Min Elevation (deg) and Max Elevation (deg) columns, which contain semicolon delimited lists of the min/max elevation between every pair of ground and space resources during the assignment. |
| RevNumber | "RevNumber": "TRUE" | Optional boolean that adds a Min Rev Number column, which contains a semicolon delimited list of the minimum orbit number for all resources in the assignment. |
Example
To save the current Data view as an CSV file that includes timeslots and rev numbers, with a filename "testfile" under the C:\Myfiles\Schedulefiles\ directory:
POST api/ExportToCSV
Body:
{
"Id" : "C:\\Myfiles\\Schedulefiles\\testfile.txt",
"IncludeTimeslots": "TRUE",
"RevNumber": "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.3
