ScheduleDefinitionOutput

Output representation of a schedule with required schedule_id.

Used when returning schedules from the API where schedule_id is always present.

Fields

Field	Type	Required	Description
input	Any	:heavy_check_mark:	Input to provide to the workflow when starting it.
calendars	List[models.ScheduleCalendar]	:heavy_minus_sign:	Calendar-based specification of times.
intervals	List[models.ScheduleInterval]	:heavy_minus_sign:	Interval-based specification of times.
cron_expressions	List[str]	:heavy_minus_sign:	Cron-based specification of times.
skip	List[models.ScheduleCalendar]	:heavy_minus_sign:	Set of calendar times to skip.
start_at	date	:heavy_minus_sign:	Time after which the first action may be run.
end_at	date	:heavy_minus_sign:	Time after which no more actions will be run.
jitter	OptionalNullable[str]	:heavy_minus_sign:	Jitter to apply each action. An action's scheduled time will be incremented by a random value between 0 and this value if present (but not past the next schedule).
time_zone_name	OptionalNullable[str]	:heavy_minus_sign:	IANA time zone name, for example US/Central.
policy	Optional[models.SchedulePolicy]	:heavy_minus_sign:	N/A
schedule_id	str	:heavy_check_mark:	Unique identifier for the schedule.
remaining_executions	OptionalNullable[int]	:heavy_minus_sign:	Remaining workflow executions before this schedule stops triggering automatically. null means unlimited; 0 means the limit has been reached and the schedule is exhausted.
workflow_name	str	:heavy_check_mark:	Name of the workflow this schedule triggers.
deployment_name	OptionalNullable[str]	:heavy_minus_sign:	Name of the deployment this schedule targets.
paused	bool	:heavy_check_mark:	Whether the schedule is currently paused.
note	OptionalNullable[str]	:heavy_minus_sign:	Human-readable note associated with the current pause or resume state.
future_executions	List[models.ScheduleFutureExecution]	:heavy_minus_sign:	Upcoming scheduled executions (10 next executions, earliest first).
recent_executions	List[models.ScheduleRecentExecution]	:heavy_minus_sign:	Most recent scheduled executions (10 most recent, newest last).