# ipoet_client.IPOETServiceApi

All URIs are relative to *http://localhost/ipoet/rest*

Method | HTTP request | Description
------------- | ------------- | -------------
[**getAnnexObjectiveResults**](IPOETServiceApi.md#getAnnexObjectiveResults) | **GET** /annexObjectives | get annexe objectives
[**getDEASimilarityResults**](IPOETServiceApi.md#getDEASimilarityResults) | **GET** /similarAnnexes | get similar annexes
[**getEngineResults**](IPOETServiceApi.md#getEngineResults) | **GET** /engines | get engine results
[**getEvaluateAllGHWB2019TaskGroupCurrentCapAndModsResults**](IPOETServiceApi.md#getEvaluateAllGHWB2019TaskGroupCurrentCapAndModsResults) | **GET** /evaluate | get EvaluateAllGHWB2019TaskGroup_CurrentCapAndModsResults results
[**getLineItemSpending**](IPOETServiceApi.md#getLineItemSpending) | **GET** /spending | get line item spending
[**getObjectiveResults**](IPOETServiceApi.md#getObjectiveResults) | **GET** /objectives | get Objectives
[**getRootInfo**](IPOETServiceApi.md#getRootInfo) | **GET** / | get service information
[**getShowShipsResults**](IPOETServiceApi.md#getShowShipsResults) | **GET** /showships | get showships results
[**getSimilarityValues**](IPOETServiceApi.md#getSimilarityValues) | **GET** /similarities | get similarity values


<a name="getAnnexObjectiveResults"></a>
# **getAnnexObjectiveResults**
> [AnnexObjectiveResult] getAnnexObjectiveResults(opts)

get annexe objectives



### Example
```javascript
var ipoet_client = require('ipoet-client');

var apiInstance = new ipoet_client.IPOETServiceApi();

var opts = { 
  'instance': "instance_example" // String | Instance
};
apiInstance.getAnnexObjectiveResults(opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **instance** | **String**| Instance | [optional] 

### Return type

[**[AnnexObjectiveResult]**](AnnexObjectiveResult.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json, application/xml

<a name="getDEASimilarityResults"></a>
# **getDEASimilarityResults**
> [DEASimilarityResult] getDEASimilarityResults(opts)

get similar annexes



### Example
```javascript
var ipoet_client = require('ipoet-client');

var apiInstance = new ipoet_client.IPOETServiceApi();

var opts = { 
  'instance': "instance_example" // String | Instance
};
apiInstance.getDEASimilarityResults(opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **instance** | **String**| Instance | [optional] 

### Return type

[**[DEASimilarityResult]**](DEASimilarityResult.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json, application/xml

<a name="getEngineResults"></a>
# **getEngineResults**
> [EngineResult] getEngineResults()

get engine results



### Example
```javascript
var ipoet_client = require('ipoet-client');

var apiInstance = new ipoet_client.IPOETServiceApi();
apiInstance.getEngineResults().then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters
This endpoint does not need any parameter.

### Return type

[**[EngineResult]**](EngineResult.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json, application/xml

<a name="getEvaluateAllGHWB2019TaskGroupCurrentCapAndModsResults"></a>
# **getEvaluateAllGHWB2019TaskGroupCurrentCapAndModsResults**
> [ShipSolutionResult] getEvaluateAllGHWB2019TaskGroupCurrentCapAndModsResults()

get EvaluateAllGHWB2019TaskGroup_CurrentCapAndModsResults results



### Example
```javascript
var ipoet_client = require('ipoet-client');

var apiInstance = new ipoet_client.IPOETServiceApi();
apiInstance.getEvaluateAllGHWB2019TaskGroupCurrentCapAndModsResults().then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters
This endpoint does not need any parameter.

### Return type

[**[ShipSolutionResult]**](ShipSolutionResult.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json, application/xml

<a name="getLineItemSpending"></a>
# **getLineItemSpending**
> [[Object]] getLineItemSpending(opts)

get line item spending



### Example
```javascript
var ipoet_client = require('ipoet-client');

var apiInstance = new ipoet_client.IPOETServiceApi();

var opts = { 
  'country': "country_example" // String | country
};
apiInstance.getLineItemSpending(opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **country** | **String**| country | [optional] 

### Return type

**[[Object]]**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json, application/xml

<a name="getObjectiveResults"></a>
# **getObjectiveResults**
> [ObjectiveResult] getObjectiveResults()

get Objectives



### Example
```javascript
var ipoet_client = require('ipoet-client');

var apiInstance = new ipoet_client.IPOETServiceApi();
apiInstance.getObjectiveResults().then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters
This endpoint does not need any parameter.

### Return type

[**[ObjectiveResult]**](ObjectiveResult.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json, application/xml

<a name="getRootInfo"></a>
# **getRootInfo**
> getRootInfo()

get service information



### Example
```javascript
var ipoet_client = require('ipoet-client');

var apiInstance = new ipoet_client.IPOETServiceApi();
apiInstance.getRootInfo().then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

```

### Parameters
This endpoint does not need any parameter.

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: text/plain

<a name="getShowShipsResults"></a>
# **getShowShipsResults**
> [ShowShipsResult] getShowShipsResults()

get showships results



### Example
```javascript
var ipoet_client = require('ipoet-client');

var apiInstance = new ipoet_client.IPOETServiceApi();
apiInstance.getShowShipsResults().then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters
This endpoint does not need any parameter.

### Return type

[**[ShowShipsResult]**](ShowShipsResult.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json, application/xml

<a name="getSimilarityValues"></a>
# **getSimilarityValues**
> [SimilarityResult] getSimilarityValues()

get similarity values



### Example
```javascript
var ipoet_client = require('ipoet-client');

var apiInstance = new ipoet_client.IPOETServiceApi();
apiInstance.getSimilarityValues().then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

```

### Parameters
This endpoint does not need any parameter.

### Return type

[**[SimilarityResult]**](SimilarityResult.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json, application/xml