cloudsml-client

CloudSML - JavaScript client for cloudsml-client CloudSML is a next-generation Data Mining platform by Salford Systems. This is an online and interactive documentation for CloudSML RESTful API. Here you can check out what kind of information you can have and what actions you can do. You can generate a client library from the provided OpenAPI Specification using codegen tool. This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.15.2
• Package version: 1.15.2
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install cloudsml-client --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Getting Started

Please follow the installation instruction and execute the following JS code:

var CloudSML = require('cloudsml-client');

var defaultClient = CloudSML.ApiClient.instance;

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

var api = new CloudSML.AuthApi()

var defaultScopes = ["defaultScopes_example"]; // {[String]} 

var opts = { 
  'redirectUris': ["redirectUris_example"] // {[String]} 
};

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

Documentation for API Endpoints

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

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- CloudSML.AuthApi | createOauthClient | POST /auth/oauth2_clients/ | Create a new OAuth2 Client CloudSML.AuthApi | getOAuth2Clients | GET /auth/oauth2_clients/ | List of OAuth2 Clients CloudSML.AuthApi | optionsOAuth2Clients | OPTIONS /auth/oauth2_clients/ | Check which methods are allowed CloudSML.DataApi | createDataSource | POST /data/sources/ | Add a new data source CloudSML.DataApi | createDataTransformation | POST /data/transformations/ | Make a new data transformation CloudSML.DataApi | createDataTransformationColumn | POST /data/transformations/{data_transformation_id}/columns/ | Create DataTransformationColumn CloudSML.DataApi | deleteDataSourceById | DELETE /data/sources/{data_source_id} | Delete a data source by ID CloudSML.DataApi | deleteDataTransformationById | DELETE /data/transformations/{data_transformation_id} | Delete a data transformation by ID CloudSML.DataApi | getDataSourceById | GET /data/sources/{data_source_id} | Get data source details by ID CloudSML.DataApi | getDataSources | GET /data/sources/ | List of data sources CloudSML.DataApi | getDataTransformationById | GET /data/transformations/{data_transformation_id} | Get data transformation details by ID CloudSML.DataApi | getDataTransformationColumns | GET /data/transformations/{data_transformation_id}/columns/ | Get data transformation columns by data transformation ID CloudSML.DataApi | getDataTransformationMaterializationById | GET /data/transformations/{data_transformation_id}/data.{export_format} | Preview Data Transformation CloudSML.DataApi | getDataTransformations | GET /data/transformations/ | List of data transformations CloudSML.DataApi | getExportDataTransformationById | GET /data/transformations/{data_transformation_id}.{export_format} | Get Data Transformation in specified format CloudSML.DataApi | optionsDataSourceById | OPTIONS /data/sources/{data_source_id} | Check which methods are allowed CloudSML.DataApi | optionsDataSources | OPTIONS /data/sources/ | Check which methods are allowed CloudSML.DataApi | optionsDataTransformationById | OPTIONS /data/transformations/{data_transformation_id} | Check which methods are allowed CloudSML.DataApi | optionsDataTransformationColumns | OPTIONS /data/transformations/{data_transformation_id}/columns/ | Check which methods are allowed CloudSML.DataApi | optionsDataTransformationMaterializationById | OPTIONS /data/transformations/{data_transformation_id}/data.{export_format} | Check which methods are allowed CloudSML.DataApi | optionsDataTransformations | OPTIONS /data/transformations/ | Check which methods are allowed CloudSML.DataApi | optionsExportDataTransformationById | OPTIONS /data/transformations/{data_transformation_id}.{export_format} | Check which methods are allowed CloudSML.DataApi | optionsMaterializedDataTransformationById | OPTIONS /data/transformations/exported/{materialized_data_transformation_id}/ | Check which methods are allowed CloudSML.DataApi | patchDataSourceById | PATCH /data/sources/{data_source_id} | Modify data source details by ID CloudSML.DataApi | patchDataTransformationById | PATCH /data/transformations/{data_transformation_id} | Modify data transformation details by ID CloudSML.DataApi | patchMaterializedDataTransformationById | PATCH /data/transformations/exported/{materialized_data_transformation_id}/ | Patch MaterializedDataTransformation to change status and put proper SeaweedFS File ID CloudSML.Predictive_analyticsApi | createPipeline | POST /predictive_analytics/pipelines/ | Create a new pipeline CloudSML.Predictive_analyticsApi | deletePipelineById | DELETE /predictive_analytics/pipelines/{pipeline_id} | Delete pipeline by ID CloudSML.Predictive_analyticsApi | deletePredictiveModelById | DELETE /predictive_analytics/models/{predictive_model_id} | Delete a predictive model by ID CloudSML.Predictive_analyticsApi | fitPredictiveModel | POST /predictive_analytics/models/ | Build a new predictive model CloudSML.Predictive_analyticsApi | getPipelineById | GET /predictive_analytics/pipelines/{pipeline_id} | Get pipeline by it's ID CloudSML.Predictive_analyticsApi | getPipelines | GET /predictive_analytics/pipelines/ | List of pipelines CloudSML.Predictive_analyticsApi | getPredictiveModelById | GET /predictive_analytics/models/{predictive_model_id} | Get predictive model details by ID CloudSML.Predictive_analyticsApi | getPredictiveModelExportById | GET /predictive_analytics/models/{predictive_model_id}.{export_format} | Export a model CloudSML.Predictive_analyticsApi | getPredictiveModelOptimalPerformanceStats | GET /predictive_analytics/models/{predictive_model_id}/optimal_performance_stats | Get Optimal Performance Stats for specific Predictive Model by its ID CloudSML.Predictive_analyticsApi | getPredictiveModelPerformanceStats | GET /predictive_analytics/models/{predictive_model_id}/performance_stats | Get Performance Stats for specific Predictive Model by its ID CloudSML.Predictive_analyticsApi | getPredictiveModels | GET /predictive_analytics/models/ | List of predictive models CloudSML.Predictive_analyticsApi | optionsExportedPredictiveModelById | OPTIONS /predictive_analytics/models/exported_predictive_model/{exported_predictive_model_id} | Check which methods are allowed CloudSML.Predictive_analyticsApi | optionsPipelineById | OPTIONS /predictive_analytics/pipelines/{pipeline_id} | Check which methods are allowed CloudSML.Predictive_analyticsApi | optionsPipelines | OPTIONS /predictive_analytics/pipelines/ | Check which methods are allowed CloudSML.Predictive_analyticsApi | optionsPredictiveModelById | OPTIONS /predictive_analytics/models/{predictive_model_id} | Check which methods are allowed CloudSML.Predictive_analyticsApi | optionsPredictiveModelExportById | OPTIONS /predictive_analytics/models/{predictive_model_id}.{export_format} | Check which methods are allowed CloudSML.Predictive_analyticsApi | optionsPredictiveModelOptimalPerformanceStats | OPTIONS /predictive_analytics/models/{predictive_model_id}/optimal_performance_stats | Check which methods are allowed CloudSML.Predictive_analyticsApi | optionsPredictiveModelPerformanceStats | OPTIONS /predictive_analytics/models/{predictive_model_id}/performance_stats | Check which methods are allowed CloudSML.Predictive_analyticsApi | optionsPredictiveModels | OPTIONS /predictive_analytics/models/ | Check which methods are allowed CloudSML.Predictive_analyticsApi | patchExportedPredictiveModelById | PATCH /predictive_analytics/models/exported_predictive_model/{exported_predictive_model_id} | Patch ExportedPredictiveModel to change status and put proper SeeweedFS File ID CloudSML.Predictive_analyticsApi | patchPipelineById | PATCH /predictive_analytics/pipelines/{pipeline_id} | Modify pipeline by ID CloudSML.Predictive_analyticsApi | patchPredictiveModelById | PATCH /predictive_analytics/models/{predictive_model_id} | Modify predictive model details by ID CloudSML.ScoringsApi | deleteScoringById | DELETE /scorings/{scoring_id} | Delete a scoring by ID CloudSML.ScoringsApi | getScoringById | GET /scorings/{scoring_id} | Get scoring details by ID CloudSML.ScoringsApi | getScorings | GET /scorings/ | List of scorings CloudSML.ScoringsApi | optionsScoringById | OPTIONS /scorings/{scoring_id} | Check which methods are allowed CloudSML.ScoringsApi | optionsScorings | OPTIONS /scorings/ | Check which methods are allowed CloudSML.ScoringsApi | patchScoringById | PATCH /scorings/{scoring_id} | Modify scoring details by ID CloudSML.ScoringsApi | scoreModel | POST /scorings/ | Score a model CloudSML.UsersApi | createUser | POST /users/ | Create a new user CloudSML.UsersApi | getUserById | GET /users/{user_id} | Get user details by ID CloudSML.UsersApi | getUserMe | GET /users/me | Get current user details CloudSML.UsersApi | getUserSignupForm | GET /users/signup_form | Get signup form keys CloudSML.UsersApi | getUsers | GET /users/ | List of users CloudSML.UsersApi | optionsUserById | OPTIONS /users/{user_id} | Check which methods are allowed CloudSML.UsersApi | optionsUserMe | OPTIONS /users/me | Check which methods are allowed CloudSML.UsersApi | optionsUserSignupForm | OPTIONS /users/signup_form | Check which methods are allowed CloudSML.UsersApi | optionsUsers | OPTIONS /users/ | Check which methods are allowed CloudSML.UsersApi | patchUserById | PATCH /users/{user_id} | Patch user details by ID CloudSML.WorkspacesApi | addWorkspaceMember | POST /workspaces/{workspace_id}/members/ | Add a new member to a workspace CloudSML.WorkspacesApi | createWorkspace | POST /workspaces/ | Create a new workspace CloudSML.WorkspacesApi | deleteWorkspaceById | DELETE /workspaces/{workspace_id} | Delete a workspace by ID CloudSML.WorkspacesApi | deleteWorkspaceMemberById | DELETE /workspaces/{workspace_id}/members/{user_id} | Remove a member from a workspace CloudSML.WorkspacesApi | getWorkspaceById | GET /workspaces/{workspace_id} | Get workspace details by ID CloudSML.WorkspacesApi | getWorkspaceMembers | GET /workspaces/{workspace_id}/members/ | Get workspace members by workspace ID CloudSML.WorkspacesApi | getWorkspaces | GET /workspaces/ | List of workspaces CloudSML.WorkspacesApi | optionsWorkspaceById | OPTIONS /workspaces/{workspace_id} | Check which methods are allowed CloudSML.WorkspacesApi | optionsWorkspaceMemberById | OPTIONS /workspaces/{workspace_id}/members/{user_id} | Check which methods are allowed CloudSML.WorkspacesApi | optionsWorkspaceMembers | OPTIONS /workspaces/{workspace_id}/members/ | Check which methods are allowed CloudSML.WorkspacesApi | optionsWorkspaces | OPTIONS /workspaces/ | Check which methods are allowed CloudSML.WorkspacesApi | patchWorkspaceById | PATCH /workspaces/{workspace_id} | Patch workspace details by ID

Documentation for Models

• CloudSML.BaseDataSource
• CloudSML.BaseDataTransformation
• CloudSML.BaseDataTransformationColumn
• CloudSML.BaseExportedPredictiveModel
• CloudSML.BaseMaterializedDataTransformation
• CloudSML.BaseOAuth2Client
• CloudSML.BasePipeline
• CloudSML.BasePredictiveModel
• CloudSML.BasePredictiveModelOptimalPerformanceStats
• CloudSML.BasePredictiveModelOptimalPerformanceStatsLearn
• CloudSML.BasePredictiveModelOptimalPerformanceStatsLearnPartialDependence
• CloudSML.BasePredictiveModelOptimalPerformanceStatsLearnPartialDependenceOutputs
• CloudSML.BasePredictiveModelOptimalPerformanceStatsLearnStagedPerformanceStats
• CloudSML.BasePredictiveModelOptimalPerformanceStatsLearnStagedPerformanceStatsPerformanceStats
• CloudSML.BasePredictiveModelPerformanceStats
• CloudSML.BaseScoring
• CloudSML.BaseUser
• CloudSML.BaseWorkspace
• CloudSML.BaseWorkspaceMember
• CloudSML.BaseWorkspaceMemberWorkspace
• CloudSML.Body
• CloudSML.Body1
• CloudSML.Body2
• CloudSML.Body3
• CloudSML.Body4
• CloudSML.Body5
• CloudSML.Body6
• CloudSML.Body7
• CloudSML.DataTransformationMaterializationSchema
• CloudSML.DetailedDataSource
• CloudSML.DetailedDataTransformation
• CloudSML.DetailedOAuth2Client
• CloudSML.DetailedPipeline
• CloudSML.DetailedPredictiveModel
• CloudSML.DetailedPredictiveModelPipeline
• CloudSML.DetailedScoring
• CloudSML.DetailedScoringDataTransformation
• CloudSML.DetailedScoringDataTransformationDataSource
• CloudSML.DetailedScoringDataTransformationDataSourceCreator
• CloudSML.DetailedScoringPredictiveModel
• CloudSML.DetailedScoringPredictiveModelDataTransformation
• CloudSML.DetailedUser
• CloudSML.DetailedWorkspace
• CloudSML.DetailedWorkspaceMembers
• CloudSML.ExportedDataTransformationSchema
• CloudSML.HTTPError401
• CloudSML.HTTPError403
• CloudSML.HTTPError404
• CloudSML.HTTPError409
• CloudSML.HTTPError422
• CloudSML.PredictiveModelExportSchema
• CloudSML.UserSignupForm

Documentation for Authorization

oauth2_password

• Type: OAuth
• Flow: password
• Authorization URL:
• Scopes:
  • pipelines:read: Provide access to pipelines
  • auth:write: Provide write access to auth details
  • pipelines:write: Provide write access to pipelines
  • data_sources:read: Provide access to data sources
  • scorings:write: Provide write access to scorings
  • users:write: Provide write access to user details
  • users:read: Provide access to user details
  • scorings:read: Provide access to scorings
  • workspaces:read: Provide access to workspace details
  • data_sources:write: Provide write access to data sources
  • data_transformations:write: Provide write access to data transformations
  • workspaces:write: Provide write access to workspace details
  • data_transformations:read: Provide access to data transformations
  • predictive_models:read: Provide access to predictive models
  • predictive_models:write: Provide write access to predictive models
  • auth:read: Provide access to auth details