# EilamTest::VolumeApi All URIs are relative to *http://localhost:9000/site-manager/api/v1/engine* | Method | HTTP request | Description | | ------ | ------------ | ----------- | | [**volumes_get**](VolumeApi.md#volumes_get) | **GET** /volumes | | | [**volumes_pk_delete**](VolumeApi.md#volumes_pk_delete) | **DELETE** /volumes/{pk} | | | [**volumes_pk_get**](VolumeApi.md#volumes_pk_get) | **GET** /volumes/{pk} | | | [**volumes_pk_put**](VolumeApi.md#volumes_pk_put) | **PUT** /volumes/{pk} | | | [**volumes_post**](VolumeApi.md#volumes_post) | **POST** /volumes | | ## volumes_get > > volumes_get ### Examples ```ruby require 'time' require 'eilam_test' # setup authorization EilamTest.configure do |config| # Configure Bearer authorization: bearerAuth config.access_token = 'YOUR_BEARER_TOKEN' end api_instance = EilamTest::VolumeApi.new begin result = api_instance.volumes_get p result rescue EilamTest::ApiError => e puts "Error when calling VolumeApi->volumes_get: #{e}" end ``` #### Using the volumes_get_with_http_info variant This returns an Array which contains the response data, status code and headers. > >, Integer, Hash)> volumes_get_with_http_info ```ruby begin data, status_code, headers = api_instance.volumes_get_with_http_info p status_code # => 2xx p headers # => { ... } p data # => > rescue EilamTest::ApiError => e puts "Error when calling VolumeApi->volumes_get_with_http_info: #{e}" end ``` ### Parameters This endpoint does not need any parameter. ### Return type [**Array<VolumeResponse>**](VolumeResponse.md) ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: */* ## volumes_pk_delete > > volumes_pk_delete(pk) ### Examples ```ruby require 'time' require 'eilam_test' # setup authorization EilamTest.configure do |config| # Configure Bearer authorization: bearerAuth config.access_token = 'YOUR_BEARER_TOKEN' end api_instance = EilamTest::VolumeApi.new pk = 56 # Integer | begin result = api_instance.volumes_pk_delete(pk) p result rescue EilamTest::ApiError => e puts "Error when calling VolumeApi->volumes_pk_delete: #{e}" end ``` #### Using the volumes_pk_delete_with_http_info variant This returns an Array which contains the response data, status code and headers. > >, Integer, Hash)> volumes_pk_delete_with_http_info(pk) ```ruby begin data, status_code, headers = api_instance.volumes_pk_delete_with_http_info(pk) p status_code # => 2xx p headers # => { ... } p data # => > rescue EilamTest::ApiError => e puts "Error when calling VolumeApi->volumes_pk_delete_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **pk** | **Integer** | | | ### Return type [**Array<Volume>**](Volume.md) ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: */* ## volumes_pk_get > > volumes_pk_get(pk) ### Examples ```ruby require 'time' require 'eilam_test' # setup authorization EilamTest.configure do |config| # Configure Bearer authorization: bearerAuth config.access_token = 'YOUR_BEARER_TOKEN' end api_instance = EilamTest::VolumeApi.new pk = 56 # Integer | begin result = api_instance.volumes_pk_get(pk) p result rescue EilamTest::ApiError => e puts "Error when calling VolumeApi->volumes_pk_get: #{e}" end ``` #### Using the volumes_pk_get_with_http_info variant This returns an Array which contains the response data, status code and headers. > >, Integer, Hash)> volumes_pk_get_with_http_info(pk) ```ruby begin data, status_code, headers = api_instance.volumes_pk_get_with_http_info(pk) p status_code # => 2xx p headers # => { ... } p data # => > rescue EilamTest::ApiError => e puts "Error when calling VolumeApi->volumes_pk_get_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **pk** | **Integer** | | | ### Return type [**Array<VolumeResponse>**](VolumeResponse.md) ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: */* ## volumes_pk_put > volumes_pk_put(pk, volume_update) ### Examples ```ruby require 'time' require 'eilam_test' # setup authorization EilamTest.configure do |config| # Configure Bearer authorization: bearerAuth config.access_token = 'YOUR_BEARER_TOKEN' end api_instance = EilamTest::VolumeApi.new pk = 56 # Integer | volume_update = EilamTest::VolumeUpdate.new # VolumeUpdate | begin result = api_instance.volumes_pk_put(pk, volume_update) p result rescue EilamTest::ApiError => e puts "Error when calling VolumeApi->volumes_pk_put: #{e}" end ``` #### Using the volumes_pk_put_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> volumes_pk_put_with_http_info(pk, volume_update) ```ruby begin data, status_code, headers = api_instance.volumes_pk_put_with_http_info(pk, volume_update) p status_code # => 2xx p headers # => { ... } p data # => rescue EilamTest::ApiError => e puts "Error when calling VolumeApi->volumes_pk_put_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **pk** | **Integer** | | | | **volume_update** | [**VolumeUpdate**](VolumeUpdate.md) | | | ### Return type [**VolumeResponse**](VolumeResponse.md) ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: application/json - **Accept**: */* ## volumes_post > volumes_post(volume_create) ### Examples ```ruby require 'time' require 'eilam_test' # setup authorization EilamTest.configure do |config| # Configure Bearer authorization: bearerAuth config.access_token = 'YOUR_BEARER_TOKEN' end api_instance = EilamTest::VolumeApi.new volume_create = EilamTest::VolumeCreate.new # VolumeCreate | begin result = api_instance.volumes_post(volume_create) p result rescue EilamTest::ApiError => e puts "Error when calling VolumeApi->volumes_post: #{e}" end ``` #### Using the volumes_post_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> volumes_post_with_http_info(volume_create) ```ruby begin data, status_code, headers = api_instance.volumes_post_with_http_info(volume_create) p status_code # => 2xx p headers # => { ... } p data # => rescue EilamTest::ApiError => e puts "Error when calling VolumeApi->volumes_post_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **volume_create** | [**VolumeCreate**](VolumeCreate.md) | | | ### Return type [**VolumeResponse**](VolumeResponse.md) ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: application/json - **Accept**: */*