Api Documentation

Legacyendpoint

convertOptimizationUsingPOST


/conversion/optimizations

Usage and SDK Samples


curl -X post -H "apiKey: [[apiKey]]" -H "apiSecret: [[apiSecret]]" "https://localhost:8080//conversion/optimizations"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .LegacyendpointApi;

import java.io.File;
import java.util.*;

public class LegacyendpointApiExample {

    public static void main(String[] args) {
        
        LegacyendpointApi apiInstance = new LegacyendpointApi();
        OptimizationDTO input = ; // OptimizationDTO | input
        try {
            OptimizationDTO result = apiInstance.convertOptimizationUsingPOST(input);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LegacyendpointApi#convertOptimizationUsingPOST");
            e.printStackTrace();
        }
    }
}

                                                  

import .LegacyendpointApi;

public class LegacyendpointApiExample {

    public static void main(String[] args) {
        LegacyendpointApi apiInstance = new LegacyendpointApi();
        OptimizationDTO input = ; // OptimizationDTO | input
        try {
            OptimizationDTO result = apiInstance.convertOptimizationUsingPOST(input);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LegacyendpointApi#convertOptimizationUsingPOST");
            e.printStackTrace();
        }
    }
}

                                                  


OptimizationDTO *input = ; // input

LegacyendpointApi *apiInstance = [[LegacyendpointApi alloc] init];

// Convert an optimization in the legacy representation to the new format.
[apiInstance convertOptimizationUsingPOSTWith:input
              completionHandler: ^(OptimizationDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .LegacyendpointApi()

var input = ; // {OptimizationDTO} input


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.convertOptimizationUsingPOST(input, callback);

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class convertOptimizationUsingPOSTExample
    {
        public void main()
        {
            
            var apiInstance = new LegacyendpointApi();
            var input = new OptimizationDTO(); // OptimizationDTO | input

            try
            {
                // Convert an optimization in the legacy representation to the new format.
                OptimizationDTO result = apiInstance.convertOptimizationUsingPOST(input);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LegacyendpointApi.convertOptimizationUsingPOST: " + e.Message );
            }
        }
    }
}

                                                    

convertOptimizationUsingPOST($input);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LegacyendpointApi->convertOptimizationUsingPOST: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Body parameters
Name Description
input *

Responses

Status: 200 - OK

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


createAndInitializeOptimizationLegacyUsingPOST


/legacy/optimizations

Usage and SDK Samples


curl -X post -H "apiKey: [[apiKey]]" -H "apiSecret: [[apiSecret]]" "https://localhost:8080//legacy/optimizations?optimizationMode=&fitnessEstimator=&traceFitnessEvolution=&fitnessMethod=&fitnessPrecision=&additionalParameters="



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .LegacyendpointApi;

import java.io.File;
import java.util.*;

public class LegacyendpointApiExample {

    public static void main(String[] args) {
        
        LegacyendpointApi apiInstance = new LegacyendpointApi();
        OptimizationDTO input = ; // OptimizationDTO | input
        String optimizationMode = optimizationMode_example; // String | the optimization mode
        String fitnessEstimator = fitnessEstimator_example; // String | the fitness estimator used to determine the fitness (logarithmic, sigmoid, linear, etc.)
        Boolean traceFitnessEvolution = true; // Boolean | true if evolution of fitness should be included in stats; used for evaluation.
        String fitnessMethod = fitnessMethod_example; // String | the fitness method used by the Privacy Engine or Optimizer
        Integer fitnessPrecision = 56; // Integer | the precision of the fitness computation
        map[String, String] additionalParameters = ; // map[String, String] | Additional parameters for the optimization
        try {
            OptimizationDTO result = apiInstance.createAndInitializeOptimizationLegacyUsingPOST(input, optimizationMode, fitnessEstimator, traceFitnessEvolution, fitnessMethod, fitnessPrecision, additionalParameters);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LegacyendpointApi#createAndInitializeOptimizationLegacyUsingPOST");
            e.printStackTrace();
        }
    }
}

                                                  

import .LegacyendpointApi;

public class LegacyendpointApiExample {

    public static void main(String[] args) {
        LegacyendpointApi apiInstance = new LegacyendpointApi();
        OptimizationDTO input = ; // OptimizationDTO | input
        String optimizationMode = optimizationMode_example; // String | the optimization mode
        String fitnessEstimator = fitnessEstimator_example; // String | the fitness estimator used to determine the fitness (logarithmic, sigmoid, linear, etc.)
        Boolean traceFitnessEvolution = true; // Boolean | true if evolution of fitness should be included in stats; used for evaluation.
        String fitnessMethod = fitnessMethod_example; // String | the fitness method used by the Privacy Engine or Optimizer
        Integer fitnessPrecision = 56; // Integer | the precision of the fitness computation
        map[String, String] additionalParameters = ; // map[String, String] | Additional parameters for the optimization
        try {
            OptimizationDTO result = apiInstance.createAndInitializeOptimizationLegacyUsingPOST(input, optimizationMode, fitnessEstimator, traceFitnessEvolution, fitnessMethod, fitnessPrecision, additionalParameters);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LegacyendpointApi#createAndInitializeOptimizationLegacyUsingPOST");
            e.printStackTrace();
        }
    }
}

                                                  


OptimizationDTO *input = ; // input
String *optimizationMode = optimizationMode_example; // the optimization mode (optional)
String *fitnessEstimator = fitnessEstimator_example; // the fitness estimator used to determine the fitness (logarithmic, sigmoid, linear, etc.) (optional)
Boolean *traceFitnessEvolution = true; // true if evolution of fitness should be included in stats; used for evaluation. (optional) (default to true)
String *fitnessMethod = fitnessMethod_example; // the fitness method used by the Privacy Engine or Optimizer (optional)
Integer *fitnessPrecision = 56; // the precision of the fitness computation (optional)
map[String, String] *additionalParameters = ; // Additional parameters for the optimization (optional)

LegacyendpointApi *apiInstance = [[LegacyendpointApi alloc] init];

// Create an optimization session with an optimization in the legacy representation as input.
[apiInstance createAndInitializeOptimizationLegacyUsingPOSTWith:input
    optimizationMode:optimizationMode
    fitnessEstimator:fitnessEstimator
    traceFitnessEvolution:traceFitnessEvolution
    fitnessMethod:fitnessMethod
    fitnessPrecision:fitnessPrecision
    additionalParameters:additionalParameters
              completionHandler: ^(OptimizationDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .LegacyendpointApi()

var input = ; // {OptimizationDTO} input

var opts = { 
  'optimizationMode': optimizationMode_example, // {String} the optimization mode
  'fitnessEstimator': fitnessEstimator_example, // {String} the fitness estimator used to determine the fitness (logarithmic, sigmoid, linear, etc.)
  'traceFitnessEvolution': true, // {Boolean} true if evolution of fitness should be included in stats; used for evaluation.
  'fitnessMethod': fitnessMethod_example, // {String} the fitness method used by the Privacy Engine or Optimizer
  'fitnessPrecision': 56, // {Integer} the precision of the fitness computation
  'additionalParameters':  // {map[String, String]} Additional parameters for the optimization
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createAndInitializeOptimizationLegacyUsingPOST(input, opts, callback);

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class createAndInitializeOptimizationLegacyUsingPOSTExample
    {
        public void main()
        {
            
            var apiInstance = new LegacyendpointApi();
            var input = new OptimizationDTO(); // OptimizationDTO | input
            var optimizationMode = optimizationMode_example;  // String | the optimization mode (optional) 
            var fitnessEstimator = fitnessEstimator_example;  // String | the fitness estimator used to determine the fitness (logarithmic, sigmoid, linear, etc.) (optional) 
            var traceFitnessEvolution = true;  // Boolean | true if evolution of fitness should be included in stats; used for evaluation. (optional)  (default to true)
            var fitnessMethod = fitnessMethod_example;  // String | the fitness method used by the Privacy Engine or Optimizer (optional) 
            var fitnessPrecision = 56;  // Integer | the precision of the fitness computation (optional) 
            var additionalParameters = new map[String, String](); // map[String, String] | Additional parameters for the optimization (optional) 

            try
            {
                // Create an optimization session with an optimization in the legacy representation as input.
                OptimizationDTO result = apiInstance.createAndInitializeOptimizationLegacyUsingPOST(input, optimizationMode, fitnessEstimator, traceFitnessEvolution, fitnessMethod, fitnessPrecision, additionalParameters);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LegacyendpointApi.createAndInitializeOptimizationLegacyUsingPOST: " + e.Message );
            }
        }
    }
}

                                                    

createAndInitializeOptimizationLegacyUsingPOST($input, $optimizationMode, $fitnessEstimator, $traceFitnessEvolution, $fitnessMethod, $fitnessPrecision, $additionalParameters);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LegacyendpointApi->createAndInitializeOptimizationLegacyUsingPOST: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Body parameters
Name Description
input *
Query parameters
Name Description
optimizationMode
fitnessEstimator
traceFitnessEvolution
fitnessMethod
fitnessPrecision
additionalParameters

Responses

Status: 200 - OK

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


Optimizationendpoint

abortOptimizationUsingPUT


/optimizations/{optId}/abort

Usage and SDK Samples


curl -X put -H "apiKey: [[apiKey]]" -H "apiSecret: [[apiSecret]]" "https://localhost:8080//optimizations/{optId}/abort"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .OptimizationendpointApi;

import java.io.File;
import java.util.*;

public class OptimizationendpointApiExample {

    public static void main(String[] args) {
        
        OptimizationendpointApi apiInstance = new OptimizationendpointApi();
        String optId = optId_example; // String | the optimization's identifier
        try {
            OptimizationDTO result = apiInstance.abortOptimizationUsingPUT(optId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OptimizationendpointApi#abortOptimizationUsingPUT");
            e.printStackTrace();
        }
    }
}

                                                  

import .OptimizationendpointApi;

public class OptimizationendpointApiExample {

    public static void main(String[] args) {
        OptimizationendpointApi apiInstance = new OptimizationendpointApi();
        String optId = optId_example; // String | the optimization's identifier
        try {
            OptimizationDTO result = apiInstance.abortOptimizationUsingPUT(optId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OptimizationendpointApi#abortOptimizationUsingPUT");
            e.printStackTrace();
        }
    }
}

                                                  


String *optId = optId_example; // the optimization's identifier

OptimizationendpointApi *apiInstance = [[OptimizationendpointApi alloc] init];

// Abort a previously started optimization; if available, an intermediate result can be obtained.
[apiInstance abortOptimizationUsingPUTWith:optId
              completionHandler: ^(OptimizationDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .OptimizationendpointApi()

var optId = optId_example; // {String} the optimization's identifier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.abortOptimizationUsingPUT(optId, callback);

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class abortOptimizationUsingPUTExample
    {
        public void main()
        {
            
            var apiInstance = new OptimizationendpointApi();
            var optId = optId_example;  // String | the optimization's identifier

            try
            {
                // Abort a previously started optimization; if available, an intermediate result can be obtained.
                OptimizationDTO result = apiInstance.abortOptimizationUsingPUT(optId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OptimizationendpointApi.abortOptimizationUsingPUT: " + e.Message );
            }
        }
    }
}

                                                    

abortOptimizationUsingPUT($optId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OptimizationendpointApi->abortOptimizationUsingPUT: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
optId*

Responses

Status: 200 - OK

Status: 201 - Created

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


createAndInitializeOptimizationUsingPOST


/optimizations

Usage and SDK Samples


curl -X post -H "apiKey: [[apiKey]]" -H "apiSecret: [[apiSecret]]" "https://localhost:8080//optimizations"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .OptimizationendpointApi;

import java.io.File;
import java.util.*;

public class OptimizationendpointApiExample {

    public static void main(String[] args) {
        
        OptimizationendpointApi apiInstance = new OptimizationendpointApi();
        OptimizationDTO optimization = ; // OptimizationDTO | optimization
        try {
            OptimizationDTO result = apiInstance.createAndInitializeOptimizationUsingPOST(optimization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OptimizationendpointApi#createAndInitializeOptimizationUsingPOST");
            e.printStackTrace();
        }
    }
}

                                                  

import .OptimizationendpointApi;

public class OptimizationendpointApiExample {

    public static void main(String[] args) {
        OptimizationendpointApi apiInstance = new OptimizationendpointApi();
        OptimizationDTO optimization = ; // OptimizationDTO | optimization
        try {
            OptimizationDTO result = apiInstance.createAndInitializeOptimizationUsingPOST(optimization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OptimizationendpointApi#createAndInitializeOptimizationUsingPOST");
            e.printStackTrace();
        }
    }
}

                                                  


OptimizationDTO *optimization = ; // optimization

OptimizationendpointApi *apiInstance = [[OptimizationendpointApi alloc] init];

// Create and initialize a (heuristic) optimization for flights and slots.
[apiInstance createAndInitializeOptimizationUsingPOSTWith:optimization
              completionHandler: ^(OptimizationDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .OptimizationendpointApi()

var optimization = ; // {OptimizationDTO} optimization


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createAndInitializeOptimizationUsingPOST(optimization, callback);

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class createAndInitializeOptimizationUsingPOSTExample
    {
        public void main()
        {
            
            var apiInstance = new OptimizationendpointApi();
            var optimization = new OptimizationDTO(); // OptimizationDTO | optimization

            try
            {
                // Create and initialize a (heuristic) optimization for flights and slots.
                OptimizationDTO result = apiInstance.createAndInitializeOptimizationUsingPOST(optimization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OptimizationendpointApi.createAndInitializeOptimizationUsingPOST: " + e.Message );
            }
        }
    }
}

                                                    

createAndInitializeOptimizationUsingPOST($optimization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OptimizationendpointApi->createAndInitializeOptimizationUsingPOST: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Body parameters
Name Description
optimization *

Responses

Status: 200 - OK

Status: 201 - Created

Status: 400 - Bad Request

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


deleteOptimizationResultUsingDELETE


/optimizations/{optId}

Usage and SDK Samples


curl -X delete -H "apiKey: [[apiKey]]" -H "apiSecret: [[apiSecret]]" "https://localhost:8080//optimizations/{optId}"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .OptimizationendpointApi;

import java.io.File;
import java.util.*;

public class OptimizationendpointApiExample {

    public static void main(String[] args) {
        
        OptimizationendpointApi apiInstance = new OptimizationendpointApi();
        String optId = optId_example; // String | the optimization's identifier
        try {
            apiInstance.deleteOptimizationResultUsingDELETE(optId);
        } catch (ApiException e) {
            System.err.println("Exception when calling OptimizationendpointApi#deleteOptimizationResultUsingDELETE");
            e.printStackTrace();
        }
    }
}

                                                  

import .OptimizationendpointApi;

public class OptimizationendpointApiExample {

    public static void main(String[] args) {
        OptimizationendpointApi apiInstance = new OptimizationendpointApi();
        String optId = optId_example; // String | the optimization's identifier
        try {
            apiInstance.deleteOptimizationResultUsingDELETE(optId);
        } catch (ApiException e) {
            System.err.println("Exception when calling OptimizationendpointApi#deleteOptimizationResultUsingDELETE");
            e.printStackTrace();
        }
    }
}

                                                  


String *optId = optId_example; // the optimization's identifier

OptimizationendpointApi *apiInstance = [[OptimizationendpointApi alloc] init];

// Delete an optimization and its results, if available. Abort a running optimization. 
[apiInstance deleteOptimizationResultUsingDELETEWith:optId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .OptimizationendpointApi()

var optId = optId_example; // {String} the optimization's identifier


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class deleteOptimizationResultUsingDELETEExample
    {
        public void main()
        {
            
            var apiInstance = new OptimizationendpointApi();
            var optId = optId_example;  // String | the optimization's identifier

            try
            {
                // Delete an optimization and its results, if available. Abort a running optimization. 
                apiInstance.deleteOptimizationResultUsingDELETE(optId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OptimizationendpointApi.deleteOptimizationResultUsingDELETE: " + e.Message );
            }
        }
    }
}

                                                    

deleteOptimizationResultUsingDELETE($optId);
} catch (Exception $e) {
    echo 'Exception when calling OptimizationendpointApi->deleteOptimizationResultUsingDELETE: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
optId*

Responses

Status: 200 - OK

Status: 204 - No Content

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getOptimizationResultUsingGET


/optimizations/{optId}/result

Usage and SDK Samples


curl -X get -H "apiKey: [[apiKey]]" -H "apiSecret: [[apiSecret]]" "https://localhost:8080//optimizations/{optId}/result?limit="



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .OptimizationendpointApi;

import java.io.File;
import java.util.*;

public class OptimizationendpointApiExample {

    public static void main(String[] args) {
        
        OptimizationendpointApi apiInstance = new OptimizationendpointApi();
        String optId = optId_example; // String | the optimization's identifier
        Integer limit = 56; // Integer | the number of solutions to be returned
        try {
            array[OptimizationResultDTO] result = apiInstance.getOptimizationResultUsingGET(optId, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OptimizationendpointApi#getOptimizationResultUsingGET");
            e.printStackTrace();
        }
    }
}

                                                  

import .OptimizationendpointApi;

public class OptimizationendpointApiExample {

    public static void main(String[] args) {
        OptimizationendpointApi apiInstance = new OptimizationendpointApi();
        String optId = optId_example; // String | the optimization's identifier
        Integer limit = 56; // Integer | the number of solutions to be returned
        try {
            array[OptimizationResultDTO] result = apiInstance.getOptimizationResultUsingGET(optId, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OptimizationendpointApi#getOptimizationResultUsingGET");
            e.printStackTrace();
        }
    }
}

                                                  


String *optId = optId_example; // the optimization's identifier
Integer *limit = 56; // the number of solutions to be returned (optional) (default to 1)

OptimizationendpointApi *apiInstance = [[OptimizationendpointApi alloc] init];

// Get the n best solutions found by an optimization run, if available.
[apiInstance getOptimizationResultUsingGETWith:optId
    limit:limit
              completionHandler: ^(array[OptimizationResultDTO] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .OptimizationendpointApi()

var optId = optId_example; // {String} the optimization's identifier

var opts = { 
  'limit': 56 // {Integer} the number of solutions to be returned
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOptimizationResultUsingGET(optId, opts, callback);

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class getOptimizationResultUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new OptimizationendpointApi();
            var optId = optId_example;  // String | the optimization's identifier
            var limit = 56;  // Integer | the number of solutions to be returned (optional)  (default to 1)

            try
            {
                // Get the n best solutions found by an optimization run, if available.
                array[OptimizationResultDTO] result = apiInstance.getOptimizationResultUsingGET(optId, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OptimizationendpointApi.getOptimizationResultUsingGET: " + e.Message );
            }
        }
    }
}

                                                    

getOptimizationResultUsingGET($optId, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OptimizationendpointApi->getOptimizationResultUsingGET: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
optId*
Query parameters
Name Description
limit

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found; no result available or optimization does not exist


getOptimizationStatisticsUsingGET


/optimizations/{optId}/stats

Usage and SDK Samples


curl -X get -H "apiKey: [[apiKey]]" -H "apiSecret: [[apiSecret]]" "https://localhost:8080//optimizations/{optId}/stats"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .OptimizationendpointApi;

import java.io.File;
import java.util.*;

public class OptimizationendpointApiExample {

    public static void main(String[] args) {
        
        OptimizationendpointApi apiInstance = new OptimizationendpointApi();
        String optId = optId_example; // String | the optimization's identifier
        try {
            OptimizationStatisticsDTO result = apiInstance.getOptimizationStatisticsUsingGET(optId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OptimizationendpointApi#getOptimizationStatisticsUsingGET");
            e.printStackTrace();
        }
    }
}

                                                  

import .OptimizationendpointApi;

public class OptimizationendpointApiExample {

    public static void main(String[] args) {
        OptimizationendpointApi apiInstance = new OptimizationendpointApi();
        String optId = optId_example; // String | the optimization's identifier
        try {
            OptimizationStatisticsDTO result = apiInstance.getOptimizationStatisticsUsingGET(optId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OptimizationendpointApi#getOptimizationStatisticsUsingGET");
            e.printStackTrace();
        }
    }
}

                                                  


String *optId = optId_example; // the optimization's identifier

OptimizationendpointApi *apiInstance = [[OptimizationendpointApi alloc] init];

// Get current statistics for a specific optimization and its results, if available.
[apiInstance getOptimizationStatisticsUsingGETWith:optId
              completionHandler: ^(OptimizationStatisticsDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .OptimizationendpointApi()

var optId = optId_example; // {String} the optimization's identifier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOptimizationStatisticsUsingGET(optId, callback);

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class getOptimizationStatisticsUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new OptimizationendpointApi();
            var optId = optId_example;  // String | the optimization's identifier

            try
            {
                // Get current statistics for a specific optimization and its results, if available.
                OptimizationStatisticsDTO result = apiInstance.getOptimizationStatisticsUsingGET(optId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OptimizationendpointApi.getOptimizationStatisticsUsingGET: " + e.Message );
            }
        }
    }
}

                                                    

getOptimizationStatisticsUsingGET($optId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OptimizationendpointApi->getOptimizationStatisticsUsingGET: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
optId*

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getOptimizationUsingGET


/optimizations/{optId}

Usage and SDK Samples


curl -X get -H "apiKey: [[apiKey]]" -H "apiSecret: [[apiSecret]]" "https://localhost:8080//optimizations/{optId}"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .OptimizationendpointApi;

import java.io.File;
import java.util.*;

public class OptimizationendpointApiExample {

    public static void main(String[] args) {
        
        OptimizationendpointApi apiInstance = new OptimizationendpointApi();
        String optId = optId_example; // String | the optimization's identifier
        try {
            OptimizationDTO result = apiInstance.getOptimizationUsingGET(optId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OptimizationendpointApi#getOptimizationUsingGET");
            e.printStackTrace();
        }
    }
}

                                                  

import .OptimizationendpointApi;

public class OptimizationendpointApiExample {

    public static void main(String[] args) {
        OptimizationendpointApi apiInstance = new OptimizationendpointApi();
        String optId = optId_example; // String | the optimization's identifier
        try {
            OptimizationDTO result = apiInstance.getOptimizationUsingGET(optId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OptimizationendpointApi#getOptimizationUsingGET");
            e.printStackTrace();
        }
    }
}

                                                  


String *optId = optId_example; // the optimization's identifier

OptimizationendpointApi *apiInstance = [[OptimizationendpointApi alloc] init];

// Get the description of a specific optimization.
[apiInstance getOptimizationUsingGETWith:optId
              completionHandler: ^(OptimizationDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .OptimizationendpointApi()

var optId = optId_example; // {String} the optimization's identifier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOptimizationUsingGET(optId, callback);

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class getOptimizationUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new OptimizationendpointApi();
            var optId = optId_example;  // String | the optimization's identifier

            try
            {
                // Get the description of a specific optimization.
                OptimizationDTO result = apiInstance.getOptimizationUsingGET(optId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OptimizationendpointApi.getOptimizationUsingGET: " + e.Message );
            }
        }
    }
}

                                                    

getOptimizationUsingGET($optId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OptimizationendpointApi->getOptimizationUsingGET: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
optId*

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


getOptimizationsUsingGET


/optimizations

Usage and SDK Samples


curl -X get -H "apiKey: [[apiKey]]" -H "apiSecret: [[apiSecret]]" "https://localhost:8080//optimizations"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .OptimizationendpointApi;

import java.io.File;
import java.util.*;

public class OptimizationendpointApiExample {

    public static void main(String[] args) {
        
        OptimizationendpointApi apiInstance = new OptimizationendpointApi();
        try {
            array[OptimizationDTO] result = apiInstance.getOptimizationsUsingGET();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OptimizationendpointApi#getOptimizationsUsingGET");
            e.printStackTrace();
        }
    }
}

                                                  

import .OptimizationendpointApi;

public class OptimizationendpointApiExample {

    public static void main(String[] args) {
        OptimizationendpointApi apiInstance = new OptimizationendpointApi();
        try {
            array[OptimizationDTO] result = apiInstance.getOptimizationsUsingGET();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OptimizationendpointApi#getOptimizationsUsingGET");
            e.printStackTrace();
        }
    }
}

                                                  



OptimizationendpointApi *apiInstance = [[OptimizationendpointApi alloc] init];

// Get descriptions of all currently registered optimizations.
[apiInstance getOptimizationsUsingGETWithCompletionHandler: 
              ^(array[OptimizationDTO] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .OptimizationendpointApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getOptimizationsUsingGET(callback);

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class getOptimizationsUsingGETExample
    {
        public void main()
        {
            
            var apiInstance = new OptimizationendpointApi();

            try
            {
                // Get descriptions of all currently registered optimizations.
                array[OptimizationDTO] result = apiInstance.getOptimizationsUsingGET();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OptimizationendpointApi.getOptimizationsUsingGET: " + e.Message );
            }
        }
    }
}

                                                    

getOptimizationsUsingGET();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OptimizationendpointApi->getOptimizationsUsingGET: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Responses

Status: 200 - OK

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


startOptimizationSyncUsingPUT


/optimizations/{optId}/start/wait

Usage and SDK Samples


curl -X put -H "apiKey: [[apiKey]]" -H "apiSecret: [[apiSecret]]" "https://localhost:8080//optimizations/{optId}/start/wait"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .OptimizationendpointApi;

import java.io.File;
import java.util.*;

public class OptimizationendpointApiExample {

    public static void main(String[] args) {
        
        OptimizationendpointApi apiInstance = new OptimizationendpointApi();
        String optId = optId_example; // String | the optimization's identifier
        try {
            OptimizationResultDTO result = apiInstance.startOptimizationSyncUsingPUT(optId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OptimizationendpointApi#startOptimizationSyncUsingPUT");
            e.printStackTrace();
        }
    }
}

                                                  

import .OptimizationendpointApi;

public class OptimizationendpointApiExample {

    public static void main(String[] args) {
        OptimizationendpointApi apiInstance = new OptimizationendpointApi();
        String optId = optId_example; // String | the optimization's identifier
        try {
            OptimizationResultDTO result = apiInstance.startOptimizationSyncUsingPUT(optId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OptimizationendpointApi#startOptimizationSyncUsingPUT");
            e.printStackTrace();
        }
    }
}

                                                  


String *optId = optId_example; // the optimization's identifier

OptimizationendpointApi *apiInstance = [[OptimizationendpointApi alloc] init];

// Run a previously created and initialized optimization in a synchronized way, waiting for the response.
[apiInstance startOptimizationSyncUsingPUTWith:optId
              completionHandler: ^(OptimizationResultDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .OptimizationendpointApi()

var optId = optId_example; // {String} the optimization's identifier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.startOptimizationSyncUsingPUT(optId, callback);

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class startOptimizationSyncUsingPUTExample
    {
        public void main()
        {
            
            var apiInstance = new OptimizationendpointApi();
            var optId = optId_example;  // String | the optimization's identifier

            try
            {
                // Run a previously created and initialized optimization in a synchronized way, waiting for the response.
                OptimizationResultDTO result = apiInstance.startOptimizationSyncUsingPUT(optId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OptimizationendpointApi.startOptimizationSyncUsingPUT: " + e.Message );
            }
        }
    }
}

                                                    

startOptimizationSyncUsingPUT($optId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OptimizationendpointApi->startOptimizationSyncUsingPUT: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
optId*

Responses

Status: 200 - OK

Status: 201 - Created

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


startOptimizationUsingPUT


/optimizations/{optId}/start

Usage and SDK Samples


curl -X put -H "apiKey: [[apiKey]]" -H "apiSecret: [[apiSecret]]" "https://localhost:8080//optimizations/{optId}/start"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .OptimizationendpointApi;

import java.io.File;
import java.util.*;

public class OptimizationendpointApiExample {

    public static void main(String[] args) {
        
        OptimizationendpointApi apiInstance = new OptimizationendpointApi();
        String optId = optId_example; // String | the optimization's identifier
        try {
            OptimizationDTO result = apiInstance.startOptimizationUsingPUT(optId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OptimizationendpointApi#startOptimizationUsingPUT");
            e.printStackTrace();
        }
    }
}

                                                  

import .OptimizationendpointApi;

public class OptimizationendpointApiExample {

    public static void main(String[] args) {
        OptimizationendpointApi apiInstance = new OptimizationendpointApi();
        String optId = optId_example; // String | the optimization's identifier
        try {
            OptimizationDTO result = apiInstance.startOptimizationUsingPUT(optId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OptimizationendpointApi#startOptimizationUsingPUT");
            e.printStackTrace();
        }
    }
}

                                                  


String *optId = optId_example; // the optimization's identifier

OptimizationendpointApi *apiInstance = [[OptimizationendpointApi alloc] init];

// Start a specific optimization that was previously created and initialized.
[apiInstance startOptimizationUsingPUTWith:optId
              completionHandler: ^(OptimizationDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .OptimizationendpointApi()

var optId = optId_example; // {String} the optimization's identifier


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.startOptimizationUsingPUT(optId, callback);

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class startOptimizationUsingPUTExample
    {
        public void main()
        {
            
            var apiInstance = new OptimizationendpointApi();
            var optId = optId_example;  // String | the optimization's identifier

            try
            {
                // Start a specific optimization that was previously created and initialized.
                OptimizationDTO result = apiInstance.startOptimizationUsingPUT(optId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OptimizationendpointApi.startOptimizationUsingPUT: " + e.Message );
            }
        }
    }
}

                                                    

startOptimizationUsingPUT($optId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OptimizationendpointApi->startOptimizationUsingPUT: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
optId*

Responses

Status: 200 - OK; the optimization is already running.

Status: 201 - Created

Status: 202 - Accepted; if the optimization was successfully started.

Status: 303 - See Other; returns location of result in header, if cancelled or already done.

Status: 401 - Unauthorized

Status: 403 - Forbidden

Status: 404 - Not Found


Generated 2022-06-21T16:36:52.020+02:00