Hvl Bpmn Engine Server

BpmnHistoricTaskPublicAPI

queryList4

Query list.


/historic/task/list

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/gw/bpmn-engine-server/historic/task/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnHistoricTaskPublicAPIApi;

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

public class BpmnHistoricTaskPublicAPIApiExample {

    public static void main(String[] args) {
        
        BpmnHistoricTaskPublicAPIApi apiInstance = new BpmnHistoricTaskPublicAPIApi();
        HvlBpmnTaskQueryModel body = ; // HvlBpmnTaskQueryModel | 
        try {
            HvlResponseListHvlBpmnTaskModel result = apiInstance.queryList4(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnHistoricTaskPublicAPIApi#queryList4");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnHistoricTaskPublicAPIApi;

public class BpmnHistoricTaskPublicAPIApiExample {

    public static void main(String[] args) {
        BpmnHistoricTaskPublicAPIApi apiInstance = new BpmnHistoricTaskPublicAPIApi();
        HvlBpmnTaskQueryModel body = ; // HvlBpmnTaskQueryModel | 
        try {
            HvlResponseListHvlBpmnTaskModel result = apiInstance.queryList4(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnHistoricTaskPublicAPIApi#queryList4");
            e.printStackTrace();
        }
    }
}
HvlBpmnTaskQueryModel *body = ; // 

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

// Query list.
[apiInstance queryList4With:body
              completionHandler: ^(HvlResponseListHvlBpmnTaskModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnEngineServer = require('hvl_bpmn_engine_server');

var api = new HvlBpmnEngineServer.BpmnHistoricTaskPublicAPIApi()
var body = ; // {{HvlBpmnTaskQueryModel}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.queryList4(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnHistoricTaskPublicAPIApi();
            var body = new HvlBpmnTaskQueryModel(); // HvlBpmnTaskQueryModel | 

            try
            {
                // Query list.
                HvlResponseListHvlBpmnTaskModel result = apiInstance.queryList4(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnHistoricTaskPublicAPIApi.queryList4: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnHistoricTaskPublicAPIApi();
$body = ; // HvlBpmnTaskQueryModel | 

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

my $api_instance = WWW::SwaggerClient::BpmnHistoricTaskPublicAPIApi->new();
my $body = WWW::SwaggerClient::Object::HvlBpmnTaskQueryModel->new(); # HvlBpmnTaskQueryModel | 

eval { 
    my $result = $api_instance->queryList4(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnHistoricTaskPublicAPIApi->queryList4: $@\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.BpmnHistoricTaskPublicAPIApi()
body =  # HvlBpmnTaskQueryModel | 

try: 
    # Query list.
    api_response = api_instance.query_list4(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnHistoricTaskPublicAPIApi->queryList4: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


queryPage4

Query page.


/historic/task/page

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/gw/bpmn-engine-server/historic/task/page"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnHistoricTaskPublicAPIApi;

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

public class BpmnHistoricTaskPublicAPIApiExample {

    public static void main(String[] args) {
        
        BpmnHistoricTaskPublicAPIApi apiInstance = new BpmnHistoricTaskPublicAPIApi();
        HvlBpmnTaskQueryModel body = ; // HvlBpmnTaskQueryModel | 
        try {
            HvlResponseHvlPageHvlBpmnTaskModel result = apiInstance.queryPage4(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnHistoricTaskPublicAPIApi#queryPage4");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnHistoricTaskPublicAPIApi;

public class BpmnHistoricTaskPublicAPIApiExample {

    public static void main(String[] args) {
        BpmnHistoricTaskPublicAPIApi apiInstance = new BpmnHistoricTaskPublicAPIApi();
        HvlBpmnTaskQueryModel body = ; // HvlBpmnTaskQueryModel | 
        try {
            HvlResponseHvlPageHvlBpmnTaskModel result = apiInstance.queryPage4(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnHistoricTaskPublicAPIApi#queryPage4");
            e.printStackTrace();
        }
    }
}
HvlBpmnTaskQueryModel *body = ; // 

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

// Query page.
[apiInstance queryPage4With:body
              completionHandler: ^(HvlResponseHvlPageHvlBpmnTaskModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnEngineServer = require('hvl_bpmn_engine_server');

var api = new HvlBpmnEngineServer.BpmnHistoricTaskPublicAPIApi()
var body = ; // {{HvlBpmnTaskQueryModel}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.queryPage4(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnHistoricTaskPublicAPIApi();
            var body = new HvlBpmnTaskQueryModel(); // HvlBpmnTaskQueryModel | 

            try
            {
                // Query page.
                HvlResponseHvlPageHvlBpmnTaskModel result = apiInstance.queryPage4(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnHistoricTaskPublicAPIApi.queryPage4: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnHistoricTaskPublicAPIApi();
$body = ; // HvlBpmnTaskQueryModel | 

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

my $api_instance = WWW::SwaggerClient::BpmnHistoricTaskPublicAPIApi->new();
my $body = WWW::SwaggerClient::Object::HvlBpmnTaskQueryModel->new(); # HvlBpmnTaskQueryModel | 

eval { 
    my $result = $api_instance->queryPage4(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnHistoricTaskPublicAPIApi->queryPage4: $@\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.BpmnHistoricTaskPublicAPIApi()
body =  # HvlBpmnTaskQueryModel | 

try: 
    # Query page.
    api_response = api_instance.query_page4(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnHistoricTaskPublicAPIApi->queryPage4: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


BpmnKeyPerformanceIndicatorAPI

calculateResult

Calculates key performance indicator


/kpi/key-performance-indicator/calculate

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/gw/bpmn-engine-server/kpi/key-performance-indicator/calculate"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnKeyPerformanceIndicatorAPIApi;

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

public class BpmnKeyPerformanceIndicatorAPIApiExample {

    public static void main(String[] args) {
        
        BpmnKeyPerformanceIndicatorAPIApi apiInstance = new BpmnKeyPerformanceIndicatorAPIApi();
        HvlBpmnKeyPerformanceIndicatorCalculationModel body = ; // HvlBpmnKeyPerformanceIndicatorCalculationModel | 
        try {
            HvlResponseHvlBpmnKeyPerformanceIndicatorResultModel result = apiInstance.calculateResult(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnKeyPerformanceIndicatorAPIApi#calculateResult");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnKeyPerformanceIndicatorAPIApi;

public class BpmnKeyPerformanceIndicatorAPIApiExample {

    public static void main(String[] args) {
        BpmnKeyPerformanceIndicatorAPIApi apiInstance = new BpmnKeyPerformanceIndicatorAPIApi();
        HvlBpmnKeyPerformanceIndicatorCalculationModel body = ; // HvlBpmnKeyPerformanceIndicatorCalculationModel | 
        try {
            HvlResponseHvlBpmnKeyPerformanceIndicatorResultModel result = apiInstance.calculateResult(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnKeyPerformanceIndicatorAPIApi#calculateResult");
            e.printStackTrace();
        }
    }
}
HvlBpmnKeyPerformanceIndicatorCalculationModel *body = ; // 

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

// Calculates key performance indicator
[apiInstance calculateResultWith:body
              completionHandler: ^(HvlResponseHvlBpmnKeyPerformanceIndicatorResultModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnEngineServer = require('hvl_bpmn_engine_server');

var api = new HvlBpmnEngineServer.BpmnKeyPerformanceIndicatorAPIApi()
var body = ; // {{HvlBpmnKeyPerformanceIndicatorCalculationModel}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.calculateResult(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnKeyPerformanceIndicatorAPIApi();
            var body = new HvlBpmnKeyPerformanceIndicatorCalculationModel(); // HvlBpmnKeyPerformanceIndicatorCalculationModel | 

            try
            {
                // Calculates key performance indicator
                HvlResponseHvlBpmnKeyPerformanceIndicatorResultModel result = apiInstance.calculateResult(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnKeyPerformanceIndicatorAPIApi.calculateResult: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnKeyPerformanceIndicatorAPIApi();
$body = ; // HvlBpmnKeyPerformanceIndicatorCalculationModel | 

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

my $api_instance = WWW::SwaggerClient::BpmnKeyPerformanceIndicatorAPIApi->new();
my $body = WWW::SwaggerClient::Object::HvlBpmnKeyPerformanceIndicatorCalculationModel->new(); # HvlBpmnKeyPerformanceIndicatorCalculationModel | 

eval { 
    my $result = $api_instance->calculateResult(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnKeyPerformanceIndicatorAPIApi->calculateResult: $@\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.BpmnKeyPerformanceIndicatorAPIApi()
body =  # HvlBpmnKeyPerformanceIndicatorCalculationModel | 

try: 
    # Calculates key performance indicator
    api_response = api_instance.calculate_result(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnKeyPerformanceIndicatorAPIApi->calculateResult: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


deleteByUuid

Deletes key performance indicator by uuid


/kpi/key-performance-indicator/{uuid}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"/gw/bpmn-engine-server/kpi/key-performance-indicator/{uuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnKeyPerformanceIndicatorAPIApi;

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

public class BpmnKeyPerformanceIndicatorAPIApiExample {

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

public class BpmnKeyPerformanceIndicatorAPIApiExample {

    public static void main(String[] args) {
        BpmnKeyPerformanceIndicatorAPIApi apiInstance = new BpmnKeyPerformanceIndicatorAPIApi();
         uuid = ; //  | 
        try {
            HvlResponseVoid result = apiInstance.deleteByUuid(uuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnKeyPerformanceIndicatorAPIApi#deleteByUuid");
            e.printStackTrace();
        }
    }
}
 *uuid = ; // 

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

// Deletes key performance indicator by uuid
[apiInstance deleteByUuidWith:uuid
              completionHandler: ^(HvlResponseVoid output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnEngineServer = require('hvl_bpmn_engine_server');

var api = new HvlBpmnEngineServer.BpmnKeyPerformanceIndicatorAPIApi()
var uuid = ; // {{}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteByUuid(uuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnKeyPerformanceIndicatorAPIApi();
            var uuid = new (); //  | 

            try
            {
                // Deletes key performance indicator by uuid
                HvlResponseVoid result = apiInstance.deleteByUuid(uuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnKeyPerformanceIndicatorAPIApi.deleteByUuid: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnKeyPerformanceIndicatorAPIApi();
$uuid = ; //  | 

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

my $api_instance = WWW::SwaggerClient::BpmnKeyPerformanceIndicatorAPIApi->new();
my $uuid = ; #  | 

eval { 
    my $result = $api_instance->deleteByUuid(uuid => $uuid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnKeyPerformanceIndicatorAPIApi->deleteByUuid: $@\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.BpmnKeyPerformanceIndicatorAPIApi()
uuid =  #  | 

try: 
    # Deletes key performance indicator by uuid
    api_response = api_instance.delete_by_uuid(uuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnKeyPerformanceIndicatorAPIApi->deleteByUuid: %s\n" % e)

Parameters

Path parameters
Name Description
uuid*
Required

Responses

Status: 200 - OK


getByUuid

Gets key performance indicator by uuid


/kpi/key-performance-indicator/{uuid}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"/gw/bpmn-engine-server/kpi/key-performance-indicator/{uuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnKeyPerformanceIndicatorAPIApi;

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

public class BpmnKeyPerformanceIndicatorAPIApiExample {

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

public class BpmnKeyPerformanceIndicatorAPIApiExample {

    public static void main(String[] args) {
        BpmnKeyPerformanceIndicatorAPIApi apiInstance = new BpmnKeyPerformanceIndicatorAPIApi();
         uuid = ; //  | 
        try {
            HvlResponseHvlBpmnKeyPerformanceIndicatorModel result = apiInstance.getByUuid(uuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnKeyPerformanceIndicatorAPIApi#getByUuid");
            e.printStackTrace();
        }
    }
}
 *uuid = ; // 

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

// Gets key performance indicator by uuid
[apiInstance getByUuidWith:uuid
              completionHandler: ^(HvlResponseHvlBpmnKeyPerformanceIndicatorModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnEngineServer = require('hvl_bpmn_engine_server');

var api = new HvlBpmnEngineServer.BpmnKeyPerformanceIndicatorAPIApi()
var uuid = ; // {{}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getByUuid(uuid, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnKeyPerformanceIndicatorAPIApi();
            var uuid = new (); //  | 

            try
            {
                // Gets key performance indicator by uuid
                HvlResponseHvlBpmnKeyPerformanceIndicatorModel result = apiInstance.getByUuid(uuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnKeyPerformanceIndicatorAPIApi.getByUuid: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnKeyPerformanceIndicatorAPIApi();
$uuid = ; //  | 

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

my $api_instance = WWW::SwaggerClient::BpmnKeyPerformanceIndicatorAPIApi->new();
my $uuid = ; #  | 

eval { 
    my $result = $api_instance->getByUuid(uuid => $uuid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnKeyPerformanceIndicatorAPIApi->getByUuid: $@\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.BpmnKeyPerformanceIndicatorAPIApi()
uuid =  #  | 

try: 
    # Gets key performance indicator by uuid
    api_response = api_instance.get_by_uuid(uuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnKeyPerformanceIndicatorAPIApi->getByUuid: %s\n" % e)

Parameters

Path parameters
Name Description
uuid*
Required

Responses

Status: 200 - OK


queryList3

Queries key performance indicators according to criteria in query model


/kpi/key-performance-indicator/list

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/gw/bpmn-engine-server/kpi/key-performance-indicator/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnKeyPerformanceIndicatorAPIApi;

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

public class BpmnKeyPerformanceIndicatorAPIApiExample {

    public static void main(String[] args) {
        
        BpmnKeyPerformanceIndicatorAPIApi apiInstance = new BpmnKeyPerformanceIndicatorAPIApi();
        HvlBpmnKeyPerformanceIndicatorQueryModel body = ; // HvlBpmnKeyPerformanceIndicatorQueryModel | 
        try {
            HvlResponseListHvlBpmnKeyPerformanceIndicatorModel result = apiInstance.queryList3(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnKeyPerformanceIndicatorAPIApi#queryList3");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnKeyPerformanceIndicatorAPIApi;

public class BpmnKeyPerformanceIndicatorAPIApiExample {

    public static void main(String[] args) {
        BpmnKeyPerformanceIndicatorAPIApi apiInstance = new BpmnKeyPerformanceIndicatorAPIApi();
        HvlBpmnKeyPerformanceIndicatorQueryModel body = ; // HvlBpmnKeyPerformanceIndicatorQueryModel | 
        try {
            HvlResponseListHvlBpmnKeyPerformanceIndicatorModel result = apiInstance.queryList3(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnKeyPerformanceIndicatorAPIApi#queryList3");
            e.printStackTrace();
        }
    }
}
HvlBpmnKeyPerformanceIndicatorQueryModel *body = ; // 

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

// Queries key performance indicators according to criteria in query model
[apiInstance queryList3With:body
              completionHandler: ^(HvlResponseListHvlBpmnKeyPerformanceIndicatorModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnEngineServer = require('hvl_bpmn_engine_server');

var api = new HvlBpmnEngineServer.BpmnKeyPerformanceIndicatorAPIApi()
var body = ; // {{HvlBpmnKeyPerformanceIndicatorQueryModel}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.queryList3(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnKeyPerformanceIndicatorAPIApi();
            var body = new HvlBpmnKeyPerformanceIndicatorQueryModel(); // HvlBpmnKeyPerformanceIndicatorQueryModel | 

            try
            {
                // Queries key performance indicators according to criteria in query model
                HvlResponseListHvlBpmnKeyPerformanceIndicatorModel result = apiInstance.queryList3(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnKeyPerformanceIndicatorAPIApi.queryList3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnKeyPerformanceIndicatorAPIApi();
$body = ; // HvlBpmnKeyPerformanceIndicatorQueryModel | 

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

my $api_instance = WWW::SwaggerClient::BpmnKeyPerformanceIndicatorAPIApi->new();
my $body = WWW::SwaggerClient::Object::HvlBpmnKeyPerformanceIndicatorQueryModel->new(); # HvlBpmnKeyPerformanceIndicatorQueryModel | 

eval { 
    my $result = $api_instance->queryList3(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnKeyPerformanceIndicatorAPIApi->queryList3: $@\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.BpmnKeyPerformanceIndicatorAPIApi()
body =  # HvlBpmnKeyPerformanceIndicatorQueryModel | 

try: 
    # Queries key performance indicators according to criteria in query model
    api_response = api_instance.query_list3(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnKeyPerformanceIndicatorAPIApi->queryList3: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


queryPage3

Queries key performance indicators as paginated according to criteria in query model


/kpi/key-performance-indicator/page

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/gw/bpmn-engine-server/kpi/key-performance-indicator/page"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnKeyPerformanceIndicatorAPIApi;

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

public class BpmnKeyPerformanceIndicatorAPIApiExample {

    public static void main(String[] args) {
        
        BpmnKeyPerformanceIndicatorAPIApi apiInstance = new BpmnKeyPerformanceIndicatorAPIApi();
        HvlBpmnKeyPerformanceIndicatorQueryModel body = ; // HvlBpmnKeyPerformanceIndicatorQueryModel | 
        try {
            HvlResponseHvlPageHvlBpmnKeyPerformanceIndicatorModel result = apiInstance.queryPage3(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnKeyPerformanceIndicatorAPIApi#queryPage3");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnKeyPerformanceIndicatorAPIApi;

public class BpmnKeyPerformanceIndicatorAPIApiExample {

    public static void main(String[] args) {
        BpmnKeyPerformanceIndicatorAPIApi apiInstance = new BpmnKeyPerformanceIndicatorAPIApi();
        HvlBpmnKeyPerformanceIndicatorQueryModel body = ; // HvlBpmnKeyPerformanceIndicatorQueryModel | 
        try {
            HvlResponseHvlPageHvlBpmnKeyPerformanceIndicatorModel result = apiInstance.queryPage3(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnKeyPerformanceIndicatorAPIApi#queryPage3");
            e.printStackTrace();
        }
    }
}
HvlBpmnKeyPerformanceIndicatorQueryModel *body = ; // 

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

// Queries key performance indicators as paginated according to criteria in query model
[apiInstance queryPage3With:body
              completionHandler: ^(HvlResponseHvlPageHvlBpmnKeyPerformanceIndicatorModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnEngineServer = require('hvl_bpmn_engine_server');

var api = new HvlBpmnEngineServer.BpmnKeyPerformanceIndicatorAPIApi()
var body = ; // {{HvlBpmnKeyPerformanceIndicatorQueryModel}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.queryPage3(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnKeyPerformanceIndicatorAPIApi();
            var body = new HvlBpmnKeyPerformanceIndicatorQueryModel(); // HvlBpmnKeyPerformanceIndicatorQueryModel | 

            try
            {
                // Queries key performance indicators as paginated according to criteria in query model
                HvlResponseHvlPageHvlBpmnKeyPerformanceIndicatorModel result = apiInstance.queryPage3(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnKeyPerformanceIndicatorAPIApi.queryPage3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnKeyPerformanceIndicatorAPIApi();
$body = ; // HvlBpmnKeyPerformanceIndicatorQueryModel | 

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

my $api_instance = WWW::SwaggerClient::BpmnKeyPerformanceIndicatorAPIApi->new();
my $body = WWW::SwaggerClient::Object::HvlBpmnKeyPerformanceIndicatorQueryModel->new(); # HvlBpmnKeyPerformanceIndicatorQueryModel | 

eval { 
    my $result = $api_instance->queryPage3(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnKeyPerformanceIndicatorAPIApi->queryPage3: $@\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.BpmnKeyPerformanceIndicatorAPIApi()
body =  # HvlBpmnKeyPerformanceIndicatorQueryModel | 

try: 
    # Queries key performance indicators as paginated according to criteria in query model
    api_response = api_instance.query_page3(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnKeyPerformanceIndicatorAPIApi->queryPage3: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


save

Saves key performance indicator


/kpi/key-performance-indicator

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/gw/bpmn-engine-server/kpi/key-performance-indicator"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnKeyPerformanceIndicatorAPIApi;

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

public class BpmnKeyPerformanceIndicatorAPIApiExample {

    public static void main(String[] args) {
        
        BpmnKeyPerformanceIndicatorAPIApi apiInstance = new BpmnKeyPerformanceIndicatorAPIApi();
        HvlBpmnKeyPerformanceIndicatorModel body = ; // HvlBpmnKeyPerformanceIndicatorModel | 
        try {
            HvlResponseVoid result = apiInstance.save(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnKeyPerformanceIndicatorAPIApi#save");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnKeyPerformanceIndicatorAPIApi;

public class BpmnKeyPerformanceIndicatorAPIApiExample {

    public static void main(String[] args) {
        BpmnKeyPerformanceIndicatorAPIApi apiInstance = new BpmnKeyPerformanceIndicatorAPIApi();
        HvlBpmnKeyPerformanceIndicatorModel body = ; // HvlBpmnKeyPerformanceIndicatorModel | 
        try {
            HvlResponseVoid result = apiInstance.save(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnKeyPerformanceIndicatorAPIApi#save");
            e.printStackTrace();
        }
    }
}
HvlBpmnKeyPerformanceIndicatorModel *body = ; // 

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

// Saves key performance indicator
[apiInstance saveWith:body
              completionHandler: ^(HvlResponseVoid output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnEngineServer = require('hvl_bpmn_engine_server');

var api = new HvlBpmnEngineServer.BpmnKeyPerformanceIndicatorAPIApi()
var body = ; // {{HvlBpmnKeyPerformanceIndicatorModel}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.save(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnKeyPerformanceIndicatorAPIApi();
            var body = new HvlBpmnKeyPerformanceIndicatorModel(); // HvlBpmnKeyPerformanceIndicatorModel | 

            try
            {
                // Saves key performance indicator
                HvlResponseVoid result = apiInstance.save(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnKeyPerformanceIndicatorAPIApi.save: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnKeyPerformanceIndicatorAPIApi();
$body = ; // HvlBpmnKeyPerformanceIndicatorModel | 

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

my $api_instance = WWW::SwaggerClient::BpmnKeyPerformanceIndicatorAPIApi->new();
my $body = WWW::SwaggerClient::Object::HvlBpmnKeyPerformanceIndicatorModel->new(); # HvlBpmnKeyPerformanceIndicatorModel | 

eval { 
    my $result = $api_instance->save(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnKeyPerformanceIndicatorAPIApi->save: $@\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.BpmnKeyPerformanceIndicatorAPIApi()
body =  # HvlBpmnKeyPerformanceIndicatorModel | 

try: 
    # Saves key performance indicator
    api_response = api_instance.save(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnKeyPerformanceIndicatorAPIApi->save: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


update

Updates key performance indicator


/kpi/key-performance-indicator

Usage and SDK Samples

curl -X PUT\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/gw/bpmn-engine-server/kpi/key-performance-indicator"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnKeyPerformanceIndicatorAPIApi;

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

public class BpmnKeyPerformanceIndicatorAPIApiExample {

    public static void main(String[] args) {
        
        BpmnKeyPerformanceIndicatorAPIApi apiInstance = new BpmnKeyPerformanceIndicatorAPIApi();
        HvlBpmnKeyPerformanceIndicatorModel body = ; // HvlBpmnKeyPerformanceIndicatorModel | 
        try {
            HvlResponseVoid result = apiInstance.update(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnKeyPerformanceIndicatorAPIApi#update");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnKeyPerformanceIndicatorAPIApi;

public class BpmnKeyPerformanceIndicatorAPIApiExample {

    public static void main(String[] args) {
        BpmnKeyPerformanceIndicatorAPIApi apiInstance = new BpmnKeyPerformanceIndicatorAPIApi();
        HvlBpmnKeyPerformanceIndicatorModel body = ; // HvlBpmnKeyPerformanceIndicatorModel | 
        try {
            HvlResponseVoid result = apiInstance.update(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnKeyPerformanceIndicatorAPIApi#update");
            e.printStackTrace();
        }
    }
}
HvlBpmnKeyPerformanceIndicatorModel *body = ; // 

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

// Updates key performance indicator
[apiInstance updateWith:body
              completionHandler: ^(HvlResponseVoid output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnEngineServer = require('hvl_bpmn_engine_server');

var api = new HvlBpmnEngineServer.BpmnKeyPerformanceIndicatorAPIApi()
var body = ; // {{HvlBpmnKeyPerformanceIndicatorModel}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.update(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnKeyPerformanceIndicatorAPIApi();
            var body = new HvlBpmnKeyPerformanceIndicatorModel(); // HvlBpmnKeyPerformanceIndicatorModel | 

            try
            {
                // Updates key performance indicator
                HvlResponseVoid result = apiInstance.update(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnKeyPerformanceIndicatorAPIApi.update: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnKeyPerformanceIndicatorAPIApi();
$body = ; // HvlBpmnKeyPerformanceIndicatorModel | 

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

my $api_instance = WWW::SwaggerClient::BpmnKeyPerformanceIndicatorAPIApi->new();
my $body = WWW::SwaggerClient::Object::HvlBpmnKeyPerformanceIndicatorModel->new(); # HvlBpmnKeyPerformanceIndicatorModel | 

eval { 
    my $result = $api_instance->update(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnKeyPerformanceIndicatorAPIApi->update: $@\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.BpmnKeyPerformanceIndicatorAPIApi()
body =  # HvlBpmnKeyPerformanceIndicatorModel | 

try: 
    # Updates key performance indicator
    api_response = api_instance.update(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnKeyPerformanceIndicatorAPIApi->update: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


BpmnRepositoryAPI

activateProcessDefinition

Activate process definition by id.


/repository/activate

Usage and SDK Samples

curl -X POST\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"/gw/bpmn-engine-server/repository/activate"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnRepositoryAPIApi;

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

public class BpmnRepositoryAPIApiExample {

    public static void main(String[] args) {
        
        BpmnRepositoryAPIApi apiInstance = new BpmnRepositoryAPIApi();
        HvlBpmnActivateProcessDefinitionModel body = ; // HvlBpmnActivateProcessDefinitionModel | 
        try {
            HvlResponseVoid result = apiInstance.activateProcessDefinition(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnRepositoryAPIApi#activateProcessDefinition");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnRepositoryAPIApi;

public class BpmnRepositoryAPIApiExample {

    public static void main(String[] args) {
        BpmnRepositoryAPIApi apiInstance = new BpmnRepositoryAPIApi();
        HvlBpmnActivateProcessDefinitionModel body = ; // HvlBpmnActivateProcessDefinitionModel | 
        try {
            HvlResponseVoid result = apiInstance.activateProcessDefinition(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnRepositoryAPIApi#activateProcessDefinition");
            e.printStackTrace();
        }
    }
}
HvlBpmnActivateProcessDefinitionModel *body = ; // 

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

// Activate process definition by id.
[apiInstance activateProcessDefinitionWith:body
              completionHandler: ^(HvlResponseVoid output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnEngineServer = require('hvl_bpmn_engine_server');

var api = new HvlBpmnEngineServer.BpmnRepositoryAPIApi()
var body = ; // {{HvlBpmnActivateProcessDefinitionModel}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.activateProcessDefinition(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnRepositoryAPIApi();
            var body = new HvlBpmnActivateProcessDefinitionModel(); // HvlBpmnActivateProcessDefinitionModel | 

            try
            {
                // Activate process definition by id.
                HvlResponseVoid result = apiInstance.activateProcessDefinition(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnRepositoryAPIApi.activateProcessDefinition: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnRepositoryAPIApi();
$body = ; // HvlBpmnActivateProcessDefinitionModel | 

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

my $api_instance = WWW::SwaggerClient::BpmnRepositoryAPIApi->new();
my $body = WWW::SwaggerClient::Object::HvlBpmnActivateProcessDefinitionModel->new(); # HvlBpmnActivateProcessDefinitionModel | 

eval { 
    my $result = $api_instance->activateProcessDefinition(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnRepositoryAPIApi->activateProcessDefinition: $@\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.BpmnRepositoryAPIApi()
body =  # HvlBpmnActivateProcessDefinitionModel | 

try: 
    # Activate process definition by id.
    api_response = api_instance.activate_process_definition(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnRepositoryAPIApi->activateProcessDefinition: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


deploy

Deploy to engine from bpmn xml


/repository/deployXml

Usage and SDK Samples

curl -X POST\
-H "Accept: */*"\
-H "Content-Type: multipart/form-data"\
"/gw/bpmn-engine-server/repository/deployXml"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnRepositoryAPIApi;

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

public class BpmnRepositoryAPIApiExample {

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

public class BpmnRepositoryAPIApiExample {

    public static void main(String[] args) {
        BpmnRepositoryAPIApi apiInstance = new BpmnRepositoryAPIApi();
         xmlFile = ; //  | 
        try {
            HvlResponseVoid result = apiInstance.deploy(xmlFile);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnRepositoryAPIApi#deploy");
            e.printStackTrace();
        }
    }
}
 *xmlFile = ; // 

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

// Deploy to engine from bpmn xml
[apiInstance deployWith:xmlFile
              completionHandler: ^(HvlResponseVoid output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnEngineServer = require('hvl_bpmn_engine_server');

var api = new HvlBpmnEngineServer.BpmnRepositoryAPIApi()
var xmlFile = ; // {{}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deploy(xmlFile, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnRepositoryAPIApi();
            var xmlFile = new (); //  | 

            try
            {
                // Deploy to engine from bpmn xml
                HvlResponseVoid result = apiInstance.deploy(xmlFile);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnRepositoryAPIApi.deploy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnRepositoryAPIApi();
$xmlFile = ; //  | 

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

my $api_instance = WWW::SwaggerClient::BpmnRepositoryAPIApi->new();
my $xmlFile = ; #  | 

eval { 
    my $result = $api_instance->deploy(xmlFile => $xmlFile);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnRepositoryAPIApi->deploy: $@\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.BpmnRepositoryAPIApi()
xmlFile =  #  | 

try: 
    # Deploy to engine from bpmn xml
    api_response = api_instance.deploy(xmlFile)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnRepositoryAPIApi->deploy: %s\n" % e)

Parameters

Form parameters
Name Description
xmlFile*
(binary)
Required

Responses

Status: 200 - OK


deployList

Deploy to engine from list of bpmn xml.


/repository/deployXmls

Usage and SDK Samples

curl -X POST\
-H "Accept: */*"\
-H "Content-Type: multipart/form-data"\
"/gw/bpmn-engine-server/repository/deployXmls"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnRepositoryAPIApi;

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

public class BpmnRepositoryAPIApiExample {

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

public class BpmnRepositoryAPIApiExample {

    public static void main(String[] args) {
        BpmnRepositoryAPIApi apiInstance = new BpmnRepositoryAPIApi();
         xmlFileList = ; //  | 
        try {
            HvlResponseVoid result = apiInstance.deployList(xmlFileList);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnRepositoryAPIApi#deployList");
            e.printStackTrace();
        }
    }
}
 *xmlFileList = ; // 

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

// Deploy to engine from list of bpmn xml.
[apiInstance deployListWith:xmlFileList
              completionHandler: ^(HvlResponseVoid output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnEngineServer = require('hvl_bpmn_engine_server');

var api = new HvlBpmnEngineServer.BpmnRepositoryAPIApi()
var xmlFileList = ; // {{}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deployList(xmlFileList, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnRepositoryAPIApi();
            var xmlFileList = new (); //  | 

            try
            {
                // Deploy to engine from list of bpmn xml.
                HvlResponseVoid result = apiInstance.deployList(xmlFileList);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnRepositoryAPIApi.deployList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnRepositoryAPIApi();
$xmlFileList = ; //  | 

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

my $api_instance = WWW::SwaggerClient::BpmnRepositoryAPIApi->new();
my $xmlFileList = ; #  | 

eval { 
    my $result = $api_instance->deployList(xmlFileList => $xmlFileList);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnRepositoryAPIApi->deployList: $@\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.BpmnRepositoryAPIApi()
xmlFileList =  #  | 

try: 
    # Deploy to engine from list of bpmn xml.
    api_response = api_instance.deploy_list(xmlFileList)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnRepositoryAPIApi->deployList: %s\n" % e)

Parameters

Form parameters
Name Description
xmlFileList*
Required

Responses

Status: 200 - OK


getBpmnModelArrayByProcessDefinitionId

Gets bpmn model array by process definition id.


/repository/model/{id}

Usage and SDK Samples

curl -X GET\
-H "Accept: */*"\
"/gw/bpmn-engine-server/repository/model/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnRepositoryAPIApi;

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

public class BpmnRepositoryAPIApiExample {

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

public class BpmnRepositoryAPIApiExample {

    public static void main(String[] args) {
        BpmnRepositoryAPIApi apiInstance = new BpmnRepositoryAPIApi();
         id = ; //  | 
        try {
            HvlResponseByte[] result = apiInstance.getBpmnModelArrayByProcessDefinitionId(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnRepositoryAPIApi#getBpmnModelArrayByProcessDefinitionId");
            e.printStackTrace();
        }
    }
}
 *id = ; // 

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

// Gets bpmn model array by process definition id.
[apiInstance getBpmnModelArrayByProcessDefinitionIdWith:id
              completionHandler: ^(HvlResponseByte[] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnEngineServer = require('hvl_bpmn_engine_server');

var api = new HvlBpmnEngineServer.BpmnRepositoryAPIApi()
var id = ; // {{}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBpmnModelArrayByProcessDefinitionId(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnRepositoryAPIApi();
            var id = new (); //  | 

            try
            {
                // Gets bpmn model array by process definition id.
                HvlResponseByte[] result = apiInstance.getBpmnModelArrayByProcessDefinitionId(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnRepositoryAPIApi.getBpmnModelArrayByProcessDefinitionId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnRepositoryAPIApi();
$id = ; //  | 

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

my $api_instance = WWW::SwaggerClient::BpmnRepositoryAPIApi->new();
my $id = ; #  | 

eval { 
    my $result = $api_instance->getBpmnModelArrayByProcessDefinitionId(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnRepositoryAPIApi->getBpmnModelArrayByProcessDefinitionId: $@\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.BpmnRepositoryAPIApi()
id =  #  | 

try: 
    # Gets bpmn model array by process definition id.
    api_response = api_instance.get_bpmn_model_array_by_process_definition_id(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnRepositoryAPIApi->getBpmnModelArrayByProcessDefinitionId: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Required

Responses

Status: 200 - OK


queryList2

Query list.


/repository/list

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/gw/bpmn-engine-server/repository/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnRepositoryAPIApi;

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

public class BpmnRepositoryAPIApiExample {

    public static void main(String[] args) {
        
        BpmnRepositoryAPIApi apiInstance = new BpmnRepositoryAPIApi();
        HvlBpmnProcessDefinitionQueryModel body = ; // HvlBpmnProcessDefinitionQueryModel | 
        try {
            HvlResponseListHvlBpmnProcessDefinitionModel result = apiInstance.queryList2(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnRepositoryAPIApi#queryList2");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnRepositoryAPIApi;

public class BpmnRepositoryAPIApiExample {

    public static void main(String[] args) {
        BpmnRepositoryAPIApi apiInstance = new BpmnRepositoryAPIApi();
        HvlBpmnProcessDefinitionQueryModel body = ; // HvlBpmnProcessDefinitionQueryModel | 
        try {
            HvlResponseListHvlBpmnProcessDefinitionModel result = apiInstance.queryList2(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnRepositoryAPIApi#queryList2");
            e.printStackTrace();
        }
    }
}
HvlBpmnProcessDefinitionQueryModel *body = ; // 

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

// Query list.
[apiInstance queryList2With:body
              completionHandler: ^(HvlResponseListHvlBpmnProcessDefinitionModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnEngineServer = require('hvl_bpmn_engine_server');

var api = new HvlBpmnEngineServer.BpmnRepositoryAPIApi()
var body = ; // {{HvlBpmnProcessDefinitionQueryModel}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.queryList2(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnRepositoryAPIApi();
            var body = new HvlBpmnProcessDefinitionQueryModel(); // HvlBpmnProcessDefinitionQueryModel | 

            try
            {
                // Query list.
                HvlResponseListHvlBpmnProcessDefinitionModel result = apiInstance.queryList2(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnRepositoryAPIApi.queryList2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnRepositoryAPIApi();
$body = ; // HvlBpmnProcessDefinitionQueryModel | 

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

my $api_instance = WWW::SwaggerClient::BpmnRepositoryAPIApi->new();
my $body = WWW::SwaggerClient::Object::HvlBpmnProcessDefinitionQueryModel->new(); # HvlBpmnProcessDefinitionQueryModel | 

eval { 
    my $result = $api_instance->queryList2(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnRepositoryAPIApi->queryList2: $@\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.BpmnRepositoryAPIApi()
body =  # HvlBpmnProcessDefinitionQueryModel | 

try: 
    # Query list.
    api_response = api_instance.query_list2(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnRepositoryAPIApi->queryList2: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


queryPage2

Query page.


/repository/page

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/gw/bpmn-engine-server/repository/page"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnRepositoryAPIApi;

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

public class BpmnRepositoryAPIApiExample {

    public static void main(String[] args) {
        
        BpmnRepositoryAPIApi apiInstance = new BpmnRepositoryAPIApi();
        HvlBpmnProcessDefinitionQueryModel body = ; // HvlBpmnProcessDefinitionQueryModel | 
        try {
            HvlResponseHvlPageHvlBpmnProcessDefinitionModel result = apiInstance.queryPage2(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnRepositoryAPIApi#queryPage2");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnRepositoryAPIApi;

public class BpmnRepositoryAPIApiExample {

    public static void main(String[] args) {
        BpmnRepositoryAPIApi apiInstance = new BpmnRepositoryAPIApi();
        HvlBpmnProcessDefinitionQueryModel body = ; // HvlBpmnProcessDefinitionQueryModel | 
        try {
            HvlResponseHvlPageHvlBpmnProcessDefinitionModel result = apiInstance.queryPage2(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnRepositoryAPIApi#queryPage2");
            e.printStackTrace();
        }
    }
}
HvlBpmnProcessDefinitionQueryModel *body = ; // 

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

// Query page.
[apiInstance queryPage2With:body
              completionHandler: ^(HvlResponseHvlPageHvlBpmnProcessDefinitionModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnEngineServer = require('hvl_bpmn_engine_server');

var api = new HvlBpmnEngineServer.BpmnRepositoryAPIApi()
var body = ; // {{HvlBpmnProcessDefinitionQueryModel}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.queryPage2(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnRepositoryAPIApi();
            var body = new HvlBpmnProcessDefinitionQueryModel(); // HvlBpmnProcessDefinitionQueryModel | 

            try
            {
                // Query page.
                HvlResponseHvlPageHvlBpmnProcessDefinitionModel result = apiInstance.queryPage2(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnRepositoryAPIApi.queryPage2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnRepositoryAPIApi();
$body = ; // HvlBpmnProcessDefinitionQueryModel | 

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

my $api_instance = WWW::SwaggerClient::BpmnRepositoryAPIApi->new();
my $body = WWW::SwaggerClient::Object::HvlBpmnProcessDefinitionQueryModel->new(); # HvlBpmnProcessDefinitionQueryModel | 

eval { 
    my $result = $api_instance->queryPage2(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnRepositoryAPIApi->queryPage2: $@\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.BpmnRepositoryAPIApi()
body =  # HvlBpmnProcessDefinitionQueryModel | 

try: 
    # Query page.
    api_response = api_instance.query_page2(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnRepositoryAPIApi->queryPage2: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


suspendProcessDefinition

Suspend process definition.


/repository/suspend

Usage and SDK Samples

curl -X POST\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"/gw/bpmn-engine-server/repository/suspend"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnRepositoryAPIApi;

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

public class BpmnRepositoryAPIApiExample {

    public static void main(String[] args) {
        
        BpmnRepositoryAPIApi apiInstance = new BpmnRepositoryAPIApi();
        HvlBpmnSuspendProcessDefinitionModel body = ; // HvlBpmnSuspendProcessDefinitionModel | 
        try {
            HvlResponseVoid result = apiInstance.suspendProcessDefinition(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnRepositoryAPIApi#suspendProcessDefinition");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnRepositoryAPIApi;

public class BpmnRepositoryAPIApiExample {

    public static void main(String[] args) {
        BpmnRepositoryAPIApi apiInstance = new BpmnRepositoryAPIApi();
        HvlBpmnSuspendProcessDefinitionModel body = ; // HvlBpmnSuspendProcessDefinitionModel | 
        try {
            HvlResponseVoid result = apiInstance.suspendProcessDefinition(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnRepositoryAPIApi#suspendProcessDefinition");
            e.printStackTrace();
        }
    }
}
HvlBpmnSuspendProcessDefinitionModel *body = ; // 

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

// Suspend process definition.
[apiInstance suspendProcessDefinitionWith:body
              completionHandler: ^(HvlResponseVoid output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnEngineServer = require('hvl_bpmn_engine_server');

var api = new HvlBpmnEngineServer.BpmnRepositoryAPIApi()
var body = ; // {{HvlBpmnSuspendProcessDefinitionModel}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.suspendProcessDefinition(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnRepositoryAPIApi();
            var body = new HvlBpmnSuspendProcessDefinitionModel(); // HvlBpmnSuspendProcessDefinitionModel | 

            try
            {
                // Suspend process definition.
                HvlResponseVoid result = apiInstance.suspendProcessDefinition(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnRepositoryAPIApi.suspendProcessDefinition: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnRepositoryAPIApi();
$body = ; // HvlBpmnSuspendProcessDefinitionModel | 

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

my $api_instance = WWW::SwaggerClient::BpmnRepositoryAPIApi->new();
my $body = WWW::SwaggerClient::Object::HvlBpmnSuspendProcessDefinitionModel->new(); # HvlBpmnSuspendProcessDefinitionModel | 

eval { 
    my $result = $api_instance->suspendProcessDefinition(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnRepositoryAPIApi->suspendProcessDefinition: $@\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.BpmnRepositoryAPIApi()
body =  # HvlBpmnSuspendProcessDefinitionModel | 

try: 
    # Suspend process definition.
    api_response = api_instance.suspend_process_definition(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnRepositoryAPIApi->suspendProcessDefinition: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


BpmnRuntimePublicAPI

getVariable

Gets execution variable.


/runtime/variables/by-execution-id/{executionId}/by-variable-name/{variableName}

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
"/gw/bpmn-engine-server/runtime/variables/by-execution-id/{executionId}/by-variable-name/{variableName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnRuntimePublicAPIApi;

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

public class BpmnRuntimePublicAPIApiExample {

    public static void main(String[] args) {
        
        BpmnRuntimePublicAPIApi apiInstance = new BpmnRuntimePublicAPIApi();
         executionId = ; //  | 
         variableName = ; //  | 
        try {
            HvlResponseObject result = apiInstance.getVariable(executionId, variableName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnRuntimePublicAPIApi#getVariable");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnRuntimePublicAPIApi;

public class BpmnRuntimePublicAPIApiExample {

    public static void main(String[] args) {
        BpmnRuntimePublicAPIApi apiInstance = new BpmnRuntimePublicAPIApi();
         executionId = ; //  | 
         variableName = ; //  | 
        try {
            HvlResponseObject result = apiInstance.getVariable(executionId, variableName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnRuntimePublicAPIApi#getVariable");
            e.printStackTrace();
        }
    }
}
 *executionId = ; // 
 *variableName = ; // 

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

// Gets execution variable.
[apiInstance getVariableWith:executionId
    variableName:variableName
              completionHandler: ^(HvlResponseObject output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnEngineServer = require('hvl_bpmn_engine_server');

var api = new HvlBpmnEngineServer.BpmnRuntimePublicAPIApi()
var executionId = ; // {{}} 
var variableName = ; // {{}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVariable(executionId, variableName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnRuntimePublicAPIApi();
            var executionId = new (); //  | 
            var variableName = new (); //  | 

            try
            {
                // Gets execution variable.
                HvlResponseObject result = apiInstance.getVariable(executionId, variableName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnRuntimePublicAPIApi.getVariable: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnRuntimePublicAPIApi();
$executionId = ; //  | 
$variableName = ; //  | 

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

my $api_instance = WWW::SwaggerClient::BpmnRuntimePublicAPIApi->new();
my $executionId = ; #  | 
my $variableName = ; #  | 

eval { 
    my $result = $api_instance->getVariable(executionId => $executionId, variableName => $variableName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnRuntimePublicAPIApi->getVariable: $@\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.BpmnRuntimePublicAPIApi()
executionId =  #  | 
variableName =  #  | 

try: 
    # Gets execution variable.
    api_response = api_instance.get_variable(executionId, variableName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnRuntimePublicAPIApi->getVariable: %s\n" % e)

Parameters

Path parameters
Name Description
executionId*
Required
variableName*
Required

Responses

Status: 200 - OK


getVariables1

Gets execution variables.


/runtime/variables/by-execution-id/{executionId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"/gw/bpmn-engine-server/runtime/variables/by-execution-id/{executionId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnRuntimePublicAPIApi;

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

public class BpmnRuntimePublicAPIApiExample {

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

public class BpmnRuntimePublicAPIApiExample {

    public static void main(String[] args) {
        BpmnRuntimePublicAPIApi apiInstance = new BpmnRuntimePublicAPIApi();
         executionId = ; //  | 
        try {
            HvlResponseMapStringObject result = apiInstance.getVariables1(executionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnRuntimePublicAPIApi#getVariables1");
            e.printStackTrace();
        }
    }
}
 *executionId = ; // 

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

// Gets execution variables.
[apiInstance getVariables1With:executionId
              completionHandler: ^(HvlResponseMapStringObject output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnEngineServer = require('hvl_bpmn_engine_server');

var api = new HvlBpmnEngineServer.BpmnRuntimePublicAPIApi()
var executionId = ; // {{}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVariables1(executionId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnRuntimePublicAPIApi();
            var executionId = new (); //  | 

            try
            {
                // Gets execution variables.
                HvlResponseMapStringObject result = apiInstance.getVariables1(executionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnRuntimePublicAPIApi.getVariables1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnRuntimePublicAPIApi();
$executionId = ; //  | 

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

my $api_instance = WWW::SwaggerClient::BpmnRuntimePublicAPIApi->new();
my $executionId = ; #  | 

eval { 
    my $result = $api_instance->getVariables1(executionId => $executionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnRuntimePublicAPIApi->getVariables1: $@\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.BpmnRuntimePublicAPIApi()
executionId =  #  | 

try: 
    # Gets execution variables.
    api_response = api_instance.get_variables1(executionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnRuntimePublicAPIApi->getVariables1: %s\n" % e)

Parameters

Path parameters
Name Description
executionId*
Required

Responses

Status: 200 - OK


isExecutionExists

Check the execution is existed.


/runtime/is-execution-exists/by-business-key/{businessKey}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"/gw/bpmn-engine-server/runtime/is-execution-exists/by-business-key/{businessKey}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnRuntimePublicAPIApi;

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

public class BpmnRuntimePublicAPIApiExample {

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

public class BpmnRuntimePublicAPIApiExample {

    public static void main(String[] args) {
        BpmnRuntimePublicAPIApi apiInstance = new BpmnRuntimePublicAPIApi();
         businessKey = ; //  | 
        try {
            HvlResponseBoolean result = apiInstance.isExecutionExists(businessKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnRuntimePublicAPIApi#isExecutionExists");
            e.printStackTrace();
        }
    }
}
 *businessKey = ; // 

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

// Check the execution is existed.
[apiInstance isExecutionExistsWith:businessKey
              completionHandler: ^(HvlResponseBoolean output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnEngineServer = require('hvl_bpmn_engine_server');

var api = new HvlBpmnEngineServer.BpmnRuntimePublicAPIApi()
var businessKey = ; // {{}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.isExecutionExists(businessKey, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnRuntimePublicAPIApi();
            var businessKey = new (); //  | 

            try
            {
                // Check the execution is existed.
                HvlResponseBoolean result = apiInstance.isExecutionExists(businessKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnRuntimePublicAPIApi.isExecutionExists: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnRuntimePublicAPIApi();
$businessKey = ; //  | 

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

my $api_instance = WWW::SwaggerClient::BpmnRuntimePublicAPIApi->new();
my $businessKey = ; #  | 

eval { 
    my $result = $api_instance->isExecutionExists(businessKey => $businessKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnRuntimePublicAPIApi->isExecutionExists: $@\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.BpmnRuntimePublicAPIApi()
businessKey =  #  | 

try: 
    # Check the execution is existed.
    api_response = api_instance.is_execution_exists(businessKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnRuntimePublicAPIApi->isExecutionExists: %s\n" % e)

Parameters

Path parameters
Name Description
businessKey*
Required

Responses

Status: 200 - OK


queryList1

Query list.


/runtime/list

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/gw/bpmn-engine-server/runtime/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnRuntimePublicAPIApi;

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

public class BpmnRuntimePublicAPIApiExample {

    public static void main(String[] args) {
        
        BpmnRuntimePublicAPIApi apiInstance = new BpmnRuntimePublicAPIApi();
        HvlBpmnProcessInstanceQueryModel body = ; // HvlBpmnProcessInstanceQueryModel | 
        try {
            HvlResponseListHvlBpmnProcessInstanceModel result = apiInstance.queryList1(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnRuntimePublicAPIApi#queryList1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnRuntimePublicAPIApi;

public class BpmnRuntimePublicAPIApiExample {

    public static void main(String[] args) {
        BpmnRuntimePublicAPIApi apiInstance = new BpmnRuntimePublicAPIApi();
        HvlBpmnProcessInstanceQueryModel body = ; // HvlBpmnProcessInstanceQueryModel | 
        try {
            HvlResponseListHvlBpmnProcessInstanceModel result = apiInstance.queryList1(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnRuntimePublicAPIApi#queryList1");
            e.printStackTrace();
        }
    }
}
HvlBpmnProcessInstanceQueryModel *body = ; // 

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

// Query list.
[apiInstance queryList1With:body
              completionHandler: ^(HvlResponseListHvlBpmnProcessInstanceModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnEngineServer = require('hvl_bpmn_engine_server');

var api = new HvlBpmnEngineServer.BpmnRuntimePublicAPIApi()
var body = ; // {{HvlBpmnProcessInstanceQueryModel}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.queryList1(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnRuntimePublicAPIApi();
            var body = new HvlBpmnProcessInstanceQueryModel(); // HvlBpmnProcessInstanceQueryModel | 

            try
            {
                // Query list.
                HvlResponseListHvlBpmnProcessInstanceModel result = apiInstance.queryList1(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnRuntimePublicAPIApi.queryList1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnRuntimePublicAPIApi();
$body = ; // HvlBpmnProcessInstanceQueryModel | 

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

my $api_instance = WWW::SwaggerClient::BpmnRuntimePublicAPIApi->new();
my $body = WWW::SwaggerClient::Object::HvlBpmnProcessInstanceQueryModel->new(); # HvlBpmnProcessInstanceQueryModel | 

eval { 
    my $result = $api_instance->queryList1(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnRuntimePublicAPIApi->queryList1: $@\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.BpmnRuntimePublicAPIApi()
body =  # HvlBpmnProcessInstanceQueryModel | 

try: 
    # Query list.
    api_response = api_instance.query_list1(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnRuntimePublicAPIApi->queryList1: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


queryPage1

Query page.


/runtime/page

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/gw/bpmn-engine-server/runtime/page"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnRuntimePublicAPIApi;

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

public class BpmnRuntimePublicAPIApiExample {

    public static void main(String[] args) {
        
        BpmnRuntimePublicAPIApi apiInstance = new BpmnRuntimePublicAPIApi();
        HvlBpmnProcessInstanceQueryModel body = ; // HvlBpmnProcessInstanceQueryModel | 
        try {
            HvlResponseHvlPageHvlBpmnProcessInstanceModel result = apiInstance.queryPage1(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnRuntimePublicAPIApi#queryPage1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnRuntimePublicAPIApi;

public class BpmnRuntimePublicAPIApiExample {

    public static void main(String[] args) {
        BpmnRuntimePublicAPIApi apiInstance = new BpmnRuntimePublicAPIApi();
        HvlBpmnProcessInstanceQueryModel body = ; // HvlBpmnProcessInstanceQueryModel | 
        try {
            HvlResponseHvlPageHvlBpmnProcessInstanceModel result = apiInstance.queryPage1(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnRuntimePublicAPIApi#queryPage1");
            e.printStackTrace();
        }
    }
}
HvlBpmnProcessInstanceQueryModel *body = ; // 

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

// Query page.
[apiInstance queryPage1With:body
              completionHandler: ^(HvlResponseHvlPageHvlBpmnProcessInstanceModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnEngineServer = require('hvl_bpmn_engine_server');

var api = new HvlBpmnEngineServer.BpmnRuntimePublicAPIApi()
var body = ; // {{HvlBpmnProcessInstanceQueryModel}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.queryPage1(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnRuntimePublicAPIApi();
            var body = new HvlBpmnProcessInstanceQueryModel(); // HvlBpmnProcessInstanceQueryModel | 

            try
            {
                // Query page.
                HvlResponseHvlPageHvlBpmnProcessInstanceModel result = apiInstance.queryPage1(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnRuntimePublicAPIApi.queryPage1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnRuntimePublicAPIApi();
$body = ; // HvlBpmnProcessInstanceQueryModel | 

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

my $api_instance = WWW::SwaggerClient::BpmnRuntimePublicAPIApi->new();
my $body = WWW::SwaggerClient::Object::HvlBpmnProcessInstanceQueryModel->new(); # HvlBpmnProcessInstanceQueryModel | 

eval { 
    my $result = $api_instance->queryPage1(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnRuntimePublicAPIApi->queryPage1: $@\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.BpmnRuntimePublicAPIApi()
body =  # HvlBpmnProcessInstanceQueryModel | 

try: 
    # Query page.
    api_response = api_instance.query_page1(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnRuntimePublicAPIApi->queryPage1: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


setVariable

Sets execution variable.


/runtime/set-variable/by-execution-id/{executionId}/by-variable-name/{variableName}

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/gw/bpmn-engine-server/runtime/set-variable/by-execution-id/{executionId}/by-variable-name/{variableName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnRuntimePublicAPIApi;

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

public class BpmnRuntimePublicAPIApiExample {

    public static void main(String[] args) {
        
        BpmnRuntimePublicAPIApi apiInstance = new BpmnRuntimePublicAPIApi();
         body = ; //  | 
         executionId = ; //  | 
         variableName = ; //  | 
        try {
            HvlResponseVoid result = apiInstance.setVariable(body, executionId, variableName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnRuntimePublicAPIApi#setVariable");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnRuntimePublicAPIApi;

public class BpmnRuntimePublicAPIApiExample {

    public static void main(String[] args) {
        BpmnRuntimePublicAPIApi apiInstance = new BpmnRuntimePublicAPIApi();
         body = ; //  | 
         executionId = ; //  | 
         variableName = ; //  | 
        try {
            HvlResponseVoid result = apiInstance.setVariable(body, executionId, variableName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnRuntimePublicAPIApi#setVariable");
            e.printStackTrace();
        }
    }
}
 *body = ; // 
 *executionId = ; // 
 *variableName = ; // 

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

// Sets execution variable.
[apiInstance setVariableWith:body
    executionId:executionId
    variableName:variableName
              completionHandler: ^(HvlResponseVoid output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnEngineServer = require('hvl_bpmn_engine_server');

var api = new HvlBpmnEngineServer.BpmnRuntimePublicAPIApi()
var body = ; // {{}} 
var executionId = ; // {{}} 
var variableName = ; // {{}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.setVariable(bodyexecutionIdvariableName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnRuntimePublicAPIApi();
            var body = new (); //  | 
            var executionId = new (); //  | 
            var variableName = new (); //  | 

            try
            {
                // Sets execution variable.
                HvlResponseVoid result = apiInstance.setVariable(body, executionId, variableName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnRuntimePublicAPIApi.setVariable: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnRuntimePublicAPIApi();
$body = ; //  | 
$executionId = ; //  | 
$variableName = ; //  | 

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

my $api_instance = WWW::SwaggerClient::BpmnRuntimePublicAPIApi->new();
my $body = WWW::SwaggerClient::Object::->new(); #  | 
my $executionId = ; #  | 
my $variableName = ; #  | 

eval { 
    my $result = $api_instance->setVariable(body => $body, executionId => $executionId, variableName => $variableName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnRuntimePublicAPIApi->setVariable: $@\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.BpmnRuntimePublicAPIApi()
body =  #  | 
executionId =  #  | 
variableName =  #  | 

try: 
    # Sets execution variable.
    api_response = api_instance.set_variable(body, executionId, variableName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnRuntimePublicAPIApi->setVariable: %s\n" % e)

Parameters

Path parameters
Name Description
executionId*
Required
variableName*
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK


startProcessInstanceById

Start process instance by process definition id.


/runtime/start/by-process-defitinion-id/{processDefinitionId}

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/gw/bpmn-engine-server/runtime/start/by-process-defitinion-id/{processDefinitionId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnRuntimePublicAPIApi;

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

public class BpmnRuntimePublicAPIApiExample {

    public static void main(String[] args) {
        
        BpmnRuntimePublicAPIApi apiInstance = new BpmnRuntimePublicAPIApi();
        HvlBpmnStartProcessInstanceModel body = ; // HvlBpmnStartProcessInstanceModel | 
         processDefinitionId = ; //  | 
        try {
            HvlResponseHvlBpmnProcessInstanceModel result = apiInstance.startProcessInstanceById(body, processDefinitionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnRuntimePublicAPIApi#startProcessInstanceById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnRuntimePublicAPIApi;

public class BpmnRuntimePublicAPIApiExample {

    public static void main(String[] args) {
        BpmnRuntimePublicAPIApi apiInstance = new BpmnRuntimePublicAPIApi();
        HvlBpmnStartProcessInstanceModel body = ; // HvlBpmnStartProcessInstanceModel | 
         processDefinitionId = ; //  | 
        try {
            HvlResponseHvlBpmnProcessInstanceModel result = apiInstance.startProcessInstanceById(body, processDefinitionId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnRuntimePublicAPIApi#startProcessInstanceById");
            e.printStackTrace();
        }
    }
}
HvlBpmnStartProcessInstanceModel *body = ; // 
 *processDefinitionId = ; // 

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

// Start process instance by process definition id.
[apiInstance startProcessInstanceByIdWith:body
    processDefinitionId:processDefinitionId
              completionHandler: ^(HvlResponseHvlBpmnProcessInstanceModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnEngineServer = require('hvl_bpmn_engine_server');

var api = new HvlBpmnEngineServer.BpmnRuntimePublicAPIApi()
var body = ; // {{HvlBpmnStartProcessInstanceModel}} 
var processDefinitionId = ; // {{}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.startProcessInstanceById(bodyprocessDefinitionId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnRuntimePublicAPIApi();
            var body = new HvlBpmnStartProcessInstanceModel(); // HvlBpmnStartProcessInstanceModel | 
            var processDefinitionId = new (); //  | 

            try
            {
                // Start process instance by process definition id.
                HvlResponseHvlBpmnProcessInstanceModel result = apiInstance.startProcessInstanceById(body, processDefinitionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnRuntimePublicAPIApi.startProcessInstanceById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnRuntimePublicAPIApi();
$body = ; // HvlBpmnStartProcessInstanceModel | 
$processDefinitionId = ; //  | 

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

my $api_instance = WWW::SwaggerClient::BpmnRuntimePublicAPIApi->new();
my $body = WWW::SwaggerClient::Object::HvlBpmnStartProcessInstanceModel->new(); # HvlBpmnStartProcessInstanceModel | 
my $processDefinitionId = ; #  | 

eval { 
    my $result = $api_instance->startProcessInstanceById(body => $body, processDefinitionId => $processDefinitionId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnRuntimePublicAPIApi->startProcessInstanceById: $@\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.BpmnRuntimePublicAPIApi()
body =  # HvlBpmnStartProcessInstanceModel | 
processDefinitionId =  #  | 

try: 
    # Start process instance by process definition id.
    api_response = api_instance.start_process_instance_by_id(body, processDefinitionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnRuntimePublicAPIApi->startProcessInstanceById: %s\n" % e)

Parameters

Path parameters
Name Description
processDefinitionId*
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK


startProcessInstanceByKey1

Start process instance by process definition key.


/runtime/start/by-process-defitinion-key/{processDefinitionKey}

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/gw/bpmn-engine-server/runtime/start/by-process-defitinion-key/{processDefinitionKey}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnRuntimePublicAPIApi;

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

public class BpmnRuntimePublicAPIApiExample {

    public static void main(String[] args) {
        
        BpmnRuntimePublicAPIApi apiInstance = new BpmnRuntimePublicAPIApi();
        HvlBpmnStartProcessInstanceModel body = ; // HvlBpmnStartProcessInstanceModel | 
         processDefinitionKey = ; //  | 
        try {
            HvlResponseHvlBpmnProcessInstanceModel result = apiInstance.startProcessInstanceByKey1(body, processDefinitionKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnRuntimePublicAPIApi#startProcessInstanceByKey1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnRuntimePublicAPIApi;

public class BpmnRuntimePublicAPIApiExample {

    public static void main(String[] args) {
        BpmnRuntimePublicAPIApi apiInstance = new BpmnRuntimePublicAPIApi();
        HvlBpmnStartProcessInstanceModel body = ; // HvlBpmnStartProcessInstanceModel | 
         processDefinitionKey = ; //  | 
        try {
            HvlResponseHvlBpmnProcessInstanceModel result = apiInstance.startProcessInstanceByKey1(body, processDefinitionKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnRuntimePublicAPIApi#startProcessInstanceByKey1");
            e.printStackTrace();
        }
    }
}
HvlBpmnStartProcessInstanceModel *body = ; // 
 *processDefinitionKey = ; // 

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

// Start process instance by process definition key.
[apiInstance startProcessInstanceByKey1With:body
    processDefinitionKey:processDefinitionKey
              completionHandler: ^(HvlResponseHvlBpmnProcessInstanceModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnEngineServer = require('hvl_bpmn_engine_server');

var api = new HvlBpmnEngineServer.BpmnRuntimePublicAPIApi()
var body = ; // {{HvlBpmnStartProcessInstanceModel}} 
var processDefinitionKey = ; // {{}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.startProcessInstanceByKey1(bodyprocessDefinitionKey, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnRuntimePublicAPIApi();
            var body = new HvlBpmnStartProcessInstanceModel(); // HvlBpmnStartProcessInstanceModel | 
            var processDefinitionKey = new (); //  | 

            try
            {
                // Start process instance by process definition key.
                HvlResponseHvlBpmnProcessInstanceModel result = apiInstance.startProcessInstanceByKey1(body, processDefinitionKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnRuntimePublicAPIApi.startProcessInstanceByKey1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnRuntimePublicAPIApi();
$body = ; // HvlBpmnStartProcessInstanceModel | 
$processDefinitionKey = ; //  | 

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

my $api_instance = WWW::SwaggerClient::BpmnRuntimePublicAPIApi->new();
my $body = WWW::SwaggerClient::Object::HvlBpmnStartProcessInstanceModel->new(); # HvlBpmnStartProcessInstanceModel | 
my $processDefinitionKey = ; #  | 

eval { 
    my $result = $api_instance->startProcessInstanceByKey1(body => $body, processDefinitionKey => $processDefinitionKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnRuntimePublicAPIApi->startProcessInstanceByKey1: $@\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.BpmnRuntimePublicAPIApi()
body =  # HvlBpmnStartProcessInstanceModel | 
processDefinitionKey =  #  | 

try: 
    # Start process instance by process definition key.
    api_response = api_instance.start_process_instance_by_key1(body, processDefinitionKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnRuntimePublicAPIApi->startProcessInstanceByKey1: %s\n" % e)

Parameters

Path parameters
Name Description
processDefinitionKey*
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK


BpmnSchedulerPublicAPI

finishScheduler

Finishs scheduler job.


/scheduler/finish/by-business-key-list

Usage and SDK Samples

curl -X POST\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"/gw/bpmn-engine-server/scheduler/finish/by-business-key-list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnSchedulerPublicAPIApi;

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

public class BpmnSchedulerPublicAPIApiExample {

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

public class BpmnSchedulerPublicAPIApiExample {

    public static void main(String[] args) {
        BpmnSchedulerPublicAPIApi apiInstance = new BpmnSchedulerPublicAPIApi();
         body = ; //  | 
        try {
            HvlResponseVoid result = apiInstance.finishScheduler(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnSchedulerPublicAPIApi#finishScheduler");
            e.printStackTrace();
        }
    }
}
 *body = ; // 

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

// Finishs scheduler job.
[apiInstance finishSchedulerWith:body
              completionHandler: ^(HvlResponseVoid output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnEngineServer = require('hvl_bpmn_engine_server');

var api = new HvlBpmnEngineServer.BpmnSchedulerPublicAPIApi()
var body = ; // {{}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.finishScheduler(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnSchedulerPublicAPIApi();
            var body = new (); //  | 

            try
            {
                // Finishs scheduler job.
                HvlResponseVoid result = apiInstance.finishScheduler(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnSchedulerPublicAPIApi.finishScheduler: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnSchedulerPublicAPIApi();
$body = ; //  | 

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

my $api_instance = WWW::SwaggerClient::BpmnSchedulerPublicAPIApi->new();
my $body = WWW::SwaggerClient::Object::->new(); #  | 

eval { 
    my $result = $api_instance->finishScheduler(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnSchedulerPublicAPIApi->finishScheduler: $@\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.BpmnSchedulerPublicAPIApi()
body =  #  | 

try: 
    # Finishs scheduler job.
    api_response = api_instance.finish_scheduler(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnSchedulerPublicAPIApi->finishScheduler: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


restartScheduler

Restarts async scheduler job.


/scheduler/restart/{processInstanceId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"/gw/bpmn-engine-server/scheduler/restart/{processInstanceId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnSchedulerPublicAPIApi;

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

public class BpmnSchedulerPublicAPIApiExample {

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

public class BpmnSchedulerPublicAPIApiExample {

    public static void main(String[] args) {
        BpmnSchedulerPublicAPIApi apiInstance = new BpmnSchedulerPublicAPIApi();
         processInstanceId = ; //  | 
        try {
            HvlResponseHvlBpmnProcessInstanceModel result = apiInstance.restartScheduler(processInstanceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnSchedulerPublicAPIApi#restartScheduler");
            e.printStackTrace();
        }
    }
}
 *processInstanceId = ; // 

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

// Restarts async scheduler job.
[apiInstance restartSchedulerWith:processInstanceId
              completionHandler: ^(HvlResponseHvlBpmnProcessInstanceModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnEngineServer = require('hvl_bpmn_engine_server');

var api = new HvlBpmnEngineServer.BpmnSchedulerPublicAPIApi()
var processInstanceId = ; // {{}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.restartScheduler(processInstanceId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnSchedulerPublicAPIApi();
            var processInstanceId = new (); //  | 

            try
            {
                // Restarts async scheduler job.
                HvlResponseHvlBpmnProcessInstanceModel result = apiInstance.restartScheduler(processInstanceId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnSchedulerPublicAPIApi.restartScheduler: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnSchedulerPublicAPIApi();
$processInstanceId = ; //  | 

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

my $api_instance = WWW::SwaggerClient::BpmnSchedulerPublicAPIApi->new();
my $processInstanceId = ; #  | 

eval { 
    my $result = $api_instance->restartScheduler(processInstanceId => $processInstanceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnSchedulerPublicAPIApi->restartScheduler: $@\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.BpmnSchedulerPublicAPIApi()
processInstanceId =  #  | 

try: 
    # Restarts async scheduler job.
    api_response = api_instance.restart_scheduler(processInstanceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnSchedulerPublicAPIApi->restartScheduler: %s\n" % e)

Parameters

Path parameters
Name Description
processInstanceId*
Required

Responses

Status: 200 - OK


startAsyncScheduler

Starts async scheduler job.


/scheduler/start/async/{overrideJob}

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/gw/bpmn-engine-server/scheduler/start/async/{overrideJob}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnSchedulerPublicAPIApi;

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

public class BpmnSchedulerPublicAPIApiExample {

    public static void main(String[] args) {
        
        BpmnSchedulerPublicAPIApi apiInstance = new BpmnSchedulerPublicAPIApi();
        HvlBpmnSchedulerModel body = ; // HvlBpmnSchedulerModel | 
         overrideJob = ; //  | 
        try {
            HvlResponseHvlBpmnProcessInstanceModel result = apiInstance.startAsyncScheduler(body, overrideJob);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnSchedulerPublicAPIApi#startAsyncScheduler");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnSchedulerPublicAPIApi;

public class BpmnSchedulerPublicAPIApiExample {

    public static void main(String[] args) {
        BpmnSchedulerPublicAPIApi apiInstance = new BpmnSchedulerPublicAPIApi();
        HvlBpmnSchedulerModel body = ; // HvlBpmnSchedulerModel | 
         overrideJob = ; //  | 
        try {
            HvlResponseHvlBpmnProcessInstanceModel result = apiInstance.startAsyncScheduler(body, overrideJob);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnSchedulerPublicAPIApi#startAsyncScheduler");
            e.printStackTrace();
        }
    }
}
HvlBpmnSchedulerModel *body = ; // 
 *overrideJob = ; // 

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

// Starts async scheduler job.
[apiInstance startAsyncSchedulerWith:body
    overrideJob:overrideJob
              completionHandler: ^(HvlResponseHvlBpmnProcessInstanceModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnEngineServer = require('hvl_bpmn_engine_server');

var api = new HvlBpmnEngineServer.BpmnSchedulerPublicAPIApi()
var body = ; // {{HvlBpmnSchedulerModel}} 
var overrideJob = ; // {{}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.startAsyncScheduler(bodyoverrideJob, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnSchedulerPublicAPIApi();
            var body = new HvlBpmnSchedulerModel(); // HvlBpmnSchedulerModel | 
            var overrideJob = new (); //  | 

            try
            {
                // Starts async scheduler job.
                HvlResponseHvlBpmnProcessInstanceModel result = apiInstance.startAsyncScheduler(body, overrideJob);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnSchedulerPublicAPIApi.startAsyncScheduler: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnSchedulerPublicAPIApi();
$body = ; // HvlBpmnSchedulerModel | 
$overrideJob = ; //  | 

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

my $api_instance = WWW::SwaggerClient::BpmnSchedulerPublicAPIApi->new();
my $body = WWW::SwaggerClient::Object::HvlBpmnSchedulerModel->new(); # HvlBpmnSchedulerModel | 
my $overrideJob = ; #  | 

eval { 
    my $result = $api_instance->startAsyncScheduler(body => $body, overrideJob => $overrideJob);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnSchedulerPublicAPIApi->startAsyncScheduler: $@\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.BpmnSchedulerPublicAPIApi()
body =  # HvlBpmnSchedulerModel | 
overrideJob =  #  | 

try: 
    # Starts async scheduler job.
    api_response = api_instance.start_async_scheduler(body, overrideJob)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnSchedulerPublicAPIApi->startAsyncScheduler: %s\n" % e)

Parameters

Path parameters
Name Description
overrideJob*
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK


startSyncScheduler

Starts sync scheduler job.


/scheduler/start/sync/{overrideJob}

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/gw/bpmn-engine-server/scheduler/start/sync/{overrideJob}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnSchedulerPublicAPIApi;

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

public class BpmnSchedulerPublicAPIApiExample {

    public static void main(String[] args) {
        
        BpmnSchedulerPublicAPIApi apiInstance = new BpmnSchedulerPublicAPIApi();
        HvlBpmnSchedulerModel body = ; // HvlBpmnSchedulerModel | 
         overrideJob = ; //  | 
        try {
            HvlResponseHvlBpmnProcessInstanceModel result = apiInstance.startSyncScheduler(body, overrideJob);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnSchedulerPublicAPIApi#startSyncScheduler");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnSchedulerPublicAPIApi;

public class BpmnSchedulerPublicAPIApiExample {

    public static void main(String[] args) {
        BpmnSchedulerPublicAPIApi apiInstance = new BpmnSchedulerPublicAPIApi();
        HvlBpmnSchedulerModel body = ; // HvlBpmnSchedulerModel | 
         overrideJob = ; //  | 
        try {
            HvlResponseHvlBpmnProcessInstanceModel result = apiInstance.startSyncScheduler(body, overrideJob);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnSchedulerPublicAPIApi#startSyncScheduler");
            e.printStackTrace();
        }
    }
}
HvlBpmnSchedulerModel *body = ; // 
 *overrideJob = ; // 

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

// Starts sync scheduler job.
[apiInstance startSyncSchedulerWith:body
    overrideJob:overrideJob
              completionHandler: ^(HvlResponseHvlBpmnProcessInstanceModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnEngineServer = require('hvl_bpmn_engine_server');

var api = new HvlBpmnEngineServer.BpmnSchedulerPublicAPIApi()
var body = ; // {{HvlBpmnSchedulerModel}} 
var overrideJob = ; // {{}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.startSyncScheduler(bodyoverrideJob, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnSchedulerPublicAPIApi();
            var body = new HvlBpmnSchedulerModel(); // HvlBpmnSchedulerModel | 
            var overrideJob = new (); //  | 

            try
            {
                // Starts sync scheduler job.
                HvlResponseHvlBpmnProcessInstanceModel result = apiInstance.startSyncScheduler(body, overrideJob);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnSchedulerPublicAPIApi.startSyncScheduler: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnSchedulerPublicAPIApi();
$body = ; // HvlBpmnSchedulerModel | 
$overrideJob = ; //  | 

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

my $api_instance = WWW::SwaggerClient::BpmnSchedulerPublicAPIApi->new();
my $body = WWW::SwaggerClient::Object::HvlBpmnSchedulerModel->new(); # HvlBpmnSchedulerModel | 
my $overrideJob = ; #  | 

eval { 
    my $result = $api_instance->startSyncScheduler(body => $body, overrideJob => $overrideJob);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnSchedulerPublicAPIApi->startSyncScheduler: $@\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.BpmnSchedulerPublicAPIApi()
body =  # HvlBpmnSchedulerModel | 
overrideJob =  #  | 

try: 
    # Starts sync scheduler job.
    api_response = api_instance.start_sync_scheduler(body, overrideJob)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnSchedulerPublicAPIApi->startSyncScheduler: %s\n" % e)

Parameters

Path parameters
Name Description
overrideJob*
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK


BpmnTaskPublicAPI

claim

Claims the task.


/task/{id}/claim/{assignee}

Usage and SDK Samples

curl -X GET\
-H "Accept: */*"\
"/gw/bpmn-engine-server/task/{id}/claim/{assignee}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnTaskPublicAPIApi;

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

public class BpmnTaskPublicAPIApiExample {

    public static void main(String[] args) {
        
        BpmnTaskPublicAPIApi apiInstance = new BpmnTaskPublicAPIApi();
         id = ; //  | 
         assignee = ; //  | 
        try {
            HvlResponseVoid result = apiInstance.claim(id, assignee);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnTaskPublicAPIApi#claim");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnTaskPublicAPIApi;

public class BpmnTaskPublicAPIApiExample {

    public static void main(String[] args) {
        BpmnTaskPublicAPIApi apiInstance = new BpmnTaskPublicAPIApi();
         id = ; //  | 
         assignee = ; //  | 
        try {
            HvlResponseVoid result = apiInstance.claim(id, assignee);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnTaskPublicAPIApi#claim");
            e.printStackTrace();
        }
    }
}
 *id = ; // 
 *assignee = ; // 

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

// Claims the task.
[apiInstance claimWith:id
    assignee:assignee
              completionHandler: ^(HvlResponseVoid output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnEngineServer = require('hvl_bpmn_engine_server');

var api = new HvlBpmnEngineServer.BpmnTaskPublicAPIApi()
var id = ; // {{}} 
var assignee = ; // {{}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.claim(id, assignee, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnTaskPublicAPIApi();
            var id = new (); //  | 
            var assignee = new (); //  | 

            try
            {
                // Claims the task.
                HvlResponseVoid result = apiInstance.claim(id, assignee);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnTaskPublicAPIApi.claim: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnTaskPublicAPIApi();
$id = ; //  | 
$assignee = ; //  | 

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

my $api_instance = WWW::SwaggerClient::BpmnTaskPublicAPIApi->new();
my $id = ; #  | 
my $assignee = ; #  | 

eval { 
    my $result = $api_instance->claim(id => $id, assignee => $assignee);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnTaskPublicAPIApi->claim: $@\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.BpmnTaskPublicAPIApi()
id =  #  | 
assignee =  #  | 

try: 
    # Claims the task.
    api_response = api_instance.claim(id, assignee)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnTaskPublicAPIApi->claim: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Required
assignee*
Required

Responses

Status: 200 - OK


complete

Completes the task.


/task/complete

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/gw/bpmn-engine-server/task/complete"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnTaskPublicAPIApi;

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

public class BpmnTaskPublicAPIApiExample {

    public static void main(String[] args) {
        
        BpmnTaskPublicAPIApi apiInstance = new BpmnTaskPublicAPIApi();
        HvlBpmnCompleteTaskModel body = ; // HvlBpmnCompleteTaskModel | 
        try {
            HvlResponseVoid result = apiInstance.complete(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnTaskPublicAPIApi#complete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnTaskPublicAPIApi;

public class BpmnTaskPublicAPIApiExample {

    public static void main(String[] args) {
        BpmnTaskPublicAPIApi apiInstance = new BpmnTaskPublicAPIApi();
        HvlBpmnCompleteTaskModel body = ; // HvlBpmnCompleteTaskModel | 
        try {
            HvlResponseVoid result = apiInstance.complete(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnTaskPublicAPIApi#complete");
            e.printStackTrace();
        }
    }
}
HvlBpmnCompleteTaskModel *body = ; // 

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

// Completes the task.
[apiInstance completeWith:body
              completionHandler: ^(HvlResponseVoid output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnEngineServer = require('hvl_bpmn_engine_server');

var api = new HvlBpmnEngineServer.BpmnTaskPublicAPIApi()
var body = ; // {{HvlBpmnCompleteTaskModel}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.complete(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnTaskPublicAPIApi();
            var body = new HvlBpmnCompleteTaskModel(); // HvlBpmnCompleteTaskModel | 

            try
            {
                // Completes the task.
                HvlResponseVoid result = apiInstance.complete(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnTaskPublicAPIApi.complete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnTaskPublicAPIApi();
$body = ; // HvlBpmnCompleteTaskModel | 

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

my $api_instance = WWW::SwaggerClient::BpmnTaskPublicAPIApi->new();
my $body = WWW::SwaggerClient::Object::HvlBpmnCompleteTaskModel->new(); # HvlBpmnCompleteTaskModel | 

eval { 
    my $result = $api_instance->complete(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnTaskPublicAPIApi->complete: $@\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.BpmnTaskPublicAPIApi()
body =  # HvlBpmnCompleteTaskModel | 

try: 
    # Completes the task.
    api_response = api_instance.complete(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnTaskPublicAPIApi->complete: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


confirmTask

Confirms the task.


/task/confirm/{id}

Usage and SDK Samples

curl -X GET\
-H "Accept: */*"\
"/gw/bpmn-engine-server/task/confirm/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnTaskPublicAPIApi;

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

public class BpmnTaskPublicAPIApiExample {

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

public class BpmnTaskPublicAPIApiExample {

    public static void main(String[] args) {
        BpmnTaskPublicAPIApi apiInstance = new BpmnTaskPublicAPIApi();
         id = ; //  | 
        try {
            HvlResponseVoid result = apiInstance.confirmTask(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnTaskPublicAPIApi#confirmTask");
            e.printStackTrace();
        }
    }
}
 *id = ; // 

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

// Confirms the task.
[apiInstance confirmTaskWith:id
              completionHandler: ^(HvlResponseVoid output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnEngineServer = require('hvl_bpmn_engine_server');

var api = new HvlBpmnEngineServer.BpmnTaskPublicAPIApi()
var id = ; // {{}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.confirmTask(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnTaskPublicAPIApi();
            var id = new (); //  | 

            try
            {
                // Confirms the task.
                HvlResponseVoid result = apiInstance.confirmTask(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnTaskPublicAPIApi.confirmTask: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnTaskPublicAPIApi();
$id = ; //  | 

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

my $api_instance = WWW::SwaggerClient::BpmnTaskPublicAPIApi->new();
my $id = ; #  | 

eval { 
    my $result = $api_instance->confirmTask(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnTaskPublicAPIApi->confirmTask: $@\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.BpmnTaskPublicAPIApi()
id =  #  | 

try: 
    # Confirms the task.
    api_response = api_instance.confirm_task(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnTaskPublicAPIApi->confirmTask: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Required

Responses

Status: 200 - OK


getById

Gets the task by id.


/task/{id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"/gw/bpmn-engine-server/task/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnTaskPublicAPIApi;

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

public class BpmnTaskPublicAPIApiExample {

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

public class BpmnTaskPublicAPIApiExample {

    public static void main(String[] args) {
        BpmnTaskPublicAPIApi apiInstance = new BpmnTaskPublicAPIApi();
         id = ; //  | 
        try {
            HvlResponseHvlBpmnTaskModel result = apiInstance.getById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnTaskPublicAPIApi#getById");
            e.printStackTrace();
        }
    }
}
 *id = ; // 

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

// Gets the task by id.
[apiInstance getByIdWith:id
              completionHandler: ^(HvlResponseHvlBpmnTaskModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnEngineServer = require('hvl_bpmn_engine_server');

var api = new HvlBpmnEngineServer.BpmnTaskPublicAPIApi()
var id = ; // {{}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getById(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnTaskPublicAPIApi();
            var id = new (); //  | 

            try
            {
                // Gets the task by id.
                HvlResponseHvlBpmnTaskModel result = apiInstance.getById(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnTaskPublicAPIApi.getById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnTaskPublicAPIApi();
$id = ; //  | 

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

my $api_instance = WWW::SwaggerClient::BpmnTaskPublicAPIApi->new();
my $id = ; #  | 

eval { 
    my $result = $api_instance->getById(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnTaskPublicAPIApi->getById: $@\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.BpmnTaskPublicAPIApi()
id =  #  | 

try: 
    # Gets the task by id.
    api_response = api_instance.get_by_id(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnTaskPublicAPIApi->getById: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Required

Responses

Status: 200 - OK


getVariable1

Gets the task variable.


/task/variable/{taskId}/{variableName}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"/gw/bpmn-engine-server/task/variable/{taskId}/{variableName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnTaskPublicAPIApi;

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

public class BpmnTaskPublicAPIApiExample {

    public static void main(String[] args) {
        
        BpmnTaskPublicAPIApi apiInstance = new BpmnTaskPublicAPIApi();
         taskId = ; //  | 
         variableName = ; //  | 
        try {
            HvlResponseObject result = apiInstance.getVariable1(taskId, variableName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnTaskPublicAPIApi#getVariable1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnTaskPublicAPIApi;

public class BpmnTaskPublicAPIApiExample {

    public static void main(String[] args) {
        BpmnTaskPublicAPIApi apiInstance = new BpmnTaskPublicAPIApi();
         taskId = ; //  | 
         variableName = ; //  | 
        try {
            HvlResponseObject result = apiInstance.getVariable1(taskId, variableName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnTaskPublicAPIApi#getVariable1");
            e.printStackTrace();
        }
    }
}
 *taskId = ; // 
 *variableName = ; // 

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

// Gets the task variable.
[apiInstance getVariable1With:taskId
    variableName:variableName
              completionHandler: ^(HvlResponseObject output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnEngineServer = require('hvl_bpmn_engine_server');

var api = new HvlBpmnEngineServer.BpmnTaskPublicAPIApi()
var taskId = ; // {{}} 
var variableName = ; // {{}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVariable1(taskId, variableName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnTaskPublicAPIApi();
            var taskId = new (); //  | 
            var variableName = new (); //  | 

            try
            {
                // Gets the task variable.
                HvlResponseObject result = apiInstance.getVariable1(taskId, variableName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnTaskPublicAPIApi.getVariable1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnTaskPublicAPIApi();
$taskId = ; //  | 
$variableName = ; //  | 

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

my $api_instance = WWW::SwaggerClient::BpmnTaskPublicAPIApi->new();
my $taskId = ; #  | 
my $variableName = ; #  | 

eval { 
    my $result = $api_instance->getVariable1(taskId => $taskId, variableName => $variableName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnTaskPublicAPIApi->getVariable1: $@\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.BpmnTaskPublicAPIApi()
taskId =  #  | 
variableName =  #  | 

try: 
    # Gets the task variable.
    api_response = api_instance.get_variable1(taskId, variableName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnTaskPublicAPIApi->getVariable1: %s\n" % e)

Parameters

Path parameters
Name Description
taskId*
Required
variableName*
Required

Responses

Status: 200 - OK


getVariables

Gets the task variables.


/task/variables/{taskId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"/gw/bpmn-engine-server/task/variables/{taskId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnTaskPublicAPIApi;

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

public class BpmnTaskPublicAPIApiExample {

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

public class BpmnTaskPublicAPIApiExample {

    public static void main(String[] args) {
        BpmnTaskPublicAPIApi apiInstance = new BpmnTaskPublicAPIApi();
         taskId = ; //  | 
        try {
            HvlResponseMapStringObject result = apiInstance.getVariables(taskId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnTaskPublicAPIApi#getVariables");
            e.printStackTrace();
        }
    }
}
 *taskId = ; // 

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

// Gets the task variables.
[apiInstance getVariablesWith:taskId
              completionHandler: ^(HvlResponseMapStringObject output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnEngineServer = require('hvl_bpmn_engine_server');

var api = new HvlBpmnEngineServer.BpmnTaskPublicAPIApi()
var taskId = ; // {{}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVariables(taskId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnTaskPublicAPIApi();
            var taskId = new (); //  | 

            try
            {
                // Gets the task variables.
                HvlResponseMapStringObject result = apiInstance.getVariables(taskId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnTaskPublicAPIApi.getVariables: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnTaskPublicAPIApi();
$taskId = ; //  | 

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

my $api_instance = WWW::SwaggerClient::BpmnTaskPublicAPIApi->new();
my $taskId = ; #  | 

eval { 
    my $result = $api_instance->getVariables(taskId => $taskId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnTaskPublicAPIApi->getVariables: $@\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.BpmnTaskPublicAPIApi()
taskId =  #  | 

try: 
    # Gets the task variables.
    api_response = api_instance.get_variables(taskId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnTaskPublicAPIApi->getVariables: %s\n" % e)

Parameters

Path parameters
Name Description
taskId*
Required

Responses

Status: 200 - OK


queryActiveUserTaskPage

Queries active user tasks as paginated according to criteria in query model


/task/active-user/page

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/gw/bpmn-engine-server/task/active-user/page"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnTaskPublicAPIApi;

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

public class BpmnTaskPublicAPIApiExample {

    public static void main(String[] args) {
        
        BpmnTaskPublicAPIApi apiInstance = new BpmnTaskPublicAPIApi();
        HvlBpmnTaskQueryModel body = ; // HvlBpmnTaskQueryModel | 
        try {
            HvlResponseHvlPageHvlBpmnTaskModel result = apiInstance.queryActiveUserTaskPage(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnTaskPublicAPIApi#queryActiveUserTaskPage");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnTaskPublicAPIApi;

public class BpmnTaskPublicAPIApiExample {

    public static void main(String[] args) {
        BpmnTaskPublicAPIApi apiInstance = new BpmnTaskPublicAPIApi();
        HvlBpmnTaskQueryModel body = ; // HvlBpmnTaskQueryModel | 
        try {
            HvlResponseHvlPageHvlBpmnTaskModel result = apiInstance.queryActiveUserTaskPage(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnTaskPublicAPIApi#queryActiveUserTaskPage");
            e.printStackTrace();
        }
    }
}
HvlBpmnTaskQueryModel *body = ; // 

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

// Queries active user tasks as paginated according to criteria in query model
[apiInstance queryActiveUserTaskPageWith:body
              completionHandler: ^(HvlResponseHvlPageHvlBpmnTaskModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnEngineServer = require('hvl_bpmn_engine_server');

var api = new HvlBpmnEngineServer.BpmnTaskPublicAPIApi()
var body = ; // {{HvlBpmnTaskQueryModel}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.queryActiveUserTaskPage(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnTaskPublicAPIApi();
            var body = new HvlBpmnTaskQueryModel(); // HvlBpmnTaskQueryModel | 

            try
            {
                // Queries active user tasks as paginated according to criteria in query model
                HvlResponseHvlPageHvlBpmnTaskModel result = apiInstance.queryActiveUserTaskPage(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnTaskPublicAPIApi.queryActiveUserTaskPage: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnTaskPublicAPIApi();
$body = ; // HvlBpmnTaskQueryModel | 

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

my $api_instance = WWW::SwaggerClient::BpmnTaskPublicAPIApi->new();
my $body = WWW::SwaggerClient::Object::HvlBpmnTaskQueryModel->new(); # HvlBpmnTaskQueryModel | 

eval { 
    my $result = $api_instance->queryActiveUserTaskPage(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnTaskPublicAPIApi->queryActiveUserTaskPage: $@\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.BpmnTaskPublicAPIApi()
body =  # HvlBpmnTaskQueryModel | 

try: 
    # Queries active user tasks as paginated according to criteria in query model
    api_response = api_instance.query_active_user_task_page(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnTaskPublicAPIApi->queryActiveUserTaskPage: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


queryList

Query list.


/task/list

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/gw/bpmn-engine-server/task/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnTaskPublicAPIApi;

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

public class BpmnTaskPublicAPIApiExample {

    public static void main(String[] args) {
        
        BpmnTaskPublicAPIApi apiInstance = new BpmnTaskPublicAPIApi();
        HvlBpmnTaskQueryModel body = ; // HvlBpmnTaskQueryModel | 
        try {
            HvlResponseListHvlBpmnTaskModel result = apiInstance.queryList(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnTaskPublicAPIApi#queryList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnTaskPublicAPIApi;

public class BpmnTaskPublicAPIApiExample {

    public static void main(String[] args) {
        BpmnTaskPublicAPIApi apiInstance = new BpmnTaskPublicAPIApi();
        HvlBpmnTaskQueryModel body = ; // HvlBpmnTaskQueryModel | 
        try {
            HvlResponseListHvlBpmnTaskModel result = apiInstance.queryList(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnTaskPublicAPIApi#queryList");
            e.printStackTrace();
        }
    }
}
HvlBpmnTaskQueryModel *body = ; // 

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

// Query list.
[apiInstance queryListWith:body
              completionHandler: ^(HvlResponseListHvlBpmnTaskModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnEngineServer = require('hvl_bpmn_engine_server');

var api = new HvlBpmnEngineServer.BpmnTaskPublicAPIApi()
var body = ; // {{HvlBpmnTaskQueryModel}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.queryList(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnTaskPublicAPIApi();
            var body = new HvlBpmnTaskQueryModel(); // HvlBpmnTaskQueryModel | 

            try
            {
                // Query list.
                HvlResponseListHvlBpmnTaskModel result = apiInstance.queryList(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnTaskPublicAPIApi.queryList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnTaskPublicAPIApi();
$body = ; // HvlBpmnTaskQueryModel | 

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

my $api_instance = WWW::SwaggerClient::BpmnTaskPublicAPIApi->new();
my $body = WWW::SwaggerClient::Object::HvlBpmnTaskQueryModel->new(); # HvlBpmnTaskQueryModel | 

eval { 
    my $result = $api_instance->queryList(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnTaskPublicAPIApi->queryList: $@\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.BpmnTaskPublicAPIApi()
body =  # HvlBpmnTaskQueryModel | 

try: 
    # Query list.
    api_response = api_instance.query_list(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnTaskPublicAPIApi->queryList: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


queryPage

Query page.


/task/page

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/gw/bpmn-engine-server/task/page"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnTaskPublicAPIApi;

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

public class BpmnTaskPublicAPIApiExample {

    public static void main(String[] args) {
        
        BpmnTaskPublicAPIApi apiInstance = new BpmnTaskPublicAPIApi();
        HvlBpmnTaskQueryModel body = ; // HvlBpmnTaskQueryModel | 
        try {
            HvlResponseHvlPageHvlBpmnTaskModel result = apiInstance.queryPage(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnTaskPublicAPIApi#queryPage");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnTaskPublicAPIApi;

public class BpmnTaskPublicAPIApiExample {

    public static void main(String[] args) {
        BpmnTaskPublicAPIApi apiInstance = new BpmnTaskPublicAPIApi();
        HvlBpmnTaskQueryModel body = ; // HvlBpmnTaskQueryModel | 
        try {
            HvlResponseHvlPageHvlBpmnTaskModel result = apiInstance.queryPage(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnTaskPublicAPIApi#queryPage");
            e.printStackTrace();
        }
    }
}
HvlBpmnTaskQueryModel *body = ; // 

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

// Query page.
[apiInstance queryPageWith:body
              completionHandler: ^(HvlResponseHvlPageHvlBpmnTaskModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnEngineServer = require('hvl_bpmn_engine_server');

var api = new HvlBpmnEngineServer.BpmnTaskPublicAPIApi()
var body = ; // {{HvlBpmnTaskQueryModel}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.queryPage(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnTaskPublicAPIApi();
            var body = new HvlBpmnTaskQueryModel(); // HvlBpmnTaskQueryModel | 

            try
            {
                // Query page.
                HvlResponseHvlPageHvlBpmnTaskModel result = apiInstance.queryPage(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnTaskPublicAPIApi.queryPage: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnTaskPublicAPIApi();
$body = ; // HvlBpmnTaskQueryModel | 

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

my $api_instance = WWW::SwaggerClient::BpmnTaskPublicAPIApi->new();
my $body = WWW::SwaggerClient::Object::HvlBpmnTaskQueryModel->new(); # HvlBpmnTaskQueryModel | 

eval { 
    my $result = $api_instance->queryPage(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnTaskPublicAPIApi->queryPage: $@\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.BpmnTaskPublicAPIApi()
body =  # HvlBpmnTaskQueryModel | 

try: 
    # Query page.
    api_response = api_instance.query_page(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnTaskPublicAPIApi->queryPage: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


rejectTask

Rejects the task.


/task/reject/{id}

Usage and SDK Samples

curl -X GET\
-H "Accept: */*"\
"/gw/bpmn-engine-server/task/reject/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnTaskPublicAPIApi;

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

public class BpmnTaskPublicAPIApiExample {

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

public class BpmnTaskPublicAPIApiExample {

    public static void main(String[] args) {
        BpmnTaskPublicAPIApi apiInstance = new BpmnTaskPublicAPIApi();
         id = ; //  | 
        try {
            HvlResponseVoid result = apiInstance.rejectTask(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnTaskPublicAPIApi#rejectTask");
            e.printStackTrace();
        }
    }
}
 *id = ; // 

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

// Rejects the task.
[apiInstance rejectTaskWith:id
              completionHandler: ^(HvlResponseVoid output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnEngineServer = require('hvl_bpmn_engine_server');

var api = new HvlBpmnEngineServer.BpmnTaskPublicAPIApi()
var id = ; // {{}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.rejectTask(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnTaskPublicAPIApi();
            var id = new (); //  | 

            try
            {
                // Rejects the task.
                HvlResponseVoid result = apiInstance.rejectTask(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnTaskPublicAPIApi.rejectTask: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnTaskPublicAPIApi();
$id = ; //  | 

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

my $api_instance = WWW::SwaggerClient::BpmnTaskPublicAPIApi->new();
my $id = ; #  | 

eval { 
    my $result = $api_instance->rejectTask(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnTaskPublicAPIApi->rejectTask: $@\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.BpmnTaskPublicAPIApi()
id =  #  | 

try: 
    # Rejects the task.
    api_response = api_instance.reject_task(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnTaskPublicAPIApi->rejectTask: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Required

Responses

Status: 200 - OK


unclaim

Unclaims the task.


/task/{id}/unclaim

Usage and SDK Samples

curl -X GET\
-H "Accept: */*"\
"/gw/bpmn-engine-server/task/{id}/unclaim"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnTaskPublicAPIApi;

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

public class BpmnTaskPublicAPIApiExample {

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

public class BpmnTaskPublicAPIApiExample {

    public static void main(String[] args) {
        BpmnTaskPublicAPIApi apiInstance = new BpmnTaskPublicAPIApi();
         id = ; //  | 
        try {
            HvlResponseVoid result = apiInstance.unclaim(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnTaskPublicAPIApi#unclaim");
            e.printStackTrace();
        }
    }
}
 *id = ; // 

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

// Unclaims the task.
[apiInstance unclaimWith:id
              completionHandler: ^(HvlResponseVoid output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnEngineServer = require('hvl_bpmn_engine_server');

var api = new HvlBpmnEngineServer.BpmnTaskPublicAPIApi()
var id = ; // {{}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.unclaim(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnTaskPublicAPIApi();
            var id = new (); //  | 

            try
            {
                // Unclaims the task.
                HvlResponseVoid result = apiInstance.unclaim(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnTaskPublicAPIApi.unclaim: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnTaskPublicAPIApi();
$id = ; //  | 

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

my $api_instance = WWW::SwaggerClient::BpmnTaskPublicAPIApi->new();
my $id = ; #  | 

eval { 
    my $result = $api_instance->unclaim(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnTaskPublicAPIApi->unclaim: $@\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.BpmnTaskPublicAPIApi()
id =  #  | 

try: 
    # Unclaims the task.
    api_response = api_instance.unclaim(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnTaskPublicAPIApi->unclaim: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Required

Responses

Status: 200 - OK


BpmnTransactionalPublicAPI

completeRollback

Completes distributed transaction rollback step.


/transactional/complete-rollback/business-key/{businessKey}

Usage and SDK Samples

curl -X POST\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"/gw/bpmn-engine-server/transactional/complete-rollback/business-key/{businessKey}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnTransactionalPublicAPIApi;

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

public class BpmnTransactionalPublicAPIApiExample {

    public static void main(String[] args) {
        
        BpmnTransactionalPublicAPIApi apiInstance = new BpmnTransactionalPublicAPIApi();
         body = ; //  | 
         businessKey = ; //  | 
        try {
            HvlResponseVoid result = apiInstance.completeRollback(body, businessKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnTransactionalPublicAPIApi#completeRollback");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnTransactionalPublicAPIApi;

public class BpmnTransactionalPublicAPIApiExample {

    public static void main(String[] args) {
        BpmnTransactionalPublicAPIApi apiInstance = new BpmnTransactionalPublicAPIApi();
         body = ; //  | 
         businessKey = ; //  | 
        try {
            HvlResponseVoid result = apiInstance.completeRollback(body, businessKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnTransactionalPublicAPIApi#completeRollback");
            e.printStackTrace();
        }
    }
}
 *body = ; // 
 *businessKey = ; // 

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

// Completes distributed transaction rollback step.
[apiInstance completeRollbackWith:body
    businessKey:businessKey
              completionHandler: ^(HvlResponseVoid output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnEngineServer = require('hvl_bpmn_engine_server');

var api = new HvlBpmnEngineServer.BpmnTransactionalPublicAPIApi()
var body = ; // {{}} 
var businessKey = ; // {{}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.completeRollback(bodybusinessKey, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnTransactionalPublicAPIApi();
            var body = new (); //  | 
            var businessKey = new (); //  | 

            try
            {
                // Completes distributed transaction rollback step.
                HvlResponseVoid result = apiInstance.completeRollback(body, businessKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnTransactionalPublicAPIApi.completeRollback: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnTransactionalPublicAPIApi();
$body = ; //  | 
$businessKey = ; //  | 

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

my $api_instance = WWW::SwaggerClient::BpmnTransactionalPublicAPIApi->new();
my $body = WWW::SwaggerClient::Object::->new(); #  | 
my $businessKey = ; #  | 

eval { 
    my $result = $api_instance->completeRollback(body => $body, businessKey => $businessKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnTransactionalPublicAPIApi->completeRollback: $@\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.BpmnTransactionalPublicAPIApi()
body =  #  | 
businessKey =  #  | 

try: 
    # Completes distributed transaction rollback step.
    api_response = api_instance.complete_rollback(body, businessKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnTransactionalPublicAPIApi->completeRollback: %s\n" % e)

Parameters

Path parameters
Name Description
businessKey*
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK


completeStep

Completes distributed transaction step.


/transactional/complete-step/business-key/{businessKey}

Usage and SDK Samples

curl -X POST\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"/gw/bpmn-engine-server/transactional/complete-step/business-key/{businessKey}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnTransactionalPublicAPIApi;

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

public class BpmnTransactionalPublicAPIApiExample {

    public static void main(String[] args) {
        
        BpmnTransactionalPublicAPIApi apiInstance = new BpmnTransactionalPublicAPIApi();
         body = ; //  | 
         businessKey = ; //  | 
        try {
            HvlResponseVoid result = apiInstance.completeStep(body, businessKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnTransactionalPublicAPIApi#completeStep");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnTransactionalPublicAPIApi;

public class BpmnTransactionalPublicAPIApiExample {

    public static void main(String[] args) {
        BpmnTransactionalPublicAPIApi apiInstance = new BpmnTransactionalPublicAPIApi();
         body = ; //  | 
         businessKey = ; //  | 
        try {
            HvlResponseVoid result = apiInstance.completeStep(body, businessKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnTransactionalPublicAPIApi#completeStep");
            e.printStackTrace();
        }
    }
}
 *body = ; // 
 *businessKey = ; // 

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

// Completes distributed transaction step.
[apiInstance completeStepWith:body
    businessKey:businessKey
              completionHandler: ^(HvlResponseVoid output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnEngineServer = require('hvl_bpmn_engine_server');

var api = new HvlBpmnEngineServer.BpmnTransactionalPublicAPIApi()
var body = ; // {{}} 
var businessKey = ; // {{}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.completeStep(bodybusinessKey, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnTransactionalPublicAPIApi();
            var body = new (); //  | 
            var businessKey = new (); //  | 

            try
            {
                // Completes distributed transaction step.
                HvlResponseVoid result = apiInstance.completeStep(body, businessKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnTransactionalPublicAPIApi.completeStep: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnTransactionalPublicAPIApi();
$body = ; //  | 
$businessKey = ; //  | 

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

my $api_instance = WWW::SwaggerClient::BpmnTransactionalPublicAPIApi->new();
my $body = WWW::SwaggerClient::Object::->new(); #  | 
my $businessKey = ; #  | 

eval { 
    my $result = $api_instance->completeStep(body => $body, businessKey => $businessKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnTransactionalPublicAPIApi->completeStep: $@\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.BpmnTransactionalPublicAPIApi()
body =  #  | 
businessKey =  #  | 

try: 
    # Completes distributed transaction step.
    api_response = api_instance.complete_step(body, businessKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnTransactionalPublicAPIApi->completeStep: %s\n" % e)

Parameters

Path parameters
Name Description
businessKey*
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK


startProcessInstanceByKey

Start process instance which includes distributed transaction sub activity by process definition key.


/transactional/start/by-process-defitinion-key/{processDefinitionKey}

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/gw/bpmn-engine-server/transactional/start/by-process-defitinion-key/{processDefinitionKey}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnTransactionalPublicAPIApi;

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

public class BpmnTransactionalPublicAPIApiExample {

    public static void main(String[] args) {
        
        BpmnTransactionalPublicAPIApi apiInstance = new BpmnTransactionalPublicAPIApi();
        HvlBpmnStartProcessInstanceModel body = ; // HvlBpmnStartProcessInstanceModel | 
         processDefinitionKey = ; //  | 
        try {
            HvlResponseHvlBpmnProcessInstanceModel result = apiInstance.startProcessInstanceByKey(body, processDefinitionKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnTransactionalPublicAPIApi#startProcessInstanceByKey");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnTransactionalPublicAPIApi;

public class BpmnTransactionalPublicAPIApiExample {

    public static void main(String[] args) {
        BpmnTransactionalPublicAPIApi apiInstance = new BpmnTransactionalPublicAPIApi();
        HvlBpmnStartProcessInstanceModel body = ; // HvlBpmnStartProcessInstanceModel | 
         processDefinitionKey = ; //  | 
        try {
            HvlResponseHvlBpmnProcessInstanceModel result = apiInstance.startProcessInstanceByKey(body, processDefinitionKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnTransactionalPublicAPIApi#startProcessInstanceByKey");
            e.printStackTrace();
        }
    }
}
HvlBpmnStartProcessInstanceModel *body = ; // 
 *processDefinitionKey = ; // 

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

// Start process instance which includes distributed transaction sub activity by process definition key.
[apiInstance startProcessInstanceByKeyWith:body
    processDefinitionKey:processDefinitionKey
              completionHandler: ^(HvlResponseHvlBpmnProcessInstanceModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnEngineServer = require('hvl_bpmn_engine_server');

var api = new HvlBpmnEngineServer.BpmnTransactionalPublicAPIApi()
var body = ; // {{HvlBpmnStartProcessInstanceModel}} 
var processDefinitionKey = ; // {{}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.startProcessInstanceByKey(bodyprocessDefinitionKey, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnTransactionalPublicAPIApi();
            var body = new HvlBpmnStartProcessInstanceModel(); // HvlBpmnStartProcessInstanceModel | 
            var processDefinitionKey = new (); //  | 

            try
            {
                // Start process instance which includes distributed transaction sub activity by process definition key.
                HvlResponseHvlBpmnProcessInstanceModel result = apiInstance.startProcessInstanceByKey(body, processDefinitionKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnTransactionalPublicAPIApi.startProcessInstanceByKey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnTransactionalPublicAPIApi();
$body = ; // HvlBpmnStartProcessInstanceModel | 
$processDefinitionKey = ; //  | 

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

my $api_instance = WWW::SwaggerClient::BpmnTransactionalPublicAPIApi->new();
my $body = WWW::SwaggerClient::Object::HvlBpmnStartProcessInstanceModel->new(); # HvlBpmnStartProcessInstanceModel | 
my $processDefinitionKey = ; #  | 

eval { 
    my $result = $api_instance->startProcessInstanceByKey(body => $body, processDefinitionKey => $processDefinitionKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnTransactionalPublicAPIApi->startProcessInstanceByKey: $@\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.BpmnTransactionalPublicAPIApi()
body =  # HvlBpmnStartProcessInstanceModel | 
processDefinitionKey =  #  | 

try: 
    # Start process instance which includes distributed transaction sub activity by process definition key.
    api_response = api_instance.start_process_instance_by_key(body, processDefinitionKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnTransactionalPublicAPIApi->startProcessInstanceByKey: %s\n" % e)

Parameters

Path parameters
Name Description
processDefinitionKey*
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK


startRollback

Starts distributed transaction rollback step.


/transactional/start-rollback/business-key/{businessKey}

Usage and SDK Samples

curl -X POST\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"/gw/bpmn-engine-server/transactional/start-rollback/business-key/{businessKey}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnTransactionalPublicAPIApi;

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

public class BpmnTransactionalPublicAPIApiExample {

    public static void main(String[] args) {
        
        BpmnTransactionalPublicAPIApi apiInstance = new BpmnTransactionalPublicAPIApi();
         body = ; //  | 
         businessKey = ; //  | 
        try {
            HvlResponseVoid result = apiInstance.startRollback(body, businessKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnTransactionalPublicAPIApi#startRollback");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnTransactionalPublicAPIApi;

public class BpmnTransactionalPublicAPIApiExample {

    public static void main(String[] args) {
        BpmnTransactionalPublicAPIApi apiInstance = new BpmnTransactionalPublicAPIApi();
         body = ; //  | 
         businessKey = ; //  | 
        try {
            HvlResponseVoid result = apiInstance.startRollback(body, businessKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnTransactionalPublicAPIApi#startRollback");
            e.printStackTrace();
        }
    }
}
 *body = ; // 
 *businessKey = ; // 

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

// Starts distributed transaction rollback step.
[apiInstance startRollbackWith:body
    businessKey:businessKey
              completionHandler: ^(HvlResponseVoid output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnEngineServer = require('hvl_bpmn_engine_server');

var api = new HvlBpmnEngineServer.BpmnTransactionalPublicAPIApi()
var body = ; // {{}} 
var businessKey = ; // {{}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.startRollback(bodybusinessKey, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnTransactionalPublicAPIApi();
            var body = new (); //  | 
            var businessKey = new (); //  | 

            try
            {
                // Starts distributed transaction rollback step.
                HvlResponseVoid result = apiInstance.startRollback(body, businessKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnTransactionalPublicAPIApi.startRollback: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnTransactionalPublicAPIApi();
$body = ; //  | 
$businessKey = ; //  | 

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

my $api_instance = WWW::SwaggerClient::BpmnTransactionalPublicAPIApi->new();
my $body = WWW::SwaggerClient::Object::->new(); #  | 
my $businessKey = ; #  | 

eval { 
    my $result = $api_instance->startRollback(body => $body, businessKey => $businessKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnTransactionalPublicAPIApi->startRollback: $@\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.BpmnTransactionalPublicAPIApi()
body =  #  | 
businessKey =  #  | 

try: 
    # Starts distributed transaction rollback step.
    api_response = api_instance.start_rollback(body, businessKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnTransactionalPublicAPIApi->startRollback: %s\n" % e)

Parameters

Path parameters
Name Description
businessKey*
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK