# CloudSmlApi.DataApi

All URIs are relative to *https://localhost/api/v1*

Method | HTTP request | Description
------------- | ------------- | -------------
[**createDataSource**](DataApi.md#createDataSource) | **POST** /data/sources/ | Add a new data source
[**createDataSourceColumn**](DataApi.md#createDataSourceColumn) | **POST** /data/sources/{data_source_id}/columns/ | Create DataSourceColumn (action may be performed by Computational Backend)
[**createDataTransformation**](DataApi.md#createDataTransformation) | **POST** /data/transformations/ | Make a new data transformation
[**deleteDataSourceById**](DataApi.md#deleteDataSourceById) | **DELETE** /data/sources/{data_source_id} | Delete a data source by ID
[**deleteDataTransformationById**](DataApi.md#deleteDataTransformationById) | **DELETE** /data/transformations/{data_transformation_id} | Delete a data transformation by ID
[**getDataSourceById**](DataApi.md#getDataSourceById) | **GET** /data/sources/{data_source_id} | Get data source details by ID
[**getDataSourceColumns**](DataApi.md#getDataSourceColumns) | **GET** /data/sources/{data_source_id}/columns/ | Get data source predictors list by data source ID
[**getDataSources**](DataApi.md#getDataSources) | **GET** /data/sources/ | List of data sources
[**getDataTransformationById**](DataApi.md#getDataTransformationById) | **GET** /data/transformations/{data_transformation_id} | Get data transformation details by ID
[**getDataTransformationMaterializationById**](DataApi.md#getDataTransformationMaterializationById) | **GET** /data/transformations/{data_transformation_id}/data.{export_format} | Preview Data Transformation
[**getDataTransformations**](DataApi.md#getDataTransformations) | **GET** /data/transformations/ | List of data transformations
[**getExportDataTransformationById**](DataApi.md#getExportDataTransformationById) | **GET** /data/transformations/{data_transformation_id}.{export_format} | Get Data Transformation in specified format
[**optionsDataSourceById**](DataApi.md#optionsDataSourceById) | **OPTIONS** /data/sources/{data_source_id} | Check which methods are allowed
[**optionsDataSourceColumns**](DataApi.md#optionsDataSourceColumns) | **OPTIONS** /data/sources/{data_source_id}/columns/ | Check which methods are allowed
[**optionsDataSources**](DataApi.md#optionsDataSources) | **OPTIONS** /data/sources/ | Check which methods are allowed
[**optionsDataTransformationById**](DataApi.md#optionsDataTransformationById) | **OPTIONS** /data/transformations/{data_transformation_id} | Check which methods are allowed
[**optionsDataTransformationMaterializationById**](DataApi.md#optionsDataTransformationMaterializationById) | **OPTIONS** /data/transformations/{data_transformation_id}/data.{export_format} | Check which methods are allowed
[**optionsDataTransformations**](DataApi.md#optionsDataTransformations) | **OPTIONS** /data/transformations/ | Check which methods are allowed
[**optionsExportDataTransformationById**](DataApi.md#optionsExportDataTransformationById) | **OPTIONS** /data/transformations/{data_transformation_id}.{export_format} | Check which methods are allowed
[**optionsMaterializedDataTransformationById**](DataApi.md#optionsMaterializedDataTransformationById) | **OPTIONS** /data/transformations/exported/{exported_data_transformation_id}/ | Check which methods are allowed
[**patchDataSourceById**](DataApi.md#patchDataSourceById) | **PATCH** /data/sources/{data_source_id} | Modify data source details by ID
[**patchDataTransformationById**](DataApi.md#patchDataTransformationById) | **PATCH** /data/transformations/{data_transformation_id} | Modify data transformation details by ID
[**patchMaterializedDataTransformationById**](DataApi.md#patchMaterializedDataTransformationById) | **PATCH** /data/transformations/exported/{exported_data_transformation_id}/ | Patch MaterializedDataTransformation to change status and put proper SeaweedFS File ID


<a name="createDataSource"></a>
# **createDataSource**
> DetailedDataSource createDataSource(name, sourceType, opts)

Add a new data source

**PERMISSIONS: At least Active user is required.**

### Example
```javascript
var CloudSmlApi = require('cloud_sml_api');
var defaultClient = CloudSmlApi.ApiClient.default;

// Configure OAuth2 access token for authorization: oauth2_password
var oauth2_password = defaultClient.authentications['oauth2_password'];
oauth2_password.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new CloudSmlApi.DataApi();

var name = "name_example"; // String | 

var sourceType = "sourceType_example"; // String | 

var opts = { 
  'workspaceId': 56, // Number | provide workspace ID to attach data source to it
  'sourceLink': "sourceLink_example", // String | 
  'sourceFile': "/path/to/file.txt" // File | 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.createDataSource(name, sourceType, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **name** | **String**|  | 
 **sourceType** | **String**|  | 
 **workspaceId** | **Number**| provide workspace ID to attach data source to it | [optional] 
 **sourceLink** | **String**|  | [optional] 
 **sourceFile** | **File**|  | [optional] 

### Return type

[**DetailedDataSource**](DetailedDataSource.md)

### Authorization

[oauth2_password](../README.md#oauth2_password)

### HTTP request headers

 - **Content-Type**: multipart/form-data
 - **Accept**: application/json

<a name="createDataSourceColumn"></a>
# **createDataSourceColumn**
> BaseDataSourceColumn createDataSourceColumn(dataSourceIdname, title, opts)

Create DataSourceColumn (action may be performed by Computational Backend)

**PERMISSIONS: Internal role is required.**

### Example
```javascript
var CloudSmlApi = require('cloud_sml_api');
var defaultClient = CloudSmlApi.ApiClient.default;

// Configure OAuth2 access token for authorization: oauth2_password
var oauth2_password = defaultClient.authentications['oauth2_password'];
oauth2_password.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new CloudSmlApi.DataApi();

var dataSourceId = 56; // Number | 

var name = "name_example"; // String | 

var title = "title_example"; // String | 

var opts = { 
  'statistics': "statistics_example", // String | 
  'predictorType': "predictorType_example" // String | 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.createDataSourceColumn(dataSourceIdname, title, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **dataSourceId** | **Number**|  | 
 **name** | **String**|  | 
 **title** | **String**|  | 
 **statistics** | **String**|  | [optional] 
 **predictorType** | **String**|  | [optional] 

### Return type

[**BaseDataSourceColumn**](BaseDataSourceColumn.md)

### Authorization

[oauth2_password](../README.md#oauth2_password)

### HTTP request headers

 - **Content-Type**: application/x-www-form-urlencoded, multipart/form-data
 - **Accept**: application/json

<a name="createDataTransformation"></a>
# **createDataTransformation**
> DetailedDataTransformation createDataTransformation(transformationType, name, opts)

Make a new data transformation

**PERMISSIONS: At least Active user is required.**

### Example
```javascript
var CloudSmlApi = require('cloud_sml_api');
var defaultClient = CloudSmlApi.ApiClient.default;

// Configure OAuth2 access token for authorization: oauth2_password
var oauth2_password = defaultClient.authentications['oauth2_password'];
oauth2_password.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new CloudSmlApi.DataApi();

var transformationType = "transformationType_example"; // String | 

var name = "name_example"; // String | 

var opts = { 
  'workspaceId': "workspaceId_example", // String | 
  'parentDataTransformationId': "parentDataTransformationId_example" // String | 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.createDataTransformation(transformationType, name, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **transformationType** | **String**|  | 
 **name** | **String**|  | 
 **workspaceId** | **String**|  | [optional] 
 **parentDataTransformationId** | **String**|  | [optional] 

### Return type

[**DetailedDataTransformation**](DetailedDataTransformation.md)

### Authorization

[oauth2_password](../README.md#oauth2_password)

### HTTP request headers

 - **Content-Type**: application/x-www-form-urlencoded, multipart/form-data
 - **Accept**: application/json

<a name="deleteDataSourceById"></a>
# **deleteDataSourceById**
> deleteDataSourceById(dataSourceId)

Delete a data source by ID

**PERMISSIONS: Owner/Supervisor/Admin may execute this action.**

### Example
```javascript
var CloudSmlApi = require('cloud_sml_api');
var defaultClient = CloudSmlApi.ApiClient.default;

// Configure OAuth2 access token for authorization: oauth2_password
var oauth2_password = defaultClient.authentications['oauth2_password'];
oauth2_password.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new CloudSmlApi.DataApi();

var dataSourceId = 56; // Number | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.deleteDataSourceById(dataSourceId, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **dataSourceId** | **Number**|  | 

### Return type

null (empty response body)

### Authorization

[oauth2_password](../README.md#oauth2_password)

### HTTP request headers

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

<a name="deleteDataTransformationById"></a>
# **deleteDataTransformationById**
> deleteDataTransformationById(dataTransformationId)

Delete a data transformation by ID

**PERMISSIONS: Workspace Member may execute this action**

### Example
```javascript
var CloudSmlApi = require('cloud_sml_api');
var defaultClient = CloudSmlApi.ApiClient.default;

// Configure OAuth2 access token for authorization: oauth2_password
var oauth2_password = defaultClient.authentications['oauth2_password'];
oauth2_password.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new CloudSmlApi.DataApi();

var dataTransformationId = 56; // Number | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.deleteDataTransformationById(dataTransformationId, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **dataTransformationId** | **Number**|  | 

### Return type

null (empty response body)

### Authorization

[oauth2_password](../README.md#oauth2_password)

### HTTP request headers

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

<a name="getDataSourceById"></a>
# **getDataSourceById**
> DetailedDataSource getDataSourceById(dataSourceId)

Get data source details by ID

**PERMISSIONS: Workspace Member may execute this action**

### Example
```javascript
var CloudSmlApi = require('cloud_sml_api');
var defaultClient = CloudSmlApi.ApiClient.default;

// Configure OAuth2 access token for authorization: oauth2_password
var oauth2_password = defaultClient.authentications['oauth2_password'];
oauth2_password.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new CloudSmlApi.DataApi();

var dataSourceId = 56; // Number | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getDataSourceById(dataSourceId, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **dataSourceId** | **Number**|  | 

### Return type

[**DetailedDataSource**](DetailedDataSource.md)

### Authorization

[oauth2_password](../README.md#oauth2_password)

### HTTP request headers

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

<a name="getDataSourceColumns"></a>
# **getDataSourceColumns**
> [BaseDataSourceColumn] getDataSourceColumns(dataSourceId)

Get data source predictors list by data source ID

**PERMISSIONS: Workspace Member may execute this action**

### Example
```javascript
var CloudSmlApi = require('cloud_sml_api');
var defaultClient = CloudSmlApi.ApiClient.default;

// Configure OAuth2 access token for authorization: oauth2_password
var oauth2_password = defaultClient.authentications['oauth2_password'];
oauth2_password.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new CloudSmlApi.DataApi();

var dataSourceId = 56; // Number | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getDataSourceColumns(dataSourceId, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **dataSourceId** | **Number**|  | 

### Return type

[**[BaseDataSourceColumn]**](BaseDataSourceColumn.md)

### Authorization

[oauth2_password](../README.md#oauth2_password)

### HTTP request headers

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

<a name="getDataSources"></a>
# **getDataSources**
> [BaseDataSource] getDataSources(opts)

List of data sources

**PERMISSIONS: At least Active user is required.**   Returns a list of data sources starting from &#x60;&#x60;offset&#x60;&#x60; limited by &#x60;&#x60;limit&#x60;&#x60; parameter.

### Example
```javascript
var CloudSmlApi = require('cloud_sml_api');
var defaultClient = CloudSmlApi.ApiClient.default;

// Configure OAuth2 access token for authorization: oauth2_password
var oauth2_password = defaultClient.authentications['oauth2_password'];
oauth2_password.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new CloudSmlApi.DataApi();

var opts = { 
  'workspaceId': 56, // Number | filter by workspace
  'offset': 56, // Number | a number of items to skip, default is 0.
  'limit': 20, // Number | limit a number of items (allowed range is 1-100), default is 20.
  'userId': 56 // Number | filter data sources by user ID
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getDataSources(opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **workspaceId** | **Number**| filter by workspace | [optional] 
 **offset** | **Number**| a number of items to skip, default is 0. | [optional] 
 **limit** | **Number**| limit a number of items (allowed range is 1-100), default is 20. | [optional] [default to 20]
 **userId** | **Number**| filter data sources by user ID | [optional] 

### Return type

[**[BaseDataSource]**](BaseDataSource.md)

### Authorization

[oauth2_password](../README.md#oauth2_password)

### HTTP request headers

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

<a name="getDataTransformationById"></a>
# **getDataTransformationById**
> DetailedDataTransformation getDataTransformationById(dataTransformationId)

Get data transformation details by ID

**PERMISSIONS: Workspace Member may execute this action**

### Example
```javascript
var CloudSmlApi = require('cloud_sml_api');
var defaultClient = CloudSmlApi.ApiClient.default;

// Configure OAuth2 access token for authorization: oauth2_password
var oauth2_password = defaultClient.authentications['oauth2_password'];
oauth2_password.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new CloudSmlApi.DataApi();

var dataTransformationId = 56; // Number | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getDataTransformationById(dataTransformationId, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **dataTransformationId** | **Number**|  | 

### Return type

[**DetailedDataTransformation**](DetailedDataTransformation.md)

### Authorization

[oauth2_password](../README.md#oauth2_password)

### HTTP request headers

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

<a name="getDataTransformationMaterializationById"></a>
# **getDataTransformationMaterializationById**
> DataTransformationMaterializationSchema getDataTransformationMaterializationById(dataTransformationId, exportFormat, opts)

Preview Data Transformation

**PERMISSIONS: Workspace Member may execute this action**

### Example
```javascript
var CloudSmlApi = require('cloud_sml_api');
var defaultClient = CloudSmlApi.ApiClient.default;

// Configure OAuth2 access token for authorization: oauth2_password
var oauth2_password = defaultClient.authentications['oauth2_password'];
oauth2_password.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new CloudSmlApi.DataApi();

var dataTransformationId = 56; // Number | 

var exportFormat = "exportFormat_example"; // String | 

var opts = { 
  'offset': 56, // Number | a number of items to skip, default is 0.
  'columns': ["columns_example"], // [String] | Which columns to export
  'filterBy': ["filterBy_example"], // [String] | a list of filtering rules
  'sortBy': "sortBy_example", // String | Sort by column name
  'limit': 56 // Number | limit a number of items (allowed range is 0-100), default is 0. 0 means unlimit
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getDataTransformationMaterializationById(dataTransformationId, exportFormat, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **dataTransformationId** | **Number**|  | 
 **exportFormat** | **String**|  | 
 **offset** | **Number**| a number of items to skip, default is 0. | [optional] 
 **columns** | [**[String]**](String.md)| Which columns to export | [optional] 
 **filterBy** | [**[String]**](String.md)| a list of filtering rules | [optional] 
 **sortBy** | **String**| Sort by column name | [optional] 
 **limit** | **Number**| limit a number of items (allowed range is 0-100), default is 0. 0 means unlimit | [optional] 

### Return type

[**DataTransformationMaterializationSchema**](DataTransformationMaterializationSchema.md)

### Authorization

[oauth2_password](../README.md#oauth2_password)

### HTTP request headers

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

<a name="getDataTransformations"></a>
# **getDataTransformations**
> [BaseDataTransformation] getDataTransformations(opts)

List of data transformations

**PERMISSIONS: At least Active user is required.**   Returns a list of data transformations starting from &#x60;&#x60;offset&#x60;&#x60; limited by &#x60;&#x60;limit&#x60;&#x60; parameter.

### Example
```javascript
var CloudSmlApi = require('cloud_sml_api');
var defaultClient = CloudSmlApi.ApiClient.default;

// Configure OAuth2 access token for authorization: oauth2_password
var oauth2_password = defaultClient.authentications['oauth2_password'];
oauth2_password.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new CloudSmlApi.DataApi();

var opts = { 
  'workspaceId': 56, // Number | filter by workspace
  'offset': 56, // Number | a number of items to skip, default is 0.
  'dataSourceId': 56, // Number | DataSource ID to filter the list
  'limit': 20 // Number | limit a number of items (allowed range is 1-100), default is 20.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getDataTransformations(opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **workspaceId** | **Number**| filter by workspace | [optional] 
 **offset** | **Number**| a number of items to skip, default is 0. | [optional] 
 **dataSourceId** | **Number**| DataSource ID to filter the list | [optional] 
 **limit** | **Number**| limit a number of items (allowed range is 1-100), default is 20. | [optional] [default to 20]

### Return type

[**[BaseDataTransformation]**](BaseDataTransformation.md)

### Authorization

[oauth2_password](../README.md#oauth2_password)

### HTTP request headers

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

<a name="getExportDataTransformationById"></a>
# **getExportDataTransformationById**
> ExportedDataTransformationSchema getExportDataTransformationById(dataTransformationId, exportFormat)

Get Data Transformation in specified format

**PERMISSIONS: Workspace Member may execute this action**

### Example
```javascript
var CloudSmlApi = require('cloud_sml_api');
var defaultClient = CloudSmlApi.ApiClient.default;

// Configure OAuth2 access token for authorization: oauth2_password
var oauth2_password = defaultClient.authentications['oauth2_password'];
oauth2_password.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new CloudSmlApi.DataApi();

var dataTransformationId = 56; // Number | 

var exportFormat = "exportFormat_example"; // String | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getExportDataTransformationById(dataTransformationId, exportFormat, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **dataTransformationId** | **Number**|  | 
 **exportFormat** | **String**|  | 

### Return type

[**ExportedDataTransformationSchema**](ExportedDataTransformationSchema.md)

### Authorization

[oauth2_password](../README.md#oauth2_password)

### HTTP request headers

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

<a name="optionsDataSourceById"></a>
# **optionsDataSourceById**
> optionsDataSourceById(dataSourceId)

Check which methods are allowed

**PERMISSIONS: At least Active user is required.**   Use this method if you need to know what operations are allowed to be performed on this endpoint, e.g. to decide wether to display a button in your UI.  The list of allowed methods is provided in &#x60;Allow&#x60; response header.

### Example
```javascript
var CloudSmlApi = require('cloud_sml_api');
var defaultClient = CloudSmlApi.ApiClient.default;

// Configure OAuth2 access token for authorization: oauth2_password
var oauth2_password = defaultClient.authentications['oauth2_password'];
oauth2_password.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new CloudSmlApi.DataApi();

var dataSourceId = 56; // Number | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.optionsDataSourceById(dataSourceId, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **dataSourceId** | **Number**|  | 

### Return type

null (empty response body)

### Authorization

[oauth2_password](../README.md#oauth2_password)

### HTTP request headers

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

<a name="optionsDataSourceColumns"></a>
# **optionsDataSourceColumns**
> optionsDataSourceColumns(dataSourceId)

Check which methods are allowed

**PERMISSIONS: At least Active user is required.**   Use this method if you need to know what operations are allowed to be performed on this endpoint, e.g. to decide wether to display a button in your UI.  The list of allowed methods is provided in &#x60;Allow&#x60; response header.

### Example
```javascript
var CloudSmlApi = require('cloud_sml_api');
var defaultClient = CloudSmlApi.ApiClient.default;

// Configure OAuth2 access token for authorization: oauth2_password
var oauth2_password = defaultClient.authentications['oauth2_password'];
oauth2_password.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new CloudSmlApi.DataApi();

var dataSourceId = 56; // Number | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.optionsDataSourceColumns(dataSourceId, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **dataSourceId** | **Number**|  | 

### Return type

null (empty response body)

### Authorization

[oauth2_password](../README.md#oauth2_password)

### HTTP request headers

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

<a name="optionsDataSources"></a>
# **optionsDataSources**
> optionsDataSources()

Check which methods are allowed

Use this method if you need to know what operations are allowed to be performed on this endpoint, e.g. to decide wether to display a button in your UI.  The list of allowed methods is provided in &#x60;Allow&#x60; response header.

### Example
```javascript
var CloudSmlApi = require('cloud_sml_api');

var apiInstance = new CloudSmlApi.DataApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.optionsDataSources(callback);
```

### Parameters
This endpoint does not need any parameter.

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

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

<a name="optionsDataTransformationById"></a>
# **optionsDataTransformationById**
> optionsDataTransformationById(dataTransformationId)

Check which methods are allowed

**PERMISSIONS: At least Active user is required.**   Use this method if you need to know what operations are allowed to be performed on this endpoint, e.g. to decide wether to display a button in your UI.  The list of allowed methods is provided in &#x60;Allow&#x60; response header.

### Example
```javascript
var CloudSmlApi = require('cloud_sml_api');
var defaultClient = CloudSmlApi.ApiClient.default;

// Configure OAuth2 access token for authorization: oauth2_password
var oauth2_password = defaultClient.authentications['oauth2_password'];
oauth2_password.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new CloudSmlApi.DataApi();

var dataTransformationId = 56; // Number | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.optionsDataTransformationById(dataTransformationId, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **dataTransformationId** | **Number**|  | 

### Return type

null (empty response body)

### Authorization

[oauth2_password](../README.md#oauth2_password)

### HTTP request headers

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

<a name="optionsDataTransformationMaterializationById"></a>
# **optionsDataTransformationMaterializationById**
> optionsDataTransformationMaterializationById(dataTransformationId, exportFormat)

Check which methods are allowed

**PERMISSIONS: At least Active user is required.**   Use this method if you need to know what operations are allowed to be performed on this endpoint, e.g. to decide wether to display a button in your UI.  The list of allowed methods is provided in &#x60;Allow&#x60; response header.

### Example
```javascript
var CloudSmlApi = require('cloud_sml_api');
var defaultClient = CloudSmlApi.ApiClient.default;

// Configure OAuth2 access token for authorization: oauth2_password
var oauth2_password = defaultClient.authentications['oauth2_password'];
oauth2_password.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new CloudSmlApi.DataApi();

var dataTransformationId = 56; // Number | 

var exportFormat = "exportFormat_example"; // String | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.optionsDataTransformationMaterializationById(dataTransformationId, exportFormat, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **dataTransformationId** | **Number**|  | 
 **exportFormat** | **String**|  | 

### Return type

null (empty response body)

### Authorization

[oauth2_password](../README.md#oauth2_password)

### HTTP request headers

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

<a name="optionsDataTransformations"></a>
# **optionsDataTransformations**
> optionsDataTransformations()

Check which methods are allowed

**PERMISSIONS: At least Active user is required.**   Use this method if you need to know what operations are allowed to be performed on this endpoint, e.g. to decide wether to display a button in your UI.  The list of allowed methods is provided in &#x60;Allow&#x60; response header.

### Example
```javascript
var CloudSmlApi = require('cloud_sml_api');
var defaultClient = CloudSmlApi.ApiClient.default;

// Configure OAuth2 access token for authorization: oauth2_password
var oauth2_password = defaultClient.authentications['oauth2_password'];
oauth2_password.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new CloudSmlApi.DataApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.optionsDataTransformations(callback);
```

### Parameters
This endpoint does not need any parameter.

### Return type

null (empty response body)

### Authorization

[oauth2_password](../README.md#oauth2_password)

### HTTP request headers

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

<a name="optionsExportDataTransformationById"></a>
# **optionsExportDataTransformationById**
> optionsExportDataTransformationById(dataTransformationId, exportFormat)

Check which methods are allowed

**PERMISSIONS: At least Active user is required.**   Use this method if you need to know what operations are allowed to be performed on this endpoint, e.g. to decide wether to display a button in your UI.  The list of allowed methods is provided in &#x60;Allow&#x60; response header.

### Example
```javascript
var CloudSmlApi = require('cloud_sml_api');
var defaultClient = CloudSmlApi.ApiClient.default;

// Configure OAuth2 access token for authorization: oauth2_password
var oauth2_password = defaultClient.authentications['oauth2_password'];
oauth2_password.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new CloudSmlApi.DataApi();

var dataTransformationId = 56; // Number | 

var exportFormat = "exportFormat_example"; // String | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.optionsExportDataTransformationById(dataTransformationId, exportFormat, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **dataTransformationId** | **Number**|  | 
 **exportFormat** | **String**|  | 

### Return type

null (empty response body)

### Authorization

[oauth2_password](../README.md#oauth2_password)

### HTTP request headers

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

<a name="optionsMaterializedDataTransformationById"></a>
# **optionsMaterializedDataTransformationById**
> optionsMaterializedDataTransformationById(exportedDataTransformationId)

Check which methods are allowed

**PERMISSIONS: At least Active user is required.**   Use this method if you need to know what operations are allowed to be performed on this endpoint, e.g. to decide wether to display a button in your UI.  The list of allowed methods is provided in &#x60;Allow&#x60; response header.

### Example
```javascript
var CloudSmlApi = require('cloud_sml_api');
var defaultClient = CloudSmlApi.ApiClient.default;

// Configure OAuth2 access token for authorization: oauth2_password
var oauth2_password = defaultClient.authentications['oauth2_password'];
oauth2_password.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new CloudSmlApi.DataApi();

var exportedDataTransformationId = 56; // Number | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.optionsMaterializedDataTransformationById(exportedDataTransformationId, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **exportedDataTransformationId** | **Number**|  | 

### Return type

null (empty response body)

### Authorization

[oauth2_password](../README.md#oauth2_password)

### HTTP request headers

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

<a name="patchDataSourceById"></a>
# **patchDataSourceById**
> DetailedDataSource patchDataSourceById(dataSourceIdbody)

Modify data source details by ID

**PERMISSIONS: Workspace Member may execute this action**

### Example
```javascript
var CloudSmlApi = require('cloud_sml_api');
var defaultClient = CloudSmlApi.ApiClient.default;

// Configure OAuth2 access token for authorization: oauth2_password
var oauth2_password = defaultClient.authentications['oauth2_password'];
oauth2_password.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new CloudSmlApi.DataApi();

var dataSourceId = 56; // Number | 

var body = [new CloudSmlApi.Body()]; // [Body] | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.patchDataSourceById(dataSourceIdbody, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **dataSourceId** | **Number**|  | 
 **body** | [**[Body]**](Body.md)|  | 

### Return type

[**DetailedDataSource**](DetailedDataSource.md)

### Authorization

[oauth2_password](../README.md#oauth2_password)

### HTTP request headers

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

<a name="patchDataTransformationById"></a>
# **patchDataTransformationById**
> DetailedDataTransformation patchDataTransformationById(dataTransformationIdbody)

Modify data transformation details by ID

**PERMISSIONS: Workspace Member may execute this action**

### Example
```javascript
var CloudSmlApi = require('cloud_sml_api');
var defaultClient = CloudSmlApi.ApiClient.default;

// Configure OAuth2 access token for authorization: oauth2_password
var oauth2_password = defaultClient.authentications['oauth2_password'];
oauth2_password.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new CloudSmlApi.DataApi();

var dataTransformationId = 56; // Number | 

var body = [new CloudSmlApi.Body2()]; // [Body2] | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.patchDataTransformationById(dataTransformationIdbody, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **dataTransformationId** | **Number**|  | 
 **body** | [**[Body2]**](Body2.md)|  | 

### Return type

[**DetailedDataTransformation**](DetailedDataTransformation.md)

### Authorization

[oauth2_password](../README.md#oauth2_password)

### HTTP request headers

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

<a name="patchMaterializedDataTransformationById"></a>
# **patchMaterializedDataTransformationById**
> BaseMaterializedDataTransformation patchMaterializedDataTransformationById(exportedDataTransformationIdbody)

Patch MaterializedDataTransformation to change status and put proper SeaweedFS File ID

**PERMISSIONS: Internal role is required.**

### Example
```javascript
var CloudSmlApi = require('cloud_sml_api');
var defaultClient = CloudSmlApi.ApiClient.default;

// Configure OAuth2 access token for authorization: oauth2_password
var oauth2_password = defaultClient.authentications['oauth2_password'];
oauth2_password.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new CloudSmlApi.DataApi();

var exportedDataTransformationId = 56; // Number | 

var body = [new CloudSmlApi.Body1()]; // [Body1] | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.patchMaterializedDataTransformationById(exportedDataTransformationIdbody, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **exportedDataTransformationId** | **Number**|  | 
 **body** | [**[Body1]**](Body1.md)|  | 

### Return type

[**BaseMaterializedDataTransformation**](BaseMaterializedDataTransformation.md)

### Authorization

[oauth2_password](../README.md#oauth2_password)

### HTTP request headers

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