ijm-client v1.9.1

ijm-client

IJM - JavaScript client for ijm-client You will need to know the API Client ID to authenticate, so here it is: documentation. Sometimes (e.g. for token refreshing) you might need API Client Secret: KQ()SWK)SQK)QWSKQW(SKQ)S(QWSQW(SJ*HQ&HQW*SQ*^SSQWSGQSG. There are also two built-in users: root (administrator with all permissions) with password q user (regular user) with password w This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.9.1
• Package version: 1.9.1
• 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 ijm-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.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

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

var IJM = require('ijm-client');

var defaultClient = IJM.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 IJM.AuthApi()

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

var opts = { 
  'redirectUris': ["redirectUris_example"] // {[String]} 
};
api.createOauthClient(defaultScopes, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

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

Documentation for Models

• IJM.BaseDataset
• IJM.BaseDiffReport
• IJM.BaseDiffReportPrimaryJob
• IJM.BaseEngine
• IJM.BaseEngineEngineType
• IJM.BaseJob
• IJM.BaseJobEngine
• IJM.BaseJobScript
• IJM.BaseOAuth2Client
• IJM.BaseScript
• IJM.BaseSuite
• IJM.BaseSuiteVariant
• IJM.BaseSuiteVariantScript
• IJM.BaseSuiteVariantScriptScript
• IJM.BaseSuiteVariantScriptSuiteVariant
• IJM.BaseSuiteVariantSuite
• IJM.BaseTask
• IJM.BaseTaskResult
• IJM.BaseTaskResultDiff
• IJM.BaseTaskResultDiffPrimaryTaskResult
• IJM.BaseUser
• IJM.Body
• IJM.Body1
• IJM.Body2
• IJM.Body3
• IJM.Body4
• IJM.Body5
• IJM.Body6
• IJM.Body7
• IJM.DetailedDataset
• IJM.DetailedDiffReport
• IJM.DetailedEngine
• IJM.DetailedJob
• IJM.DetailedJobScript
• IJM.DetailedOAuth2Client
• IJM.DetailedScript
• IJM.DetailedSuite
• IJM.DetailedSuiteVariant
• IJM.DetailedSuiteVariantScript
• IJM.DetailedSuiteVariantScriptScript
• IJM.DetailedSuiteVariantSuite
• IJM.DetailedTask
• IJM.DetailedTaskDatasets
• IJM.DetailedTaskResult
• IJM.DetailedTaskResultAttachment
• IJM.DetailedTaskResultAttachments
• IJM.DetailedTaskResultDiff
• IJM.DetailedTaskResultDiffAttachment
• IJM.DetailedTaskResultTask
• IJM.DetailedTaskSuiteVariant
• IJM.DetailedUser
• IJM.HTTPError401
• IJM.HTTPError403
• IJM.HTTPError404
• IJM.HTTPError409
• IJM.HTTPError422
• IJM.TaskResultAttachmentFileSchema
• IJM.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
  • users:read: Provide access to user details
  • users:write: Provide write access to user details
  • datasets:read: Provide access to dataset details
  • datasets:write: Provide write access to dataset details
  • engines:read: Provide access to engine details
  • engines:write: Provide write access to engine details
  • scripts:read: Provide access to script details
  • scripts:write: Provide write access to script details
  • suites:read: Provide access to suite details
  • suites:write: Provide write access to suite details
  • tasks:read: Provide access to task details
  • tasks:write: Provide write access to task details
  • jobs:read: Provide access to job details
  • jobs:write: Provide write access to job details
  • task-results:read: Provide access to task result details
  • task-results:write: Provide write access to task result details
  • diff-reports:read: Provide access to job details
  • diff-reports:write: Provide write access to job details
  • task-result-diffs:read: Provide access to task result diffs details
  • task-result-diffs:write: Provide write access to task result diffs details