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

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- IJM.AuthApi | createOauthClient | POST /auth/oauth2_clients/ | Create a new OAuth2 Client IJM.AuthApi | getOAuth2Clients | GET /auth/oauth2_clients/ | List of OAuth2 Clients IJM.AuthApi | optionsOAuth2Clients | OPTIONS /auth/oauth2_clients/ | Check which methods are allowed IJM.DatasetsApi | addDataset | POST /datasets/ | Add a new dataset IJM.DatasetsApi | deleteDatasetById | DELETE /datasets/{dataset_id} | Delete a dataset by ID IJM.DatasetsApi | getDatasetById | GET /datasets/{dataset_id} | Get dataset details by ID IJM.DatasetsApi | getDatasets | GET /datasets/ | List of datasets IJM.DatasetsApi | optionsDatasetById | OPTIONS /datasets/{dataset_id} | Check which methods are allowed IJM.DatasetsApi | optionsDatasets | OPTIONS /datasets/ | Check which methods are allowed IJM.DatasetsApi | patchDatasetById | PATCH /datasets/{dataset_id} | Patch dataset details by ID IJM.DiffreportsApi | buildDiffReport | POST /diff-reports/ | Build a new diff_report IJM.DiffreportsApi | deleteDiffReportById | DELETE /diff-reports/{diff_report_id} | Delete a diff_report by ID IJM.DiffreportsApi | getDiffReportById | GET /diff-reports/{diff_report_id} | Get diff_report details by ID IJM.DiffreportsApi | getDiffReports | GET /diff-reports/ | List of diff-reports IJM.DiffreportsApi | optionsDiffReportById | OPTIONS /diff-reports/{diff_report_id} | Check which methods are allowed IJM.DiffreportsApi | optionsDiffReports | OPTIONS /diff-reports/ | Check which methods are allowed IJM.DiffreportsApi | patchDiffReportById | PATCH /diff-reports/{diff_report_id} | Patch diff_report details by ID IJM.EnginesApi | addEngine | POST /engines/ | Add a new engine IJM.EnginesApi | deleteEngineById | DELETE /engines/{engine_id} | Admin role is required IJM.EnginesApi | getEngineById | GET /engines/{engine_id} | Get engine details by ID IJM.EnginesApi | getEngines | GET /engines/ | List of engines IJM.EnginesApi | optionsEngineById | OPTIONS /engines/{engine_id} | Check which methods are allowed IJM.EnginesApi | optionsEngines | OPTIONS /engines/ | Check which methods are allowed IJM.EnginesApi | patchEngineById | PATCH /engines/{engine_id} | Admin role is required IJM.JobsApi | addJobScript | POST /jobs/{job_id}/scripts/ | Add an script to a job IJM.JobsApi | deleteJobById | DELETE /jobs/{job_id} | Delete a job by ID IJM.JobsApi | getJobById | GET /jobs/{job_id} | Get job details by ID IJM.JobsApi | getJobScriptByName | GET /jobs/{job_id}/scripts/{script_name} | Get job script details by name and job ID IJM.JobsApi | getJobScripts | GET /jobs/{job_id}/scripts/ | List of job scripts IJM.JobsApi | getJobs | GET /jobs/ | List of jobs IJM.JobsApi | optionsJobById | OPTIONS /jobs/{job_id} | Check which methods are allowed IJM.JobsApi | optionsJobScriptByName | OPTIONS /jobs/{job_id}/scripts/{script_name} | Check which methods are allowed IJM.JobsApi | optionsJobScripts | OPTIONS /jobs/{job_id}/scripts/ | Check which methods are allowed IJM.JobsApi | optionsJobs | OPTIONS /jobs/ | Check which methods are allowed IJM.JobsApi | patchJobById | PATCH /jobs/{job_id} | Patch job details by ID IJM.JobsApi | patchJobScriptByName | PATCH /jobs/{job_id}/scripts/{script_name} | Patch job script details by ID IJM.JobsApi | scheduleJob | POST /jobs/ | Schedule a new job IJM.ScriptsApi | addScript | POST /scripts/ | Add a new script IJM.ScriptsApi | deleteScriptById | DELETE /scripts/{script_id} | Delete a script by ID IJM.ScriptsApi | getScriptById | GET /scripts/{script_id} | Get script details by ID IJM.ScriptsApi | getScripts | GET /scripts/ | List of scripts IJM.ScriptsApi | optionsScriptById | OPTIONS /scripts/{script_id} | Check which methods are allowed IJM.ScriptsApi | optionsScripts | OPTIONS /scripts/ | Check which methods are allowed IJM.ScriptsApi | patchScriptById | PATCH /scripts/{script_id} | Patch script details by ID IJM.SuitesApi | addSuiteVariantScript | POST /suites/{suite_id}/variants/{suite_variant_id}/scripts/ | Add an script to a suite variant IJM.SuitesApi | createSuite | POST /suites/ | Create a new suite IJM.SuitesApi | createSuiteVariant | POST /suites/{suite_id}/variants/ | Create a new suite variant IJM.SuitesApi | deleteSuiteById | DELETE /suites/{suite_id} | Delete a suite by ID IJM.SuitesApi | deleteSuiteVariantById | DELETE /suites/{suite_id}/variants/{suite_variant_id} | Delete a suite variant by ID IJM.SuitesApi | deleteSuiteVariantScriptById | DELETE /suites/{suite_id}/variants/{suite_variant_id}/scripts/{script_name} | Delete a suite variant script by ID IJM.SuitesApi | getSuiteById | GET /suites/{suite_id} | Get suite details by ID IJM.SuitesApi | getSuiteVariantById | GET /suites/{suite_id}/variants/{suite_variant_id} | Get suite variant details by ID IJM.SuitesApi | getSuiteVariantScriptById | GET /suites/{suite_id}/variants/{suite_variant_id}/scripts/{script_name} | Get suite variant script details by ID IJM.SuitesApi | getSuiteVariantScripts | GET /suites/{suite_id}/variants/{suite_variant_id}/scripts/ | List of suite variant scripts IJM.SuitesApi | getSuiteVariants | GET /suites/{suite_id}/variants/ | List of suite variants IJM.SuitesApi | getSuites | GET /suites/ | List of suites IJM.SuitesApi | optionsSuiteById | OPTIONS /suites/{suite_id} | Check which methods are allowed IJM.SuitesApi | optionsSuiteVariantById | OPTIONS /suites/{suite_id}/variants/{suite_variant_id} | Check which methods are allowed IJM.SuitesApi | optionsSuiteVariantScriptById | OPTIONS /suites/{suite_id}/variants/{suite_variant_id}/scripts/{script_name} | Check which methods are allowed IJM.SuitesApi | optionsSuiteVariantScripts | OPTIONS /suites/{suite_id}/variants/{suite_variant_id}/scripts/ | Check which methods are allowed IJM.SuitesApi | optionsSuiteVariants | OPTIONS /suites/{suite_id}/variants/ | Check which methods are allowed IJM.SuitesApi | optionsSuites | OPTIONS /suites/ | Check which methods are allowed IJM.SuitesApi | patchSuiteById | PATCH /suites/{suite_id} | Patch suite details by ID IJM.TaskresultdiffsApi | deleteTaskResultDiffByTaskResultIds | DELETE /task-result-diffs/{primary_task_result_id}/{secondary_task_result_id} | Delete a task result diff by task results IDs IJM.TaskresultdiffsApi | getTaskResultDiffAttachmentsByTaskResultIds | GET /task-result-diffs/{primary_task_result_id}/{secondary_task_result_id}/attachments | Get task result diff attachments details by task results IDs IJM.TaskresultdiffsApi | getTaskResultDiffByTaskResultIds | GET /task-result-diffs/{primary_task_result_id}/{secondary_task_result_id} | Get task result diff details by task results IDs IJM.TaskresultdiffsApi | getTaskResultDiffs | GET /task-result-diffs/ | List of task result diffs IJM.TaskresultdiffsApi | optionsTaskResultDiffAttachmentsByTaskResultIDs | OPTIONS /task-result-diffs/{primary_task_result_id}/{secondary_task_result_id}/attachments | Check which methods are allowed IJM.TaskresultdiffsApi | optionsTaskResultDiffByTaskResultIDs | OPTIONS /task-result-diffs/{primary_task_result_id}/{secondary_task_result_id} | Check which methods are allowed IJM.TaskresultdiffsApi | optionsTaskResultDiffs | OPTIONS /task-result-diffs/ | Check which methods are allowed IJM.TaskresultdiffsApi | patchTaskResultDiffByTaskResultIds | PATCH /task-result-diffs/{primary_task_result_id}/{secondary_task_result_id} | Patch task result diff details by task results IDs IJM.TaskresultdiffsApi | scheduleTaskResultDiff | POST /task-result-diffs/ | Schedule task result diff execution IJM.TaskresultsApi | deleteTaskResultById | DELETE /task-results/{task_result_id} | Delete a task result by ID IJM.TaskresultsApi | downloadTaskResultAttachment | POST /task-results/{task_result_id}/attachments/{attachment_name} | Download task result attachment IJM.TaskresultsApi | getTaskResultAttachmentsById | GET /task-results/{task_result_id}/attachments | Get task result details by ID IJM.TaskresultsApi | getTaskResultById | GET /task-results/{task_result_id} | Get task result details by ID IJM.TaskresultsApi | getTaskResults | GET /task-results/ | List of task results IJM.TaskresultsApi | optionsTaskResultAttachmentByName | OPTIONS /task-results/{task_result_id}/attachments/{attachment_name} | Check which methods are allowed IJM.TaskresultsApi | optionsTaskResultAttachmentsById | OPTIONS /task-results/{task_result_id}/attachments | Check which methods are allowed IJM.TaskresultsApi | optionsTaskResultById | OPTIONS /task-results/{task_result_id} | Check which methods are allowed IJM.TaskresultsApi | optionsTaskResults | OPTIONS /task-results/ | Check which methods are allowed IJM.TaskresultsApi | patchTaskResultById | PATCH /task-results/{task_result_id} | Patch task result details by ID IJM.TaskresultsApi | scheduleTask | POST /task-results/ | Schedule task execution IJM.TasksApi | addTask | POST /tasks/ | Add a new task IJM.TasksApi | deleteTaskById | DELETE /tasks/{task_id} | Delete a task by ID IJM.TasksApi | getTaskById | GET /tasks/{task_id} | Get task details by ID IJM.TasksApi | getTasks | GET /tasks/ | List of tasks IJM.TasksApi | optionsTaskById | OPTIONS /tasks/{task_id} | Check which methods are allowed IJM.TasksApi | optionsTasks | OPTIONS /tasks/ | Check which methods are allowed IJM.TasksApi | patchTaskById | PATCH /tasks/{task_id} | Patch task details by ID IJM.UsersApi | createUser | POST /users/ | Create a new user IJM.UsersApi | getUserById | GET /users/{user_id} | Get user details by ID IJM.UsersApi | getUserMe | GET /users/me | Get current user details IJM.UsersApi | getUserSignupForm | GET /users/signup_form | Get signup form keys IJM.UsersApi | getUsers | GET /users/ | List of users IJM.UsersApi | optionsUserById | OPTIONS /users/{user_id} | Check which methods are allowed IJM.UsersApi | optionsUserMe | OPTIONS /users/me | Check which methods are allowed IJM.UsersApi | optionsUserSignupForm | OPTIONS /users/signup_form | Check which methods are allowed IJM.UsersApi | optionsUsers | OPTIONS /users/ | Check which methods are allowed IJM.UsersApi | patchUserById | PATCH /users/{user_id} | Patch user details by ID

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