nqm_inq_client

NqmInqClient - JavaScript client for nqm_inq_client API for NquiringMinds InterliNQ Database. This SDK is automatically generated by the Swagger Codegen project:

• API version: 0.1.2
• Package version: 0.1.2
• 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 nqm_inq_client --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 nqm_inq_client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('nqm_inq_client') 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/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, 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 NqmInqClient = require('nqm_inq_client');
 
var api = new NqmInqClient.CommandApi()
 
var addDataBody = new NqmInqClient.AddDataBody(); // {AddDataBody} The `datasetId` and list of row objects to add to the database.
 
var commandType = "commandType_example"; // {String} command type (currently only `command` is supported).
 
 
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addData(addDataBody, commandType, callback);
 

Documentation for API Endpoints

All URIs are relative to http://192.168.1.201:3212

Class	Method	HTTP request	Description
NqmInqClient.CommandApi	addData	POST /{commandType}/dataset/data/createMany	Add some data to a dataset
NqmInqClient.CommandApi	updateData	POST /{commandType}/dataset/data/updateMany	Update some data in a dataset
NqmInqClient.QueryApi	getData	GET /datasets/{datasetId}/data	Get the data for a given resourse.
NqmInqClient.QueryApi	getDistinct	GET /datasets/{datasetId}/distinct	Gets a list of distinct values for a given property in a dataset-based resource.
NqmInqClient.QueryApi	getResource	GET /datasets/{datasetId}	Get the metadata for a given resourse.
NqmInqClient.QueryApi	getResources	GET /resources	Get a list of all the resources available.

Documentation for Models

• NqmInqClient.AddDataBody
• NqmInqClient.CommandResult
• NqmInqClient.CommandResultResult
• NqmInqClient.DatasetData
• NqmInqClient.Error404
• NqmInqClient.InlineResponse200
• NqmInqClient.InlineResponse400
• NqmInqClient.Resource
• NqmInqClient.UpdateDataBody

Documentation for Authorization

All endpoints do not require authorization.