GET: Get Schedule Events - AWS Elemental Conductor Live 3

This is version 3.17 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.

GET: Get Schedule Events

Within the system, active repeating schedules result in “schedule events”. A schedule event is an individual instance of the schedule and represents one time on the calendar when the channel will run. When new schedules are created or updated, and every hour after that, the system generates schedule events to bring the total queued schedule events to 24.

HTTP Request and Response

Request URL

To get all schedule events in the cluster:

GET http://<Conductor IP Address>/events

To get all schedule events from a single schedule:

GET http://<Conductor IP Address>/channels/<channel ID>/schedules/<schedule ID>/events

Call Header

  • Accept: Set to application/xml

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

Response

The response contains XML content consisting of one schedule_events element with the following.

  • An HREF attribute that specifies the product and version installed on the AWS Elemental Conductor Live 3 node.

  • Zero or more schedule_event elements, one for each schedule event found. Each element contains several elements, as follows.

Element Value Type Description
id Integer The ID for this schedule event, assigned by the system when the schedule event was generated.
start_at Datetime The date and time that the channel will start, in ISO 8601 format, including the UTC offset.
stop_at Integer The date and time that the channel will stop, in ISO 8601 format, including the UTC offset.
state String An indication of the current state or progress of scheduling. Possible values are: queued, pending, started, stopped, and failed.
message String System messages about any unexpected errors which appear here.
schedule_id Integer The ID for the schedule that spawned this schedule event.