Zahner Analysis Remote Evaluation - RemoteEval

Common

idGet

Get version and status information about Zahner Analysis

Get version and status information about Zahner Analysis


/id

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"http://localhost:{port}/id"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CommonApi;

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

public class CommonApiExample {

    public static void main(String[] args) {
        
        CommonApi apiInstance = new CommonApi();
        try {
            AnalysisRemoteId result = apiInstance.idGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommonApi#idGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CommonApi;

public class CommonApiExample {

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

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

// Get version and status information about Zahner Analysis
[apiInstance idGetWithCompletionHandler: 
              ^(AnalysisRemoteId output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var ZahnerAnalysisRemoteEvaluationRemoteEval = require('zahner_analysis_remote_evaluation____remote_eval');

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

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class idGetExample
    {
        public void main()
        {

            var apiInstance = new CommonApi();

            try
            {
                // Get version and status information about Zahner Analysis
                AnalysisRemoteId result = apiInstance.idGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CommonApi.idGet: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCommonApi();

try {
    $result = $api_instance->idGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommonApi->idGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CommonApi;

my $api_instance = WWW::SwaggerClient::CommonApi->new();

eval { 
    my $result = $api_instance->idGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommonApi->idGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CommonApi()

try: 
    # Get version and status information about Zahner Analysis
    api_response = api_instance.id_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommonApi->idGet: %s\n" % e)

Parameters

Responses

Status: 200 - Version and status information about Zahner Analysis

rootGet

A web page with an example form for testing remote evaluation (for humans)

A simple website with a form for testing remote evaluation. The HTML file may be customized if needed and can be found here: _C:\Program Files\Zahner\ZahnerAnalysis\remote_eval.html_


/

Usage and SDK Samples

curl -X GET\
-H "Accept: text/html"\
"http://localhost:{port}/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CommonApi;

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

public class CommonApiExample {

    public static void main(String[] args) {
        
        CommonApi apiInstance = new CommonApi();
        try {
            'String' result = apiInstance.rootGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommonApi#rootGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CommonApi;

public class CommonApiExample {

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

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

// A web page with an example form for testing remote evaluation (for humans)
[apiInstance rootGetWithCompletionHandler: 
              ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var ZahnerAnalysisRemoteEvaluationRemoteEval = require('zahner_analysis_remote_evaluation____remote_eval');

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

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class rootGetExample
    {
        public void main()
        {

            var apiInstance = new CommonApi();

            try
            {
                // A web page with an example form for testing remote evaluation (for humans)
                'String' result = apiInstance.rootGet();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CommonApi.rootGet: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCommonApi();

try {
    $result = $api_instance->rootGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommonApi->rootGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CommonApi;

my $api_instance = WWW::SwaggerClient::CommonApi->new();

eval { 
    my $result = $api_instance->rootGet();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommonApi->rootGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CommonApi()

try: 
    # A web page with an example form for testing remote evaluation (for humans)
    api_response = api_instance.root_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommonApi->rootGet: %s\n" % e)

Parameters

Responses

Status: 200 - The Webpage

Jobs

jobJobIdModelGet

Download the fitted model

Download the fitted model


/job/{job-id}/model

Usage and SDK Samples

curl -X GET\
-H "Accept: application/octet-stream"\
"http://localhost:{port}/job/{job-id}/model?key="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JobsApi;

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

public class JobsApiExample {

    public static void main(String[] args) {
        
        JobsApi apiInstance = new JobsApi();
        UUID jobId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        String key = ; // String | 
        try {
            byte[] result = apiInstance.jobJobIdModelGet(jobId, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#jobJobIdModelGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JobsApi;

public class JobsApiExample {

    public static void main(String[] args) {
        JobsApi apiInstance = new JobsApi();
        UUID jobId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        String key = ; // String | 
        try {
            byte[] result = apiInstance.jobJobIdModelGet(jobId, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#jobJobIdModelGet");
            e.printStackTrace();
        }
    }
}
UUID *jobId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // 
String *key = ; //  (optional)

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

// Download the fitted model
[apiInstance jobJobIdModelGetWith:jobId
    key:key
              completionHandler: ^(byte[] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var ZahnerAnalysisRemoteEvaluationRemoteEval = require('zahner_analysis_remote_evaluation____remote_eval');

var api = new ZahnerAnalysisRemoteEvaluationRemoteEval.JobsApi()
var jobId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} 
var opts = { 
  'key':  // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.jobJobIdModelGet(jobId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class jobJobIdModelGetExample
    {
        public void main()
        {

            var apiInstance = new JobsApi();
            var jobId = new UUID(); // UUID | 
            var key = new String(); // String |  (optional) 

            try
            {
                // Download the fitted model
                byte[] result = apiInstance.jobJobIdModelGet(jobId, key);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JobsApi.jobJobIdModelGet: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiJobsApi();
$jobId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$key = ; // String | 

try {
    $result = $api_instance->jobJobIdModelGet($jobId, $key);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobsApi->jobJobIdModelGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JobsApi;

my $api_instance = WWW::SwaggerClient::JobsApi->new();
my $jobId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $key = ; # String | 

eval { 
    my $result = $api_instance->jobJobIdModelGet(jobId => $jobId, key => $key);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobsApi->jobJobIdModelGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.JobsApi()
jobId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | 
key =  # String |  (optional)

try: 
    # Download the fitted model
    api_response = api_instance.job_job_id_model_get(jobId, key=key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobsApi->jobJobIdModelGet: %s\n" % e)

Parameters

Path parameters
Name Description
job-id*
UUID (uuid)
Required
Query parameters
Name Description
key
String (password)

Responses

Status: 200 - The fitted model in .isfx-format

Status: 401 - API key required but not supplied

Status: 402 - No valid license for Zahner Analysis

Status: 404 - job not found / invalid job-id

jobJobIdSamplesGet

Download the samples used for fitting

Download an impedance spectra containing the samples which have been selected for fitting


/job/{job-id}/samples

Usage and SDK Samples

curl -X GET\
-H "Accept: application/octet-stream"\
"http://localhost:{port}/job/{job-id}/samples?key="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JobsApi;

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

public class JobsApiExample {

    public static void main(String[] args) {
        
        JobsApi apiInstance = new JobsApi();
        UUID jobId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        String key = ; // String | 
        try {
            byte[] result = apiInstance.jobJobIdSamplesGet(jobId, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#jobJobIdSamplesGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JobsApi;

public class JobsApiExample {

    public static void main(String[] args) {
        JobsApi apiInstance = new JobsApi();
        UUID jobId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        String key = ; // String | 
        try {
            byte[] result = apiInstance.jobJobIdSamplesGet(jobId, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#jobJobIdSamplesGet");
            e.printStackTrace();
        }
    }
}
UUID *jobId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // 
String *key = ; //  (optional)

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

// Download the samples used for fitting
[apiInstance jobJobIdSamplesGetWith:jobId
    key:key
              completionHandler: ^(byte[] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var ZahnerAnalysisRemoteEvaluationRemoteEval = require('zahner_analysis_remote_evaluation____remote_eval');

var api = new ZahnerAnalysisRemoteEvaluationRemoteEval.JobsApi()
var jobId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} 
var opts = { 
  'key':  // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.jobJobIdSamplesGet(jobId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class jobJobIdSamplesGetExample
    {
        public void main()
        {

            var apiInstance = new JobsApi();
            var jobId = new UUID(); // UUID | 
            var key = new String(); // String |  (optional) 

            try
            {
                // Download the samples used for fitting
                byte[] result = apiInstance.jobJobIdSamplesGet(jobId, key);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JobsApi.jobJobIdSamplesGet: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiJobsApi();
$jobId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$key = ; // String | 

try {
    $result = $api_instance->jobJobIdSamplesGet($jobId, $key);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobsApi->jobJobIdSamplesGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JobsApi;

my $api_instance = WWW::SwaggerClient::JobsApi->new();
my $jobId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $key = ; # String | 

eval { 
    my $result = $api_instance->jobJobIdSamplesGet(jobId => $jobId, key => $key);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobsApi->jobJobIdSamplesGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.JobsApi()
jobId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | 
key =  # String |  (optional)

try: 
    # Download the samples used for fitting
    api_response = api_instance.job_job_id_samples_get(jobId, key=key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobsApi->jobJobIdSamplesGet: %s\n" % e)

Parameters

Path parameters
Name Description
job-id*
UUID (uuid)
Required
Query parameters
Name Description
key
String (password)

Responses

Status: 200 - The impedance spectrum in .ism-format

Status: 401 - API key required but not supplied

Status: 402 - No valid license for Zahner Analysis

Status: 404 - job not found / invalid job-id

jobJobIdSimulationGet

Download the fitted impedance spectrum

Download the impedance spectrum generated trough simulation of the fitted model


/job/{job-id}/simulation

Usage and SDK Samples

curl -X GET\
-H "Accept: application/octet-stream"\
"http://localhost:{port}/job/{job-id}/simulation?key="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JobsApi;

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

public class JobsApiExample {

    public static void main(String[] args) {
        
        JobsApi apiInstance = new JobsApi();
        UUID jobId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        String key = ; // String | 
        try {
            byte[] result = apiInstance.jobJobIdSimulationGet(jobId, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#jobJobIdSimulationGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JobsApi;

public class JobsApiExample {

    public static void main(String[] args) {
        JobsApi apiInstance = new JobsApi();
        UUID jobId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        String key = ; // String | 
        try {
            byte[] result = apiInstance.jobJobIdSimulationGet(jobId, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#jobJobIdSimulationGet");
            e.printStackTrace();
        }
    }
}
UUID *jobId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // 
String *key = ; //  (optional)

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

// Download the fitted impedance spectrum
[apiInstance jobJobIdSimulationGetWith:jobId
    key:key
              completionHandler: ^(byte[] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var ZahnerAnalysisRemoteEvaluationRemoteEval = require('zahner_analysis_remote_evaluation____remote_eval');

var api = new ZahnerAnalysisRemoteEvaluationRemoteEval.JobsApi()
var jobId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} 
var opts = { 
  'key':  // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.jobJobIdSimulationGet(jobId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class jobJobIdSimulationGetExample
    {
        public void main()
        {

            var apiInstance = new JobsApi();
            var jobId = new UUID(); // UUID | 
            var key = new String(); // String |  (optional) 

            try
            {
                // Download the fitted impedance spectrum
                byte[] result = apiInstance.jobJobIdSimulationGet(jobId, key);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JobsApi.jobJobIdSimulationGet: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiJobsApi();
$jobId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$key = ; // String | 

try {
    $result = $api_instance->jobJobIdSimulationGet($jobId, $key);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobsApi->jobJobIdSimulationGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JobsApi;

my $api_instance = WWW::SwaggerClient::JobsApi->new();
my $jobId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $key = ; # String | 

eval { 
    my $result = $api_instance->jobJobIdSimulationGet(jobId => $jobId, key => $key);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobsApi->jobJobIdSimulationGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.JobsApi()
jobId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | 
key =  # String |  (optional)

try: 
    # Download the fitted impedance spectrum
    api_response = api_instance.job_job_id_simulation_get(jobId, key=key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobsApi->jobJobIdSimulationGet: %s\n" % e)

Parameters

Path parameters
Name Description
job-id*
UUID (uuid)
Required
Query parameters
Name Description
key
String (password)

Responses

Status: 200 - The impedance spectrum in .ism-format

Status: 401 - API key required but not supplied

Status: 402 - No valid license for Zahner Analysis

Status: 404 - job not found / invalid job-id

jobJobIdStatusGet

Get the status of a job

Get the status of a job


/job/{job-id}/status

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"http://localhost:{port}/job/{job-id}/status?key="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JobsApi;

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

public class JobsApiExample {

    public static void main(String[] args) {
        
        JobsApi apiInstance = new JobsApi();
        UUID jobId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        String key = ; // String | 
        try {
            JobInformation result = apiInstance.jobJobIdStatusGet(jobId, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#jobJobIdStatusGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JobsApi;

public class JobsApiExample {

    public static void main(String[] args) {
        JobsApi apiInstance = new JobsApi();
        UUID jobId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        String key = ; // String | 
        try {
            JobInformation result = apiInstance.jobJobIdStatusGet(jobId, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#jobJobIdStatusGet");
            e.printStackTrace();
        }
    }
}
UUID *jobId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // 
String *key = ; //  (optional)

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

// Get the status of a job
[apiInstance jobJobIdStatusGetWith:jobId
    key:key
              completionHandler: ^(JobInformation output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var ZahnerAnalysisRemoteEvaluationRemoteEval = require('zahner_analysis_remote_evaluation____remote_eval');

var api = new ZahnerAnalysisRemoteEvaluationRemoteEval.JobsApi()
var jobId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} 
var opts = { 
  'key':  // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.jobJobIdStatusGet(jobId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class jobJobIdStatusGetExample
    {
        public void main()
        {

            var apiInstance = new JobsApi();
            var jobId = new UUID(); // UUID | 
            var key = new String(); // String |  (optional) 

            try
            {
                // Get the status of a job
                JobInformation result = apiInstance.jobJobIdStatusGet(jobId, key);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JobsApi.jobJobIdStatusGet: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiJobsApi();
$jobId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
$key = ; // String | 

try {
    $result = $api_instance->jobJobIdStatusGet($jobId, $key);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobsApi->jobJobIdStatusGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JobsApi;

my $api_instance = WWW::SwaggerClient::JobsApi->new();
my $jobId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 
my $key = ; # String | 

eval { 
    my $result = $api_instance->jobJobIdStatusGet(jobId => $jobId, key => $key);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobsApi->jobJobIdStatusGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.JobsApi()
jobId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | 
key =  # String |  (optional)

try: 
    # Get the status of a job
    api_response = api_instance.job_job_id_status_get(jobId, key=key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobsApi->jobJobIdStatusGet: %s\n" % e)

Parameters

Path parameters
Name Description
job-id*
UUID (uuid)
Required
Query parameters
Name Description
key
String (password)

Responses

Status: 200 - All information about the job. The Results are only available after the job has been finished. Messages and Parameters are always available.

Status: 401 - API key required but not supplied

Status: 404 - job not found / invalid job-id

jobStartPost

Starts a job

Start a Job The *job-id* should be stored to retrieve the results or query status information later


/job/start

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: multipart/form-data"\
"http://localhost:{port}/job/start?key="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JobsApi;

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

public class JobsApiExample {

    public static void main(String[] args) {
        
        JobsApi apiInstance = new JobsApi();
        byte[] eisFile = eisFile_example; // byte[] | 
        byte[] modelFile = modelFile_example; // byte[] | 
        JobDescription job = ; // JobDescription | 
        String key = ; // String | 
        try {
            inline_response_200 result = apiInstance.jobStartPost(eisFile, modelFile, job, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#jobStartPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.JobsApi;

public class JobsApiExample {

    public static void main(String[] args) {
        JobsApi apiInstance = new JobsApi();
        byte[] eisFile = eisFile_example; // byte[] | 
        byte[] modelFile = modelFile_example; // byte[] | 
        JobDescription job = ; // JobDescription | 
        String key = ; // String | 
        try {
            inline_response_200 result = apiInstance.jobStartPost(eisFile, modelFile, job, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JobsApi#jobStartPost");
            e.printStackTrace();
        }
    }
}
byte[] *eisFile = eisFile_example; // 
byte[] *modelFile = modelFile_example; // 
JobDescription *job = ; // 
String *key = ; //  (optional)

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

// Starts a job
[apiInstance jobStartPostWith:eisFile
    modelFile:modelFile
    job:job
    key:key
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var ZahnerAnalysisRemoteEvaluationRemoteEval = require('zahner_analysis_remote_evaluation____remote_eval');

var api = new ZahnerAnalysisRemoteEvaluationRemoteEval.JobsApi()
var eisFile = eisFile_example; // {{byte[]}} 
var modelFile = modelFile_example; // {{byte[]}} 
var job = ; // {{JobDescription}} 
var opts = { 
  'key':  // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.jobStartPost(eisFilemodelFilejob, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class jobStartPostExample
    {
        public void main()
        {

            var apiInstance = new JobsApi();
            var eisFile = eisFile_example;  // byte[] | 
            var modelFile = modelFile_example;  // byte[] | 
            var job = new JobDescription(); // JobDescription | 
            var key = new String(); // String |  (optional) 

            try
            {
                // Starts a job
                inline_response_200 result = apiInstance.jobStartPost(eisFile, modelFile, job, key);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JobsApi.jobStartPost: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiJobsApi();
$eisFile = eisFile_example; // byte[] | 
$modelFile = modelFile_example; // byte[] | 
$job = ; // JobDescription | 
$key = ; // String | 

try {
    $result = $api_instance->jobStartPost($eisFile, $modelFile, $job, $key);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JobsApi->jobStartPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JobsApi;

my $api_instance = WWW::SwaggerClient::JobsApi->new();
my $eisFile = eisFile_example; # byte[] | 
my $modelFile = modelFile_example; # byte[] | 
my $job = ; # JobDescription | 
my $key = ; # String | 

eval { 
    my $result = $api_instance->jobStartPost(eisFile => $eisFile, modelFile => $modelFile, job => $job, key => $key);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JobsApi->jobStartPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.JobsApi()
eisFile = eisFile_example # byte[] | 
modelFile = modelFile_example # byte[] | 
job =  # JobDescription | 
key =  # String |  (optional)

try: 
    # Starts a job
    api_response = api_instance.job_start_post(eisFile, modelFile, job, key=key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JobsApi->jobStartPost: %s\n" % e)

Parameters

Form parameters
Name Description
eis-file*
byte[] (binary)
Required
model-file*
byte[] (binary)
Required
job*
JobDescription
Required
Query parameters
Name Description
key
String (password)

Responses

Status: 200 - The Job ID and all used parameters

Status: 401 - API key required but not supplied