Description | Example | Return Message | Group(s)

OpenSchedule

HTTP Request Format

POST api/Load

Description

The OpenSchedule REST API command opens the specified schedule file and makes it the active schedule. This command may also be used to select which of the open schedules should become the active schedule.

Parameters

  • FilePathName: The 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.

Examples

Opens an existing schedule file named DemoSchedule.ssc located in C:\MyFiles\ScheduleFiles\

POST api/Load

Body:

"C:\MyFiles\ScheduleFiles\DemoSchedule.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