rmm_api v1.0.0

rmm_api

RmmApi - JavaScript client for rmm_api For this sample, you can use the api key special-key to test the authorization filters. This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 1.0.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 rmm_api --save

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your rmm_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('rmm_api') in javascript files from the directory you ran the last command above from.

git

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

    npm install YOUR_USERNAME/rmm_api --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, that's to say your javascript file where you actually use this library):

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 RmmApi = require('rmm_api');

var defaultClient = RmmApi.ApiClient.instance;

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

var api = new RmmApi.AcceptApi()

var body = new RmmApi.Accept(); // {Accept} Accept object that needs to be added to the store


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.addAccept(body, callback);

Documentation for API Endpoints

All URIs are relative to http://api-dss.virtuhorizon.com/api/v1

Documentation for Models

• RmmApi.Accept
• RmmApi.ApiResponse
• RmmApi.Arg
• RmmApi.Deploymentkey
• RmmApi.Group
• RmmApi.Hostendpoint
• RmmApi.Identifier
• RmmApi.Info
• RmmApi.List
• RmmApi.Log
• RmmApi.ModelVar
• RmmApi.Op
• RmmApi.Schedule
• RmmApi.Sequence
• RmmApi.Stack
• RmmApi.Tag
• RmmApi.Thumbprintkey
• RmmApi.Transaction

Documentation for Authorization

api_auth

• Type: OAuth
• Flow: implicit
• Authorization URL: http://api.virtuhorizon.com/oauth/dialog
• Scopes:
  • read:systems: read your systems
  • write:systems: modify systems in your account

api_key

• Type: API key
• API key parameter name: api_key
• Location: HTTP header