# CloudSmlApi.Predictive_analyticsApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**deletePredictiveEnsembleById**](Predictive_analyticsApi.md#deletePredictiveEnsembleById) | **DELETE** /predictive_analytics/ensembles/{predictive_ensemble_id} | Delete a predictive ensemble by ID
[**deletePredictiveModelById**](Predictive_analyticsApi.md#deletePredictiveModelById) | **DELETE** /predictive_analytics/models/{predictive_model_id} | Delete a predictive model by ID
[**fitPredictiveModel**](Predictive_analyticsApi.md#fitPredictiveModel) | **POST** /predictive_analytics/models/ | Build a new predictive model
[**getPredictiveEnsembleById**](Predictive_analyticsApi.md#getPredictiveEnsembleById) | **GET** /predictive_analytics/ensembles/{predictive_ensemble_id} | Get predictive ensemble details by ID
[**getPredictiveEnsembles**](Predictive_analyticsApi.md#getPredictiveEnsembles) | **GET** /predictive_analytics/ensembles/ | List of predictive ensembles
[**getPredictiveModelById**](Predictive_analyticsApi.md#getPredictiveModelById) | **GET** /predictive_analytics/models/{predictive_model_id} | Get predictive model details by ID
[**getPredictiveModelExportById**](Predictive_analyticsApi.md#getPredictiveModelExportById) | **GET** /predictive_analytics/models/{predictive_model_id}.{export_format} | Export a model
[**getPredictiveModelOptimalPerformanceStats**](Predictive_analyticsApi.md#getPredictiveModelOptimalPerformanceStats) | **GET** /predictive_analytics/models/{predictive_model_id}/optimal_performance_stats | Get Optimal Performance Stats for specific Predictive Model by its ID
[**getPredictiveModelPerformanceStats**](Predictive_analyticsApi.md#getPredictiveModelPerformanceStats) | **GET** /predictive_analytics/models/{predictive_model_id}/performance_stats | Get Performance Stats for specific Predictive Model by its ID
[**getPredictiveModels**](Predictive_analyticsApi.md#getPredictiveModels) | **GET** /predictive_analytics/models/ | List of predictive models
[**optionsExportedPredictiveModelById**](Predictive_analyticsApi.md#optionsExportedPredictiveModelById) | **OPTIONS** /predictive_analytics/models/exported_predictive_model/{exported_predictive_model_id} | Check which methods are allowed
[**optionsPredictiveEnsembleById**](Predictive_analyticsApi.md#optionsPredictiveEnsembleById) | **OPTIONS** /predictive_analytics/ensembles/{predictive_ensemble_id} | Check which methods are allowed
[**optionsPredictiveEnsembles**](Predictive_analyticsApi.md#optionsPredictiveEnsembles) | **OPTIONS** /predictive_analytics/ensembles/ | Check which methods are allowed
[**optionsPredictiveModelById**](Predictive_analyticsApi.md#optionsPredictiveModelById) | **OPTIONS** /predictive_analytics/models/{predictive_model_id} | Check which methods are allowed
[**optionsPredictiveModelExportById**](Predictive_analyticsApi.md#optionsPredictiveModelExportById) | **OPTIONS** /predictive_analytics/models/{predictive_model_id}.{export_format} | Check which methods are allowed
[**optionsPredictiveModelOptimalPerformanceStats**](Predictive_analyticsApi.md#optionsPredictiveModelOptimalPerformanceStats) | **OPTIONS** /predictive_analytics/models/{predictive_model_id}/optimal_performance_stats | Check which methods are allowed
[**optionsPredictiveModelPerformanceStats**](Predictive_analyticsApi.md#optionsPredictiveModelPerformanceStats) | **OPTIONS** /predictive_analytics/models/{predictive_model_id}/performance_stats | Check which methods are allowed
[**optionsPredictiveModels**](Predictive_analyticsApi.md#optionsPredictiveModels) | **OPTIONS** /predictive_analytics/models/ | Check which methods are allowed
[**patchExportedPredictiveModelById**](Predictive_analyticsApi.md#patchExportedPredictiveModelById) | **PATCH** /predictive_analytics/models/exported_predictive_model/{exported_predictive_model_id} | Patch ExportedPredictiveModel to change status and put proper SeeweedFS File ID
[**patchPredictiveEnsembleById**](Predictive_analyticsApi.md#patchPredictiveEnsembleById) | **PATCH** /predictive_analytics/ensembles/{predictive_ensemble_id} | Modify predictive ensemble details by ID
[**patchPredictiveModelById**](Predictive_analyticsApi.md#patchPredictiveModelById) | **PATCH** /predictive_analytics/models/{predictive_model_id} | Modify predictive model details by ID
[**postPredictiveEnsembles**](Predictive_analyticsApi.md#postPredictiveEnsembles) | **POST** /predictive_analytics/ensembles/ | Create a new predictive ensemble


<a name="deletePredictiveEnsembleById"></a>
# **deletePredictiveEnsembleById**
> deletePredictiveEnsembleById(predictiveEnsembleId)

Delete a predictive ensemble 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.Predictive_analyticsApi();

var predictiveEnsembleId = 56; // Number | 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **predictiveEnsembleId** | **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="deletePredictiveModelById"></a>
# **deletePredictiveModelById**
> deletePredictiveModelById(predictiveModelId)

Delete a predictive model 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.Predictive_analyticsApi();

var predictiveModelId = 56; // Number | 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **predictiveModelId** | **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="fitPredictiveModel"></a>
# **fitPredictiveModel**
> DetailedPredictiveModel fitPredictiveModel(predictiveAnalysisMethod, name, opts)

Build a new predictive model

**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.Predictive_analyticsApi();

var predictiveAnalysisMethod = "predictiveAnalysisMethod_example"; // String | 

var name = "name_example"; // String | 

var opts = { 
  'dataTransformationId': "dataTransformationId_example", // String | 
  'predictiveAnalysisOptions': "predictiveAnalysisOptions_example" // String | 
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **predictiveAnalysisMethod** | **String**|  | 
 **name** | **String**|  | 
 **dataTransformationId** | **String**|  | [optional] 
 **predictiveAnalysisOptions** | **String**|  | [optional] 

### Return type

[**DetailedPredictiveModel**](DetailedPredictiveModel.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="getPredictiveEnsembleById"></a>
# **getPredictiveEnsembleById**
> DetailedPredictiveEnsemble getPredictiveEnsembleById(predictiveEnsembleId)

Get predictive ensemble details 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.Predictive_analyticsApi();

var predictiveEnsembleId = 56; // Number | 


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

### Parameters

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

### Return type

[**DetailedPredictiveEnsemble**](DetailedPredictiveEnsemble.md)

### Authorization

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

### HTTP request headers

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

<a name="getPredictiveEnsembles"></a>
# **getPredictiveEnsembles**
> [BasePredictiveEnsemble] getPredictiveEnsembles(opts)

List of predictive ensembles

**PERMISSIONS: At least Active user is required.**   Returns a list of predictive ensembles 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.Predictive_analyticsApi();

var opts = { 
  '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.
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **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]

### Return type

[**[BasePredictiveEnsemble]**](BasePredictiveEnsemble.md)

### Authorization

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

### HTTP request headers

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

<a name="getPredictiveModelById"></a>
# **getPredictiveModelById**
> DetailedPredictiveModel getPredictiveModelById(predictiveModelId)

Get predictive model 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.Predictive_analyticsApi();

var predictiveModelId = 56; // Number | 


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

### Parameters

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

### Return type

[**DetailedPredictiveModel**](DetailedPredictiveModel.md)

### Authorization

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

### HTTP request headers

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

<a name="getPredictiveModelExportById"></a>
# **getPredictiveModelExportById**
> PredictiveModelExportSchema getPredictiveModelExportById(exportFormat, predictiveModelId)

Export a model

**PERMISSIONS: Workspace Member may execute this action**   Provide a standalone model exported to a chosen format or programming language.  Supported formats:  * pfa * py * c * java  If Exported Predictive Model doesn&#39;t exist the this method will create task to export it, otherwise it would be returned immediately.

### 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.Predictive_analyticsApi();

var exportFormat = "exportFormat_example"; // String | 

var predictiveModelId = 56; // Number | 


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

### Parameters

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

### Return type

[**PredictiveModelExportSchema**](PredictiveModelExportSchema.md)

### Authorization

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

### HTTP request headers

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

<a name="getPredictiveModelOptimalPerformanceStats"></a>
# **getPredictiveModelOptimalPerformanceStats**
> BasePredictiveModelOptimalPerformanceStats getPredictiveModelOptimalPerformanceStats(predictiveModelId)

Get Optimal Performance Stats for specific Predictive Model by its ID

**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.Predictive_analyticsApi();

var predictiveModelId = 56; // Number | 


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

### Parameters

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

### Return type

[**BasePredictiveModelOptimalPerformanceStats**](BasePredictiveModelOptimalPerformanceStats.md)

### Authorization

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

### HTTP request headers

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

<a name="getPredictiveModelPerformanceStats"></a>
# **getPredictiveModelPerformanceStats**
> BasePredictiveModelPerformanceStats getPredictiveModelPerformanceStats(predictiveModelId)

Get Performance Stats for specific Predictive Model by its ID

**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.Predictive_analyticsApi();

var predictiveModelId = 56; // Number | 


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

### Parameters

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

### Return type

[**BasePredictiveModelPerformanceStats**](BasePredictiveModelPerformanceStats.md)

### Authorization

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

### HTTP request headers

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

<a name="getPredictiveModels"></a>
# **getPredictiveModels**
> [BasePredictiveModel] getPredictiveModels(opts)

List of predictive models

**PERMISSIONS: At least Active user is required.**   Returns a list of predictive models 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.Predictive_analyticsApi();

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.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getPredictiveModels(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]

### Return type

[**[BasePredictiveModel]**](BasePredictiveModel.md)

### Authorization

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

### HTTP request headers

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

<a name="optionsExportedPredictiveModelById"></a>
# **optionsExportedPredictiveModelById**
> optionsExportedPredictiveModelById(exportedPredictiveModelId)

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.Predictive_analyticsApi();

var exportedPredictiveModelId = 56; // Number | 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **exportedPredictiveModelId** | **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="optionsPredictiveEnsembleById"></a>
# **optionsPredictiveEnsembleById**
> optionsPredictiveEnsembleById(predictiveEnsembleId)

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.Predictive_analyticsApi();

var predictiveEnsembleId = 56; // Number | 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **predictiveEnsembleId** | **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="optionsPredictiveEnsembles"></a>
# **optionsPredictiveEnsembles**
> optionsPredictiveEnsembles()

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.Predictive_analyticsApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.optionsPredictiveEnsembles(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="optionsPredictiveModelById"></a>
# **optionsPredictiveModelById**
> optionsPredictiveModelById(predictiveModelId)

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.Predictive_analyticsApi();

var predictiveModelId = 56; // Number | 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **predictiveModelId** | **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="optionsPredictiveModelExportById"></a>
# **optionsPredictiveModelExportById**
> optionsPredictiveModelExportById(exportFormat, predictiveModelId)

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.Predictive_analyticsApi();

var exportFormat = "exportFormat_example"; // String | 

var predictiveModelId = 56; // Number | 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **exportFormat** | **String**|  | 
 **predictiveModelId** | **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="optionsPredictiveModelOptimalPerformanceStats"></a>
# **optionsPredictiveModelOptimalPerformanceStats**
> optionsPredictiveModelOptimalPerformanceStats(predictiveModelId)

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.Predictive_analyticsApi();

var predictiveModelId = 56; // Number | 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **predictiveModelId** | **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="optionsPredictiveModelPerformanceStats"></a>
# **optionsPredictiveModelPerformanceStats**
> optionsPredictiveModelPerformanceStats(predictiveModelId)

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.Predictive_analyticsApi();

var predictiveModelId = 56; // Number | 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **predictiveModelId** | **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="optionsPredictiveModels"></a>
# **optionsPredictiveModels**
> optionsPredictiveModels()

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.Predictive_analyticsApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.optionsPredictiveModels(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="patchExportedPredictiveModelById"></a>
# **patchExportedPredictiveModelById**
> BaseExportedPredictiveModel patchExportedPredictiveModelById(exportedPredictiveModelIdbody)

Patch ExportedPredictiveModel to change status and put proper SeeweedFS File ID

**PERMISSIONS: Internal role is required.**   Method available only for InternalRole

### 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.Predictive_analyticsApi();

var exportedPredictiveModelId = 56; // Number | 

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


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **exportedPredictiveModelId** | **Number**|  | 
 **body** | [**[Body3]**](Body3.md)|  | 

### Return type

[**BaseExportedPredictiveModel**](BaseExportedPredictiveModel.md)

### Authorization

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

### HTTP request headers

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

<a name="patchPredictiveEnsembleById"></a>
# **patchPredictiveEnsembleById**
> DetailedPredictiveEnsemble patchPredictiveEnsembleById(predictiveEnsembleIdbody)

Modify predictive ensemble details 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.Predictive_analyticsApi();

var predictiveEnsembleId = 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.patchPredictiveEnsembleById(predictiveEnsembleIdbody, callback);
```

### Parameters

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

### Return type

[**DetailedPredictiveEnsemble**](DetailedPredictiveEnsemble.md)

### Authorization

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

### HTTP request headers

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

<a name="patchPredictiveModelById"></a>
# **patchPredictiveModelById**
> DetailedPredictiveModel patchPredictiveModelById(predictiveModelIdbody)

Modify predictive model 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.Predictive_analyticsApi();

var predictiveModelId = 56; // Number | 

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


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **predictiveModelId** | **Number**|  | 
 **body** | [**[Body4]**](Body4.md)|  | 

### Return type

[**DetailedPredictiveModel**](DetailedPredictiveModel.md)

### Authorization

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

### HTTP request headers

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

<a name="postPredictiveEnsembles"></a>
# **postPredictiveEnsembles**
> DetailedPredictiveEnsemble postPredictiveEnsembles(name)

Create a new predictive ensemble

**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.Predictive_analyticsApi();

var name = "name_example"; // String | 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **name** | **String**|  | 

### Return type

[**DetailedPredictiveEnsemble**](DetailedPredictiveEnsemble.md)

### Authorization

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

### HTTP request headers

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