Skip to main content

Schedule Tools

Overview

Schedules define recurring triggers that invoke a Logic Flow at a given frequency and interval, starting from a given date. Flowon Logic Assist supports searching, listing, reading, previewing, creating, and updating Schedules. Requires the Logic Composer product.

The get_schedule_preview_url tool takes a cacheEntryStrategy (a CacheEntryStrategy: Volatile, Ephemeral, or Constant) that controls how the previewed schedule value is cached.

ScheduleRunFrequency values:

ValueMeaning
MinuteRuns every n minutes
HourRuns every n hours
DayRuns every n days
WeekRuns every n weeks
MonthRuns every n months

(where n is the interval.)


search_schedules

Searches Flowon schedules by name.

ParameterTypeRequiredDescription
scheduleNamestringThe name of the schedule to search for.

Returns: Matching Schedules including name, frequency, interval, start date, linked logic flow, title, description, and project.


list_schedules

Lists Flowon schedules.

ParameterTypeRequiredDescription
projectIdGUIDThe ID of the project to filter schedules by. Optional.
pageNumberintThe page number for pagination. If not provided, defaults to the first page. Optional.
pagingCookiestringThe paging cookie for pagination. This should be provided if pageNumber is provided and there are more records to retrieve. Optional.

Returns: A paginated list of Schedules including name, frequency, interval, start date, next run date, last run date, linked logic flow, title, description, and project.

See Pagination for details on iterating through large result sets.


get_schedule_details_by_id

Gets the details for a Flowon schedule by schedule ID.

ParameterTypeRequiredDescription
scheduleIdGUIDThe ID of the schedule.

Returns: Full Schedule details including name, frequency, interval, start date, next run date, last run date, linked logic flow, title, description, and project.


get_schedule_preview_url

Get a preview URL for a Flowon schedule.

ParameterTypeRequiredDescription
scheduleNamestringThe name of the schedule.
projectIdGUIDThe ID of the project for the schedule.
valuestringThe value for the schedule.
cacheEntryStrategyCacheEntryStrategyThe cache entry strategy for the schedule.
timeToLiveintThe time to live for the schedule cache entry in minutes.
titlestringThe title for the schedule. Optional.
descriptionstringThe description for the schedule. Optional.

Returns: A preview URL for the schedule record.


create_schedule

Creates a new Flowon schedule and returns the schedule id.

ParameterTypeRequiredDescription
scheduleNamestringThe name of the schedule to create.
projectNamestringThe name of the project to create the schedule in.
logicFlowIdGUIDThe ID of the logic flow associated with the schedule.
frequencyScheduleRunFrequencyThe frequency for the schedule.
intervalintThe interval for the schedule.
startDateDateTimeThe start date for the schedule. Optional.
titlestringThe title for the schedule. Optional.
descriptionstringThe description for the schedule. Optional.

Returns: The GUID of the newly created Schedule and its URL.

Restriction: Cannot be called on projects associated with a managed solution. See Managed Solution Protection.


update_schedule_value

Updates Flowon schedule metadata.

ParameterTypeRequiredDescription
scheduleNamestringThe name of the schedule to update.
projectNamestringThe name of the project for the schedule to update.
frequencyScheduleRunFrequencyThe frequency for the schedule.
intervalintThe interval for the schedule.
startDateDateTimeThe start date for the schedule. Optional.

Returns: Confirmation that the schedule was updated.

Restriction: Cannot be called on projects associated with a managed solution. See Managed Solution Protection.

Best practice: Always read the current schedule first (via get_schedule_details_by_id or search_schedules) before updating, to avoid unintentionally overwriting the frequency, interval, or start date.