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

