job_system_api

JobSystemApi - JavaScript client for job_system_api General data and job management interface. Language specific clients will be generated automatically based on the below specification. Do not write your own http interface to call these APIs. This SDK is automatically generated by the Swagger Codegen project:

• API version: 2.0.3
• Package version: 2.0.3
• 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 job_system_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.

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 JobSystemApi = require('job_system_api');

var api = new JobSystemApi.ConfigApi()

var opts = { 
  'key': "key_example", // {String} The field that will replace ID as unique key in operation if specified
  'body': new JobSystemApi.Config() // {Config} config to be created
};
api.createconfig(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 http://localhost:8888/v1

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- JobSystemApi.ConfigApi | createconfig | POST /config | Create a new config, if key is specified, replace the first matched if found JobSystemApi.ConfigApi | deleteconfig | DELETE /config/${ID} | Delete the config instance based on ID JobSystemApi.ConfigApi | getAllconfig | GET /config | Get the list of all config JobSystemApi.ConfigApi | getconfig | GET /config/${ID} | Get the config instance based on ID JobSystemApi.ConfigApi | updateconfig | PATCH /config/${ID} | Update the config instance based on ID JobSystemApi.DataApi | createdata | POST /data | Create a new data, if key is specified, replace the first matched if found JobSystemApi.DataApi | deletedata | DELETE /data/${ID} | Delete the data instance based on ID JobSystemApi.DataApi | getAlldata | GET /data | Get the list of all data JobSystemApi.DataApi | getdata | GET /data/${ID} | Get the data instance based on ID JobSystemApi.DataApi | updatedata | PATCH /data/${ID} | Update the data instance based on ID JobSystemApi.JobApi | createjob | POST /job | Create a new job, if key is specified, replace the first matched if found JobSystemApi.JobApi | deletejob | DELETE /job/${ID} | Delete the job instance based on ID JobSystemApi.JobApi | getAlljob | GET /job | Get the list of all job JobSystemApi.JobApi | getjob | GET /job/${ID} | Get the job instance based on ID JobSystemApi.JobApi | updatejob | PATCH /job/${ID} | Update the job instance based on ID JobSystemApi.ModelApi | createmodel | POST /model | Create a new model, if key is specified, replace the first matched if found JobSystemApi.ModelApi | deletemodel | DELETE /model/${ID} | Delete the model instance based on ID JobSystemApi.ModelApi | getAllmodel | GET /model | Get the list of all model JobSystemApi.ModelApi | getmodel | GET /model/${ID} | Get the model instance based on ID JobSystemApi.ModelApi | updatemodel | PATCH /model/${ID} | Update the model instance based on ID

Documentation for Models

• JobSystemApi.Config
• JobSystemApi.Data
• JobSystemApi.DataMeta
• JobSystemApi.Dataset
• JobSystemApi.Job
• JobSystemApi.JobStatus
• JobSystemApi.Model
• JobSystemApi.Storage

Documentation for Authorization

All endpoints do not require authorization.