cloud_sml_api v1.0.5

cloud_sml_api

CloudSmlApi - JavaScript client for cloud_sml_api 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.0
• Package version: 1.0
• 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 cloud_sml_api --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 CloudSmlApi = require('cloud_sml_api');

var defaultClient = CloudSmlApi.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 CloudSmlApi.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

Documentation for Models

• CloudSmlApi.BaseDataSource
• CloudSmlApi.BaseDataSourceColumn
• CloudSmlApi.BaseDataSourceCreator
• CloudSmlApi.BaseDataTransformation
• CloudSmlApi.BaseDataTransformationDataSource
• CloudSmlApi.BaseExportedPredictiveModel
• CloudSmlApi.BaseMaterializedDataTransformation
• CloudSmlApi.BaseOAuth2Client
• CloudSmlApi.BasePredictiveEnsemble
• CloudSmlApi.BasePredictiveModel
• CloudSmlApi.BasePredictiveModelDataTransformation
• CloudSmlApi.BasePredictiveModelOptimalPerformanceStats
• CloudSmlApi.BasePredictiveModelPerformanceStats
• CloudSmlApi.BaseScoring
• CloudSmlApi.BaseScoringDataTransformation
• CloudSmlApi.BaseScoringPredictiveModel
• CloudSmlApi.BaseUser
• CloudSmlApi.BaseWorkspace
• CloudSmlApi.BaseWorkspaceMember
• CloudSmlApi.BaseWorkspaceMemberWorkspace
• CloudSmlApi.Body
• CloudSmlApi.Body1
• CloudSmlApi.Body2
• CloudSmlApi.Body3
• CloudSmlApi.Body4
• CloudSmlApi.Body5
• CloudSmlApi.Body6
• CloudSmlApi.DataTransformationMaterializationSchema
• CloudSmlApi.DetailedDataSource
• CloudSmlApi.DetailedDataTransformation
• CloudSmlApi.DetailedOAuth2Client
• CloudSmlApi.DetailedPredictiveEnsemble
• CloudSmlApi.DetailedPredictiveModel
• CloudSmlApi.DetailedScoring
• CloudSmlApi.DetailedUser
• CloudSmlApi.DetailedWorkspace
• CloudSmlApi.DetailedWorkspaceMembers
• CloudSmlApi.ExportedDataTransformationSchema
• CloudSmlApi.HTTPError401
• CloudSmlApi.HTTPError403
• CloudSmlApi.HTTPError404
• CloudSmlApi.HTTPError409
• CloudSmlApi.HTTPError422
• CloudSmlApi.PredictiveModelExportSchema
• CloudSmlApi.UserSignupForm

Documentation for Authorization

oauth2_password

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