windmill-api 1.684.1

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200

# \InputApi

All URIs are relative to */api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_input**](InputApi.md#create_input) | **POST** /w/{workspace}/inputs/create | Create an Input for future use in a script or flow
[**delete_input**](InputApi.md#delete_input) | **POST** /w/{workspace}/inputs/delete/{input} | Delete a Saved Input
[**get_args_from_history_or_saved_input**](InputApi.md#get_args_from_history_or_saved_input) | **GET** /w/{workspace}/inputs/{jobOrInputId}/args | Get args from history or saved input
[**get_input_history**](InputApi.md#get_input_history) | **GET** /w/{workspace}/inputs/history | List Inputs used in previously completed jobs
[**list_inputs**](InputApi.md#list_inputs) | **GET** /w/{workspace}/inputs/list | List saved Inputs for a Runnable
[**update_input**](InputApi.md#update_input) | **POST** /w/{workspace}/inputs/update | Update an Input



## create_input

> uuid::Uuid create_input(workspace, create_input, runnable_id, runnable_type)
Create an Input for future use in a script or flow

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**create_input** | [**CreateInput**](CreateInput.md) | Input | [required] |
**runnable_id** | Option<**String**> |  |  |
**runnable_type** | Option<[**RunnableType**](.md)> |  |  |

### Return type

[**uuid::Uuid**](uuid::Uuid.md)

### 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_input

> uuid::Uuid delete_input(workspace, input)
Delete a Saved Input

### Parameters


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

### Return type

[**uuid::Uuid**](uuid::Uuid.md)

### 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)


## get_args_from_history_or_saved_input

> serde_json::Value get_args_from_history_or_saved_input(workspace, job_or_input_id, input, allow_large)
Get args from history or saved input

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**job_or_input_id** | **String** |  | [required] |
**input** | Option<**bool**> |  |  |
**allow_large** | Option<**bool**> |  |  |

### Return type

[**serde_json::Value**](serde_json::Value.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)


## get_input_history

> Vec<models::Input> get_input_history(workspace, runnable_id, runnable_type, page, per_page, args, include_preview)
List Inputs used in previously completed jobs

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**runnable_id** | Option<**String**> |  |  |
**runnable_type** | Option<[**RunnableType**](.md)> |  |  |
**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) |  |
**include_preview** | Option<**bool**> |  |  |

### Return type

[**Vec<models::Input>**](Input.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_inputs

> Vec<models::Input> list_inputs(workspace, runnable_id, runnable_type, page, per_page)
List saved Inputs for a Runnable

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**runnable_id** | Option<**String**> |  |  |
**runnable_type** | Option<[**RunnableType**](.md)> |  |  |
**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::Input>**](Input.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)


## update_input

> uuid::Uuid update_input(workspace, update_input)
Update an Input

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**update_input** | [**UpdateInput**](UpdateInput.md) | UpdateInput | [required] |

### Return type

[**uuid::Uuid**](uuid::Uuid.md)

### 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)