ipoet-client v1.4.0
ipoet-client
ipoet_client - JavaScript client for ipoet-client IPOET Web Application This SDK is automatically generated by the Swagger Codegen project:
- API version: 0.0.1
- 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 ipoet-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.
Getting Started
Please follow the installation instruction and execute the following JS code:
var ipoet_client = require('ipoet-client');
var api = new ipoet_client.IPOETServiceApi()
var opts = {
'instance': "instance_example" // {String} Instance
};
api.getAnnexObjectiveResults(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/ipoet/rest
Class | Method | HTTP request | Description |
---|---|---|---|
ipoet_client.IPOETServiceApi | getAnnexObjectiveResults | GET /annexObjectives | get annexe objectives |
ipoet_client.IPOETServiceApi | getDEASimilarityResults | GET /similarAnnexes | get similar annexes |
ipoet_client.IPOETServiceApi | getEngineResults | GET /engines | get engine results |
ipoet_client.IPOETServiceApi | getEvaluateAllGHWB2019TaskGroupCurrentCapAndModsResults | GET /evaluate | get EvaluateAllGHWB2019TaskGroup_CurrentCapAndModsResults results |
ipoet_client.IPOETServiceApi | getLineItemSpending | GET /spending | get line item spending |
ipoet_client.IPOETServiceApi | getObjectiveResults | GET /objectives | get Objectives |
ipoet_client.IPOETServiceApi | getRootInfo | GET / | get service information |
ipoet_client.IPOETServiceApi | getShowShipsResults | GET /showships | get showships results |
ipoet_client.IPOETServiceApi | getSimilarityValues | GET /similarities | get similarity values |
Documentation for Models
- ipoet_client.AnnexObjectiveResult
- ipoet_client.DEASimilarityResult
- ipoet_client.EngineResult
- ipoet_client.ObjectiveResult
- ipoet_client.ShipSolutionResult
- ipoet_client.ShowShipsResult
- ipoet_client.SimilarityResult
Documentation for Authorization
All endpoints do not require authorization.