Skip to main content

Time Trigger Schedule

APIs and Models to set up and manage your time triggers for your automation

API

Here are the list of APIs existing under time trigger schedule category.

APIDescription
ChangeScheduleToggleStatusThe API changes the schedule toggle status for the specified schedule (Time Trigger) Id from the connected Control Room.
CreateScheduleAsyncCreates a new Schedule (Time Trigger) with specified NewScheduleInfo details inside the connected Control Room.
DeleteScheduleAsyncDeletes an existing Schedule (Time Trigger) with specified schedule Id from the connected Control Room.
GetAllSchedulesAsyncGets the list of all Schedules (Time Triggers) with specified ScheduleInfo details from the connected Control Room.
UpdateScheduleAsyncUpdate the Schedule (Time Trigger) with specified ScheduleInfo details from the connected Control Room.

Models

Here are list of Models used in time trigger schedule APIs.

ModelsDescription
ExecutionTimeInfoThe structure represents an instance of Schedule's Execution TimeInfo entity.
NewScheduleInfoThe structure represents an instance of the New Schedule entity.
ScheduleInfoThe structure represents an instance of the Schedule entity.
ScheduleTypeThe ScheduleType object enumeration.