Schedule Tools
Overview
Schedule tools provide full lifecycle management for Flowon Schedule records. Schedules define recurring triggers that invoke a Logic Flow at a specified frequency and interval, starting from a given date. Each schedule is linked to a specific Logic Flow and project.
list_all_schedules
Lists All Flowon schedules.
| Parameter | Type | Required | Description |
|---|---|---|---|
pageNumber | int | The page number for pagination. If not provided, defaults to the first page. Optional. | |
pagingCookie | string | The 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.
list_schedules_by_project_name
Lists Flowon schedules by project name.
| Parameter | Type | Required | Description |
|---|---|---|---|
projectName | string | ✓ | The name of the project to filter schedules by name. |
Returns: A list of Schedules within the specified project.
list_schedules_by_project_id
Lists Flowon schedules by project ID.
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | GUID | ✓ | The ID of the project to filter schedules by. |
Returns: A list of Schedules within the specified project.
get_schedule_details_by_name
Gets the details for a Flowon Schedule by schedule name.
| Parameter | Type | Required | Description |
|---|---|---|---|
scheduleName | string | ✓ | The name of the schedule. |
projectName | string | ✓ | The name of the project the schedule belongs to. |
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 preview url for Flowon schedule.
| Parameter | Type | Required | Description |
|---|---|---|---|
scheduleName | string | ✓ | The name of the schedule. |
projectName | string | ✓ | The name of the project for the schedule. |
value | string | ✓ | The value for the schedule. |
cacheEntryStrategy | CacheEntryStrategy | ✓ | The cache entry strategy for the schedule. |
timeToLive | int | ✓ | The time to live for the schedule cache entry in minutes. |
title | string | The title for the schedule. Optional. | |
description | string | The 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.
| Parameter | Type | Required | Description |
|---|---|---|---|
scheduleName | string | ✓ | The name of the schedule to create. |
projectName | string | ✓ | The name of the project to create the schedule in. |
logicFlowId | GUID | ✓ | The ID of the logic flow associated with the schedule. |
frequency | ScheduleRunFrequency | ✓ | The frequency for the schedule. |
interval | int | ✓ | The interval for the schedule. |
startDate | DateTime | The start date for the schedule. Optional. | |
title | string | The title for the schedule. Optional. | |
description | string | The 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.
| Parameter | Type | Required | Description |
|---|---|---|---|
scheduleName | string | ✓ | The name of the schedule to update. |
projectName | string | ✓ | The name of the project for the schedule to update. |
frequency | ScheduleRunFrequency | ✓ | The frequency for the schedule. |
interval | int | ✓ | The interval for the schedule. |
startDate | DateTime | The start date for the schedule. Optional. |
Returns: Confirmation that the schedule was updated.
Restriction: Cannot be called on projects associated with a managed solution.