Description | Example | Return Message | Group(s)

SaveSchedule

HTTP Request Format

POST api/Save

To specify the schedule the command shall be sent to:

POST api/schedule/{scheduleName}/Save

Description

The SaveSchedule REST API command saves the active schedule to the specified directory location under the specified filename (if included in body parameters).

Parameters

JSON ParametersBody FormatDescription
FileName"FileName": "C:\MyFiles\ScheduleFiles"Parameter is a string of text in single quotes of the path filename. More information on the acceptable file path formats can be found here. If this parameter is not provided the schedule will be saved to its current path.

 

Examples

Saves the active schedule file to the C:\MyFiles\ScheduleFiles\ directory under the filename DemoSchedule05082002.ssc
POST api/Save

Body:

{

"FileName" : "C:\MyFiles\ScheduleFiles\DemoSchedule05082002.ssc"

}

Return Message

If activated, a standard response for a successful HTTP response shall appear.

Group Membership

This command belongs to the following group(s):

Scheduler

Version

12.3