measurement_storage_api v1.0.4
measurement_storage_api
MeasurementStorageApi - JavaScript client for measurement_storage_api This the Measurement Storage API used for storing Measurement Sessions, Measurements and Measurement Application/Client/Server configurations. 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 measurement_storage_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 measurement_storage_api from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
You should now be able to require('measurement_storage_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/measurement_storage_api then install it via:
npm install YOUR_USERNAME/measurement_storage_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 MeasurementStorageApi = require('measurement_storage_api');
var api = new MeasurementStorageApi.MeasurementSessionApi()
var body = new MeasurementStorageApi.MeasurementSession(); // {MeasurementSession} Created Measurement Session object
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
api.addMeasurementSession(body, callback);
Documentation for API Endpoints
All URIs are relative to https://virtserver.swaggerhub.com/koller_dev/MeasurementStorageAPI/1.0.0
Class | Method | HTTP request | Description |
---|---|---|---|
MeasurementStorageApi.MeasurementSessionApi | addMeasurementSession | POST /measurement-session | Add a new measurement session |
MeasurementStorageApi.MeasurementSessionApi | addMeasurementSessionWithId | POST /measurement-session/lorawan-measurements/{measurementSessionId} | Find measurement session by unique measurement session id |
MeasurementStorageApi.MeasurementSessionApi | addNbIotMeasurementSessionWithId | POST /measurement-session/nb-iot-measurements/{measurementSessionId} | Find measurement session by unique measurement session id |
MeasurementStorageApi.MeasurementSessionApi | deleteMeasurementSession | DELETE /measurement-session/{measurementSessionId} | Deletes a measurement session |
MeasurementStorageApi.MeasurementSessionApi | getMeasurementSessionById | GET /measurement-session/{measurementSessionId} | Find measurement session by unique measurement session id |
Documentation for Models
- MeasurementStorageApi.LoRaWanGateway
- MeasurementStorageApi.LoRaWanMeasurementRaw
- MeasurementStorageApi.LoRaWanMetadata
- MeasurementStorageApi.Location
- MeasurementStorageApi.Measurement
- MeasurementStorageApi.MeasurementSession
- MeasurementStorageApi.NbIotMeasurementRaw
Documentation for Authorization
api_key
- Type: API key
- API key parameter name: api_key
- Location: HTTP header
petstore_auth
- Type: OAuth
- Flow: implicit
- Authorization URL: http://petstore.swagger.io/oauth/dialog
- Scopes:
- write:pets: modify pets in your account
- read:pets: read your pets