NewSchedule
HTTP Request Formats
POST api
To specify the schedule the command shall be sent to:
POST api/schedule/{scheduleName}
Description
The NewSchedule REST API command opens a new, blank schedule file, defines the file name and directory path.
Parameters
Both parameters are optional.
| JSON Parameters | Body Format | Description |
|---|---|---|
| FullPath | "FullPath" : "MyFiles\\MySchedules" | String of the path the schedule will be created |
| Overwrite | "Overwrite" : "TRUE" | Boolean that determines if the new schedule should overwrite a schedule with the same name. Default is "FALSE" |
Examples
Opens a new schedule file and defines its file name as NewDemoSchedule.ssc. It will fail if NewDemoSchedule.ssc
already exists.
POST api/schedule/NewDemoSchedule
Body:
{
"Overwrite" : "FALSE"
}
Opens a new schedule file and defines its file name as NewDemoSchedule.ssc. It will overwrite if
NewDemoSchedule.ssc already exists.
POST api/schedule/NewDemoSchedule
Body:
{
"Overwrite" : "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
