ExportToCommands
HTTP Request Formats
POST api/ExportToCommands
To specify the schedule the command shall be sent to:
POST api/schedule/{scheduleName}/ExportToCommands
Description
The ExportToCommands REST API command outputs an ingest file of the current schedule to the path 'FilePathName'.
Parameters
- FilePathName: The parameter is a string of text in double quotes of the file path name. More information on the acceptable file path formats can be found here. By convention the path extension should be ".txt".
Example
To save a text file of Connect commands that will recreate the currently open schedule, with a filename "testfile" under the C:\Myfiles\Schedulefiles\ directory:
POST api/ExportToCommands
Body:
"C:\\Myfiles\\Schedulefiles\\testfile.txt"
Return Message
Returns an acknowledgment message that includes the entire text of the generated file.
Group Membership
This command belongs to the following group(s):
Version
12.3
