POST: Create a Repeating Schedule - AWS Elemental Conductor Live 3

This is version 3.19 of the AWS Elemental Conductor Live 3 documentation. This is the latest version. For prior versions, see the Previous Versions section of AWS Elemental Conductor Live 3 Documentation.

POST: Create a Repeating Schedule

Create a schedule that repeats regularly. Will only run if active. (See also POST: Create a One-Time Schedule.

HTTP Request and Response

Request URL

POST http://<Conductor IP address>/channels/<channel ID>/schedules

Call Header

  • Accept: Set to application/xml

  • Content-Type: Set to application/xml

If you are implementing user authentication, you must also include three authorization headers; see Header Content for User Authentication.

Request Body

XML content consisting of one schedule element, consisting of some or all of the following elements:

Element Value Type Description
name String [Required] A name you assign which must be unique in the channel.
active Boolean [Optional] If unspecified, defaults to false. A switch indicating whether the schedule will run. “True” for active schedules that run at the appointed time and false for inactive schedules that do not run but are saved in the system and can be activated later.
duration Integer [Required for repeating schedules] The length of time in seconds that the channel will run. If unspecified, defaults to nil="true", which results in a schedule that continues to run without stopping.
repeat Boolean [Required] The Boolean value for repeat which must be “true” for repeating schedules.
cron CRON expression [Required for repeating schedules] The expression which specifies the schedule according to the cron standard, as summarized in CRON Syntax Summary.

Response

The response repeats back the data that you posted with the addition of:

  • id: element containing the newly assigned ID for the schedule.

  • If not specified in the request, the active element, defaulted to “false.”