# \VariablesApi

All URIs are relative to *http://localhost:5000*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_variable**](VariablesApi.md#create_variable) | **POST** /v3/streams/projects/{project_id}/sites/{site_id}/instruments/{inst_id}/variables | Create variable (single or bulk).
[**delete_variable**](VariablesApi.md#delete_variable) | **DELETE** /v3/streams/projects/{project_id}/sites/{site_id}/instruments/{inst_id}/variables/{var_id} | Delete a variable
[**get_variable**](VariablesApi.md#get_variable) | **GET** /v3/streams/projects/{project_id}/sites/{site_id}/instruments/{inst_id}/variables/{var_id} | Get variable details
[**list_variables**](VariablesApi.md#list_variables) | **GET** /v3/streams/projects/{project_id}/sites/{site_id}/instruments/{inst_id}/variables | List variables.
[**update_variable**](VariablesApi.md#update_variable) | **PUT** /v3/streams/projects/{project_id}/sites/{site_id}/instruments/{inst_id}/variables/{var_id} | Update a variable



## create_variable

> models::ListVariables200Response create_variable(project_id, site_id, inst_id, new_variable)
Create variable (single or bulk).

Create variable (single or bulk).

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**project_id** | **String** | Unique ID of project generated by Tapis | [required] |
**site_id** | **String** | User uniquely defined ID for site. | [required] |
**inst_id** | **String** | User uniquely defined ID for instrument. | [required] |
**new_variable** | [**Vec<models::NewVariable>**](NewVariable.md) |  | [required] |

### Return type

[**models::ListVariables200Response**](list_variables_200_response.md)

### Authorization

No authorization required

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


## delete_variable

> models::GetVariable200Response delete_variable(project_id, site_id, inst_id, var_id)
Delete a variable

Delete a variable

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**project_id** | **String** | Unique ID of project generated by Tapis | [required] |
**site_id** | **String** | User uniquely defined ID for site. | [required] |
**inst_id** | **String** | User uniquely defined ID for instrument. | [required] |
**var_id** | **String** | User provided, unique identifier within in the Instrument name space. will be used as the chords shortname | [required] |

### Return type

[**models::GetVariable200Response**](get_variable_200_response.md)

### Authorization

No authorization required

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

> models::GetVariable200Response get_variable(project_id, site_id, inst_id, var_id)
Get variable details

Get details of a specific variable by its id

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**project_id** | **String** | Unique ID of project generated by Tapis | [required] |
**site_id** | **String** | User uniquely defined ID for site. | [required] |
**inst_id** | **String** | User uniquely defined ID for instrument. | [required] |
**var_id** | **String** | User provided, unique identifier within in the Instrument name space. will be used as the chords shortname | [required] |

### Return type

[**models::GetVariable200Response**](get_variable_200_response.md)

### Authorization

No authorization required

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

> models::ListVariables200Response list_variables(project_id, site_id, inst_id, query, limit, skip)
List variables.

List variables.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**project_id** | **String** | Unique ID of project generated by Tapis | [required] |
**site_id** | **String** | User uniquely defined ID for site. | [required] |
**inst_id** | **String** | User uniquely defined ID for instrument. | [required] |
**query** | Option<**String**> | a formated query string for variables. |  |
**limit** | Option<**i32**> | limit the number of records returned. |  |
**skip** | Option<**i32**> | index (skip) to start list. |  |

### Return type

[**models::ListVariables200Response**](list_variables_200_response.md)

### Authorization

No authorization required

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

> models::GetVariable200Response update_variable(project_id, site_id, inst_id, var_id, update_variable)
Update a variable

Update a variable

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**project_id** | **String** | Unique ID of project generated by Tapis | [required] |
**site_id** | **String** | User uniquely defined ID for site. | [required] |
**inst_id** | **String** | User uniquely defined ID for instrument. | [required] |
**var_id** | **String** | User provided, unique identifier within in the Instrument name space. will be used as the chords shortname | [required] |
**update_variable** | [**UpdateVariable**](UpdateVariable.md) |  | [required] |

### Return type

[**models::GetVariable200Response**](get_variable_200_response.md)

### Authorization

No authorization required

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

