# \ScheduleApi

All URIs are relative to */api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_schedule**](ScheduleApi.md#create_schedule) | **POST** /w/{workspace}/schedules/create | create schedule
[**delete_schedule**](ScheduleApi.md#delete_schedule) | **DELETE** /w/{workspace}/schedules/delete/{path} | delete schedule
[**exists_schedule**](ScheduleApi.md#exists_schedule) | **GET** /w/{workspace}/schedules/exists/{path} | does schedule exists
[**get_schedule**](ScheduleApi.md#get_schedule) | **GET** /w/{workspace}/schedules/get/{path} | get schedule
[**list_schedules**](ScheduleApi.md#list_schedules) | **GET** /w/{workspace}/schedules/list | list schedules
[**list_schedules_with_jobs**](ScheduleApi.md#list_schedules_with_jobs) | **GET** /w/{workspace}/schedules/list_with_jobs | list schedules with last 20 jobs
[**preview_schedule**](ScheduleApi.md#preview_schedule) | **POST** /schedules/preview | preview schedule
[**set_default_error_or_recovery_handler**](ScheduleApi.md#set_default_error_or_recovery_handler) | **POST** /w/{workspace}/schedules/setdefaulthandler | Set default error or recoevery handler
[**set_schedule_enabled**](ScheduleApi.md#set_schedule_enabled) | **POST** /w/{workspace}/schedules/setenabled/{path} | set enabled schedule
[**update_schedule**](ScheduleApi.md#update_schedule) | **POST** /w/{workspace}/schedules/update/{path} | update schedule



## create_schedule

> String create_schedule(workspace, new_schedule)
create schedule

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**new_schedule** | [**NewSchedule**](NewSchedule.md) | new schedule | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## delete_schedule

> String delete_schedule(workspace, path)
delete schedule

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## exists_schedule

> bool exists_schedule(workspace, path)
does schedule exists

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |

### Return type

**bool**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_schedule

> models::Schedule get_schedule(workspace, path)
get schedule

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |

### Return type

[**models::Schedule**](Schedule.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_schedules

> Vec<models::Schedule> list_schedules(workspace, page, per_page, args, path, is_flow, path_start, schedule_path, description, summary, broad_filter, label)
list schedules

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**page** | Option<**i32**> | which page to return (start at 1, default 1) |  |
**per_page** | Option<**i32**> | number of items to return for a given page (default 30, max 100) |  |
**args** | Option<**String**> | filter on jobs containing those args as a json subset (@> in postgres) |  |
**path** | Option<**String**> | filter by path (script path) |  |
**is_flow** | Option<**bool**> | filter schedules by whether they target a flow |  |
**path_start** | Option<**String**> | filter schedules by path prefix |  |
**schedule_path** | Option<**String**> | exact match on the schedule's path |  |
**description** | Option<**String**> | pattern match filter for description field (case-insensitive) |  |
**summary** | Option<**String**> | pattern match filter for summary field (case-insensitive) |  |
**broad_filter** | Option<**String**> | broad search across multiple fields (case-insensitive substring match) |  |
**label** | Option<**String**> | Filter by label |  |

### Return type

[**Vec<models::Schedule>**](Schedule.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_schedules_with_jobs

> Vec<models::ScheduleWJobs> list_schedules_with_jobs(workspace, page, per_page)
list schedules with last 20 jobs

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**page** | Option<**i32**> | which page to return (start at 1, default 1) |  |
**per_page** | Option<**i32**> | number of items to return for a given page (default 30, max 100) |  |

### Return type

[**Vec<models::ScheduleWJobs>**](ScheduleWJobs.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## preview_schedule

> Vec<String> preview_schedule(preview_schedule_request)
preview schedule

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**preview_schedule_request** | [**PreviewScheduleRequest**](PreviewScheduleRequest.md) | schedule | [required] |

### Return type

**Vec<String>**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## set_default_error_or_recovery_handler

> set_default_error_or_recovery_handler(workspace, set_default_error_or_recovery_handler_request)
Set default error or recoevery handler

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**set_default_error_or_recovery_handler_request** | [**SetDefaultErrorOrRecoveryHandlerRequest**](SetDefaultErrorOrRecoveryHandlerRequest.md) | Handler description | [required] |

### Return type

 (empty response body)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## set_schedule_enabled

> String set_schedule_enabled(workspace, path, set_schedule_enabled_request)
set enabled schedule

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |
**set_schedule_enabled_request** | [**SetScheduleEnabledRequest**](SetScheduleEnabledRequest.md) | updated schedule enable | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## update_schedule

> String update_schedule(workspace, path, edit_schedule)
update schedule

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |
**edit_schedule** | [**EditSchedule**](EditSchedule.md) | updated schedule | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

