Hvl Bpmn Admin Server

BpmnAdminRepositoryAPI

activateProcessDefinition

Activate process definition by key


/admin/repository/activate

Usage and SDK Samples

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

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

public class BpmnAdminRepositoryAPIApiExample {

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

public class BpmnAdminRepositoryAPIApiExample {

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

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

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

var api = new HvlBpmnAdminServer.BpmnAdminRepositoryAPIApi()
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 BpmnAdminRepositoryAPIApi();
            var body = new HvlBpmnActivateProcessDefinitionModel(); // HvlBpmnActivateProcessDefinitionModel | 

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

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

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

my $api_instance = WWW::SwaggerClient::BpmnAdminRepositoryAPIApi->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 BpmnAdminRepositoryAPIApi->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.BpmnAdminRepositoryAPIApi()
body =  # HvlBpmnActivateProcessDefinitionModel | 

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

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


findLatestProcessDefinitionByKey

Find latest process definition by key


/admin/repository/latest/by-key/{key}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"/gw/bpmn-admin-server/admin/repository/latest/by-key/{key}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnAdminRepositoryAPIApi;

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

public class BpmnAdminRepositoryAPIApiExample {

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

public class BpmnAdminRepositoryAPIApiExample {

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

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

// Find latest process definition by key
[apiInstance findLatestProcessDefinitionByKeyWith:key
              completionHandler: ^(HvlResponseListHvlBpmnProcessDefinitionModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnAdminRepositoryAPIApi()
var key = ; // {{}} 

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

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

            var apiInstance = new BpmnAdminRepositoryAPIApi();
            var key = new (); //  | 

            try
            {
                // Find latest process definition by key
                HvlResponseListHvlBpmnProcessDefinitionModel result = apiInstance.findLatestProcessDefinitionByKey(key);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnAdminRepositoryAPIApi.findLatestProcessDefinitionByKey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnAdminRepositoryAPIApi();
$key = ; //  | 

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

my $api_instance = WWW::SwaggerClient::BpmnAdminRepositoryAPIApi->new();
my $key = ; #  | 

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

try: 
    # Find latest process definition by key
    api_response = api_instance.find_latest_process_definition_by_key(key)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnAdminRepositoryAPIApi->findLatestProcessDefinitionByKey: %s\n" % e)

Parameters

Path parameters
Name Description
key*
Required

Responses

Status: 200 - OK


suspendProcessDefinition

Suspend process definition by key


/admin/repository/suspend

Usage and SDK Samples

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

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

public class BpmnAdminRepositoryAPIApiExample {

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

public class BpmnAdminRepositoryAPIApiExample {

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

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

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

var api = new HvlBpmnAdminServer.BpmnAdminRepositoryAPIApi()
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 BpmnAdminRepositoryAPIApi();
            var body = new HvlBpmnSuspendProcessDefinitionModel(); // HvlBpmnSuspendProcessDefinitionModel | 

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

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

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

my $api_instance = WWW::SwaggerClient::BpmnAdminRepositoryAPIApi->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 BpmnAdminRepositoryAPIApi->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.BpmnAdminRepositoryAPIApi()
body =  # HvlBpmnSuspendProcessDefinitionModel | 

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

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


BpmnDisplayJsonClientResourceAPI

getDebuggerModelJSON

Gets debugger model json


/display/process-instances/debugger/{processInstanceId}/model-json

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"/gw/bpmn-admin-server/display/process-instances/debugger/{processInstanceId}/model-json"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnDisplayJsonClientResourceAPIApi;

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

public class BpmnDisplayJsonClientResourceAPIApiExample {

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

public class BpmnDisplayJsonClientResourceAPIApiExample {

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

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

// Gets debugger model json
[apiInstance getDebuggerModelJSONWith:processInstanceId
              completionHandler: ^(JsonNode output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnDisplayJsonClientResourceAPIApi()
var processInstanceId = ; // {{}} 

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

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

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

            try
            {
                // Gets debugger model json
                JsonNode result = apiInstance.getDebuggerModelJSON(processInstanceId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnDisplayJsonClientResourceAPIApi.getDebuggerModelJSON: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

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

try: 
    # Gets debugger model json
    api_response = api_instance.get_debugger_model_json(processInstanceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnDisplayJsonClientResourceAPIApi->getDebuggerModelJSON: %s\n" % e)

Parameters

Path parameters
Name Description
processInstanceId*
Required

Responses

Status: 200 - OK


getModelHistoryJSON

Gets model history json


/display/process-instances/history/{processInstanceId}/model-json

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"/gw/bpmn-admin-server/display/process-instances/history/{processInstanceId}/model-json"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnDisplayJsonClientResourceAPIApi;

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

public class BpmnDisplayJsonClientResourceAPIApiExample {

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

public class BpmnDisplayJsonClientResourceAPIApiExample {

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

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

// Gets model history json
[apiInstance getModelHistoryJSONWith:processInstanceId
              completionHandler: ^(JsonNode output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnDisplayJsonClientResourceAPIApi()
var processInstanceId = ; // {{}} 

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

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

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

            try
            {
                // Gets model history json
                JsonNode result = apiInstance.getModelHistoryJSON(processInstanceId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnDisplayJsonClientResourceAPIApi.getModelHistoryJSON: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

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

try: 
    # Gets model history json
    api_response = api_instance.get_model_history_json(processInstanceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnDisplayJsonClientResourceAPIApi->getModelHistoryJSON: %s\n" % e)

Parameters

Path parameters
Name Description
processInstanceId*
Required

Responses

Status: 200 - OK


getModelJSON

Gets model json


/display/process-instances/{processInstanceId}/model-json

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"/gw/bpmn-admin-server/display/process-instances/{processInstanceId}/model-json"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnDisplayJsonClientResourceAPIApi;

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

public class BpmnDisplayJsonClientResourceAPIApiExample {

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

public class BpmnDisplayJsonClientResourceAPIApiExample {

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

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

// Gets model json
[apiInstance getModelJSONWith:processInstanceId
              completionHandler: ^(JsonNode output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnDisplayJsonClientResourceAPIApi()
var processInstanceId = ; // {{}} 

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

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

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

            try
            {
                // Gets model json
                JsonNode result = apiInstance.getModelJSON(processInstanceId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnDisplayJsonClientResourceAPIApi.getModelJSON: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

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

try: 
    # Gets model json
    api_response = api_instance.get_model_json(processInstanceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnDisplayJsonClientResourceAPIApi->getModelJSON: %s\n" % e)

Parameters

Path parameters
Name Description
processInstanceId*
Required

Responses

Status: 200 - OK


getModelJSONForProcessDefinition

Gets model json for process definition


/display/process-definitions/{processDefinitionId}/model-json

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"/gw/bpmn-admin-server/display/process-definitions/{processDefinitionId}/model-json"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnDisplayJsonClientResourceAPIApi;

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

public class BpmnDisplayJsonClientResourceAPIApiExample {

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

public class BpmnDisplayJsonClientResourceAPIApiExample {

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

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

// Gets model json for process definition
[apiInstance getModelJSONForProcessDefinitionWith:processDefinitionId
              completionHandler: ^(JsonNode output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnDisplayJsonClientResourceAPIApi()
var processDefinitionId = ; // {{}} 

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

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

            var apiInstance = new BpmnDisplayJsonClientResourceAPIApi();
            var processDefinitionId = new (); //  | 

            try
            {
                // Gets model json for process definition
                JsonNode result = apiInstance.getModelJSONForProcessDefinition(processDefinitionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnDisplayJsonClientResourceAPIApi.getModelJSONForProcessDefinition: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnDisplayJsonClientResourceAPIApi();
$processDefinitionId = ; //  | 

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

my $api_instance = WWW::SwaggerClient::BpmnDisplayJsonClientResourceAPIApi->new();
my $processDefinitionId = ; #  | 

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

try: 
    # Gets model json for process definition
    api_response = api_instance.get_model_json_for_process_definition(processDefinitionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnDisplayJsonClientResourceAPIApi->getModelJSONForProcessDefinition: %s\n" % e)

Parameters

Path parameters
Name Description
processDefinitionId*
Required

Responses

Status: 200 - OK


getModelJSONForProcessDefinitionInstanceCount

Gets model json for process definition


/display/process-definitions-instance-count/{processDefinitionId}/model-json

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"/gw/bpmn-admin-server/display/process-definitions-instance-count/{processDefinitionId}/model-json"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnDisplayJsonClientResourceAPIApi;

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

public class BpmnDisplayJsonClientResourceAPIApiExample {

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

public class BpmnDisplayJsonClientResourceAPIApiExample {

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

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

// Gets model json for process definition
[apiInstance getModelJSONForProcessDefinitionInstanceCountWith:processDefinitionId
              completionHandler: ^(JsonNode output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnDisplayJsonClientResourceAPIApi()
var processDefinitionId = ; // {{}} 

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

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

            var apiInstance = new BpmnDisplayJsonClientResourceAPIApi();
            var processDefinitionId = new (); //  | 

            try
            {
                // Gets model json for process definition
                JsonNode result = apiInstance.getModelJSONForProcessDefinitionInstanceCount(processDefinitionId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnDisplayJsonClientResourceAPIApi.getModelJSONForProcessDefinitionInstanceCount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnDisplayJsonClientResourceAPIApi();
$processDefinitionId = ; //  | 

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

my $api_instance = WWW::SwaggerClient::BpmnDisplayJsonClientResourceAPIApi->new();
my $processDefinitionId = ; #  | 

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

try: 
    # Gets model json for process definition
    api_response = api_instance.get_model_json_for_process_definition_instance_count(processDefinitionId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnDisplayJsonClientResourceAPIApi->getModelJSONForProcessDefinitionInstanceCount: %s\n" % e)

Parameters

Path parameters
Name Description
processDefinitionId*
Required

Responses

Status: 200 - OK


BpmnHistoricProcessInstanceAPI

queryList8

Queries process instances according to criteria in query model


/historic/process/instance/list

Usage and SDK Samples

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

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

public class BpmnHistoricProcessInstanceAPIApiExample {

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

public class BpmnHistoricProcessInstanceAPIApiExample {

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

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

// Queries process instances according to criteria in query model
[apiInstance queryList8With:body
              completionHandler: ^(HvlResponseListHvlBpmnAdminProcessInstanceModel_WithHistory output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnHistoricProcessInstanceAPIApi()
var body = ; // {{HvlBpmnAdminProcessInstanceQueryModel_WithHistory}} 

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

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

            var apiInstance = new BpmnHistoricProcessInstanceAPIApi();
            var body = new HvlBpmnAdminProcessInstanceQueryModel_WithHistory(); // HvlBpmnAdminProcessInstanceQueryModel_WithHistory | 

            try
            {
                // Queries process instances according to criteria in query model
                HvlResponseListHvlBpmnAdminProcessInstanceModel_WithHistory result = apiInstance.queryList8(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnHistoricProcessInstanceAPIApi.queryList8: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

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

try: 
    # Queries process instances according to criteria in query model
    api_response = api_instance.query_list8(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnHistoricProcessInstanceAPIApi->queryList8: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


queryPage7

Queries process instances as paginated according to criteria in query model


/historic/process/instance/page

Usage and SDK Samples

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

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

public class BpmnHistoricProcessInstanceAPIApiExample {

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

public class BpmnHistoricProcessInstanceAPIApiExample {

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

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

// Queries process instances as paginated according to criteria in query model
[apiInstance queryPage7With:body
              completionHandler: ^(HvlResponseHvlPageHvlBpmnAdminProcessInstanceModel_WithHistory output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnHistoricProcessInstanceAPIApi()
var body = ; // {{HvlBpmnAdminProcessInstanceQueryModel_WithHistory}} 

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

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

            var apiInstance = new BpmnHistoricProcessInstanceAPIApi();
            var body = new HvlBpmnAdminProcessInstanceQueryModel_WithHistory(); // HvlBpmnAdminProcessInstanceQueryModel_WithHistory | 

            try
            {
                // Queries process instances as paginated according to criteria in query model
                HvlResponseHvlPageHvlBpmnAdminProcessInstanceModel_WithHistory result = apiInstance.queryPage7(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnHistoricProcessInstanceAPIApi.queryPage7: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

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

try: 
    # Queries process instances as paginated according to criteria in query model
    api_response = api_instance.query_page7(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnHistoricProcessInstanceAPIApi->queryPage7: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


BpmnKeyPerformanceIndicatorAdminAPI

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-admin-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.BpmnKeyPerformanceIndicatorAdminAPIApi;

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

public class BpmnKeyPerformanceIndicatorAdminAPIApiExample {

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

public class BpmnKeyPerformanceIndicatorAdminAPIApiExample {

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

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

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

var api = new HvlBpmnAdminServer.BpmnKeyPerformanceIndicatorAdminAPIApi()
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 BpmnKeyPerformanceIndicatorAdminAPIApi();
            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 BpmnKeyPerformanceIndicatorAdminAPIApi.calculateResult: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

my $api_instance = WWW::SwaggerClient::BpmnKeyPerformanceIndicatorAdminAPIApi->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 BpmnKeyPerformanceIndicatorAdminAPIApi->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.BpmnKeyPerformanceIndicatorAdminAPIApi()
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 BpmnKeyPerformanceIndicatorAdminAPIApi->calculateResult: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


deleteByUuid1

Deletes key performance indicator by uuid


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

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"/gw/bpmn-admin-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.BpmnKeyPerformanceIndicatorAdminAPIApi;

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

public class BpmnKeyPerformanceIndicatorAdminAPIApiExample {

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

public class BpmnKeyPerformanceIndicatorAdminAPIApiExample {

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

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

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

var api = new HvlBpmnAdminServer.BpmnKeyPerformanceIndicatorAdminAPIApi()
var uuid = ; // {{}} 

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

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

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

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

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

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

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

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

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

Parameters

Path parameters
Name Description
uuid*
Required

Responses

Status: 200 - OK


getByUuid1

Gets key performance indicator by uuid


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

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"/gw/bpmn-admin-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.BpmnKeyPerformanceIndicatorAdminAPIApi;

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

public class BpmnKeyPerformanceIndicatorAdminAPIApiExample {

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

public class BpmnKeyPerformanceIndicatorAdminAPIApiExample {

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

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

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

var api = new HvlBpmnAdminServer.BpmnKeyPerformanceIndicatorAdminAPIApi()
var uuid = ; // {{}} 

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

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

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

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

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

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

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

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

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

Parameters

Path parameters
Name Description
uuid*
Required

Responses

Status: 200 - OK


queryList4

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-admin-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.BpmnKeyPerformanceIndicatorAdminAPIApi;

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

public class BpmnKeyPerformanceIndicatorAdminAPIApiExample {

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

public class BpmnKeyPerformanceIndicatorAdminAPIApiExample {

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

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

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

var api = new HvlBpmnAdminServer.BpmnKeyPerformanceIndicatorAdminAPIApi()
var body = ; // {{HvlBpmnKeyPerformanceIndicatorQueryModel}} 

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 BpmnKeyPerformanceIndicatorAdminAPIApi();
            var body = new HvlBpmnKeyPerformanceIndicatorQueryModel(); // HvlBpmnKeyPerformanceIndicatorQueryModel | 

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

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

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

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

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

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

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


queryPage4

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-admin-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.BpmnKeyPerformanceIndicatorAdminAPIApi;

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

public class BpmnKeyPerformanceIndicatorAdminAPIApiExample {

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

public class BpmnKeyPerformanceIndicatorAdminAPIApiExample {

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

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

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

var api = new HvlBpmnAdminServer.BpmnKeyPerformanceIndicatorAdminAPIApi()
var body = ; // {{HvlBpmnKeyPerformanceIndicatorQueryModel}} 

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 BpmnKeyPerformanceIndicatorAdminAPIApi();
            var body = new HvlBpmnKeyPerformanceIndicatorQueryModel(); // HvlBpmnKeyPerformanceIndicatorQueryModel | 

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

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

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

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

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

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

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


save1

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-admin-server/kpi/key-performance-indicator"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnKeyPerformanceIndicatorAdminAPIApi;

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

public class BpmnKeyPerformanceIndicatorAdminAPIApiExample {

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

public class BpmnKeyPerformanceIndicatorAdminAPIApiExample {

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

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

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

var api = new HvlBpmnAdminServer.BpmnKeyPerformanceIndicatorAdminAPIApi()
var body = ; // {{HvlBpmnKeyPerformanceIndicatorModel}} 

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

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

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

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

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

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

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

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

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

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


update2

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-admin-server/kpi/key-performance-indicator"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnKeyPerformanceIndicatorAdminAPIApi;

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

public class BpmnKeyPerformanceIndicatorAdminAPIApiExample {

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

public class BpmnKeyPerformanceIndicatorAdminAPIApiExample {

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

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

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

var api = new HvlBpmnAdminServer.BpmnKeyPerformanceIndicatorAdminAPIApi()
var body = ; // {{HvlBpmnKeyPerformanceIndicatorModel}} 

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

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

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

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

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

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

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

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

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

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


BpmnKeyPerformanceIndicatorDashboardAPI

deleteByUuid3

Deletes key performance indicator dashboard by uuid


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

Usage and SDK Samples

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

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

public class BpmnKeyPerformanceIndicatorDashboardAPIApiExample {

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

public class BpmnKeyPerformanceIndicatorDashboardAPIApiExample {

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

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

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

var api = new HvlBpmnAdminServer.BpmnKeyPerformanceIndicatorDashboardAPIApi()
var uuid = ; // {{}} 

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

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

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

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

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

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

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

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

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

Parameters

Path parameters
Name Description
uuid*
Required

Responses

Status: 200 - OK


getByCode

Gets key performance indicator dashboard by code


/kpi/key-performance-indicator-dashboard/code/{code}

Usage and SDK Samples

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

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

public class BpmnKeyPerformanceIndicatorDashboardAPIApiExample {

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

public class BpmnKeyPerformanceIndicatorDashboardAPIApiExample {

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

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

// Gets key performance indicator dashboard by code
[apiInstance getByCodeWith:code
              completionHandler: ^(HvlResponseHvlBpmnKeyPerformanceIndicatorDashboardDataModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnKeyPerformanceIndicatorDashboardAPIApi()
var code = ; // {{}} 

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

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

            var apiInstance = new BpmnKeyPerformanceIndicatorDashboardAPIApi();
            var code = new (); //  | 

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

$api_instance = new Swagger\Client\ApiBpmnKeyPerformanceIndicatorDashboardAPIApi();
$code = ; //  | 

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

my $api_instance = WWW::SwaggerClient::BpmnKeyPerformanceIndicatorDashboardAPIApi->new();
my $code = ; #  | 

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

try: 
    # Gets key performance indicator dashboard by code
    api_response = api_instance.get_by_code(code)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnKeyPerformanceIndicatorDashboardAPIApi->getByCode: %s\n" % e)

Parameters

Path parameters
Name Description
code*
Required

Responses

Status: 200 - OK


getByUuid3

Gets key performance indicator dashboard by uuid


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

Usage and SDK Samples

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

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

public class BpmnKeyPerformanceIndicatorDashboardAPIApiExample {

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

public class BpmnKeyPerformanceIndicatorDashboardAPIApiExample {

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

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

// Gets key performance indicator dashboard by uuid
[apiInstance getByUuid3With:uuid
              completionHandler: ^(HvlResponseHvlBpmnKeyPerformanceIndicatorDashboardDataModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnKeyPerformanceIndicatorDashboardAPIApi()
var uuid = ; // {{}} 

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

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

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

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

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

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

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

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

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

Parameters

Path parameters
Name Description
uuid*
Required

Responses

Status: 200 - OK


queryList7

Queries key performance indicator dashboards according to criteria in query model


/kpi/key-performance-indicator-dashboard/list

Usage and SDK Samples

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

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

public class BpmnKeyPerformanceIndicatorDashboardAPIApiExample {

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

public class BpmnKeyPerformanceIndicatorDashboardAPIApiExample {

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

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

// Queries key performance indicator dashboards according to criteria in query model
[apiInstance queryList7With:body
              completionHandler: ^(HvlResponseListHvlBpmnKeyPerformanceIndicatorDashboardModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnKeyPerformanceIndicatorDashboardAPIApi()
var body = ; // {{HvlBpmnKeyPerformanceIndicatorDashboardQueryModel}} 

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

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

            var apiInstance = new BpmnKeyPerformanceIndicatorDashboardAPIApi();
            var body = new HvlBpmnKeyPerformanceIndicatorDashboardQueryModel(); // HvlBpmnKeyPerformanceIndicatorDashboardQueryModel | 

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

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

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

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

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

try: 
    # Queries key performance indicator dashboards according to criteria in query model
    api_response = api_instance.query_list7(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnKeyPerformanceIndicatorDashboardAPIApi->queryList7: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


queryPage6

Queries key performance indicator dashboards as paginated according to criteria in query model


/kpi/key-performance-indicator-dashboard/page

Usage and SDK Samples

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

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

public class BpmnKeyPerformanceIndicatorDashboardAPIApiExample {

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

public class BpmnKeyPerformanceIndicatorDashboardAPIApiExample {

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

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

// Queries key performance indicator dashboards as paginated according to criteria in query model
[apiInstance queryPage6With:body
              completionHandler: ^(HvlResponseHvlPageHvlBpmnKeyPerformanceIndicatorDashboardModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnKeyPerformanceIndicatorDashboardAPIApi()
var body = ; // {{HvlBpmnKeyPerformanceIndicatorDashboardQueryModel}} 

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

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

            var apiInstance = new BpmnKeyPerformanceIndicatorDashboardAPIApi();
            var body = new HvlBpmnKeyPerformanceIndicatorDashboardQueryModel(); // HvlBpmnKeyPerformanceIndicatorDashboardQueryModel | 

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

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

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

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

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

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

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


save3

Saves key performance indicator dashboard


/kpi/key-performance-indicator-dashboard

Usage and SDK Samples

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

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

public class BpmnKeyPerformanceIndicatorDashboardAPIApiExample {

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

public class BpmnKeyPerformanceIndicatorDashboardAPIApiExample {

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

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

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

var api = new HvlBpmnAdminServer.BpmnKeyPerformanceIndicatorDashboardAPIApi()
var body = ; // {{HvlBpmnKeyPerformanceIndicatorDashboardPersistModel}} 

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

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

            var apiInstance = new BpmnKeyPerformanceIndicatorDashboardAPIApi();
            var body = new HvlBpmnKeyPerformanceIndicatorDashboardPersistModel(); // HvlBpmnKeyPerformanceIndicatorDashboardPersistModel | 

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

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

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

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

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

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

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


searchAuthorities

Searches the report authorities.


/kpi/key-performance-indicator-dashboard/authorities/search

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"/gw/bpmn-admin-server/kpi/key-performance-indicator-dashboard/authorities/search?authority-search-exp=&max-result-size="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnKeyPerformanceIndicatorDashboardAPIApi;

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

public class BpmnKeyPerformanceIndicatorDashboardAPIApiExample {

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

public class BpmnKeyPerformanceIndicatorDashboardAPIApiExample {

    public static void main(String[] args) {
        BpmnKeyPerformanceIndicatorDashboardAPIApi apiInstance = new BpmnKeyPerformanceIndicatorDashboardAPIApi();
         authoritySearchExp = ; //  | 
         maxResultSize = ; //  | 
        try {
            HvlResponseSetString result = apiInstance.searchAuthorities(authoritySearchExp, maxResultSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnKeyPerformanceIndicatorDashboardAPIApi#searchAuthorities");
            e.printStackTrace();
        }
    }
}
 *authoritySearchExp = ; // 
 *maxResultSize = ; // 

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

// Searches the report authorities.
[apiInstance searchAuthoritiesWith:authoritySearchExp
    maxResultSize:maxResultSize
              completionHandler: ^(HvlResponseSetString output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnKeyPerformanceIndicatorDashboardAPIApi()
var authoritySearchExp = ; // {{}} 
var maxResultSize = ; // {{}} 

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

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

            var apiInstance = new BpmnKeyPerformanceIndicatorDashboardAPIApi();
            var authoritySearchExp = new (); //  | 
            var maxResultSize = new (); //  | 

            try
            {
                // Searches the report authorities.
                HvlResponseSetString result = apiInstance.searchAuthorities(authoritySearchExp, maxResultSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnKeyPerformanceIndicatorDashboardAPIApi.searchAuthorities: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnKeyPerformanceIndicatorDashboardAPIApi();
$authoritySearchExp = ; //  | 
$maxResultSize = ; //  | 

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

my $api_instance = WWW::SwaggerClient::BpmnKeyPerformanceIndicatorDashboardAPIApi->new();
my $authoritySearchExp = ; #  | 
my $maxResultSize = ; #  | 

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

try: 
    # Searches the report authorities.
    api_response = api_instance.search_authorities(authoritySearchExp, maxResultSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnKeyPerformanceIndicatorDashboardAPIApi->searchAuthorities: %s\n" % e)

Parameters

Query parameters
Name Description
authority-search-exp*
Required
max-result-size*
(int32)
Required

Responses

Status: 200 - OK


update5

Updates key performance indicator dashboard


/kpi/key-performance-indicator-dashboard

Usage and SDK Samples

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

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

public class BpmnKeyPerformanceIndicatorDashboardAPIApiExample {

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

public class BpmnKeyPerformanceIndicatorDashboardAPIApiExample {

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

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

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

var api = new HvlBpmnAdminServer.BpmnKeyPerformanceIndicatorDashboardAPIApi()
var body = ; // {{HvlBpmnKeyPerformanceIndicatorDashboardPersistModel}} 

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

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

            var apiInstance = new BpmnKeyPerformanceIndicatorDashboardAPIApi();
            var body = new HvlBpmnKeyPerformanceIndicatorDashboardPersistModel(); // HvlBpmnKeyPerformanceIndicatorDashboardPersistModel | 

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

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

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

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

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

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

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


BpmnKeyPerformanceIndicatorDashletAPI

calculateByUuid

Calculates key performance indicator by uuid.


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

Usage and SDK Samples

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

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

public class BpmnKeyPerformanceIndicatorDashletAPIApiExample {

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

public class BpmnKeyPerformanceIndicatorDashletAPIApiExample {

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

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

// Calculates key performance indicator by uuid.
[apiInstance calculateByUuidWith:uuid
              completionHandler: ^(HvlResponseHvlBpmnKeyPerformanceIndicatorResultModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnKeyPerformanceIndicatorDashletAPIApi()
var uuid = ; // {{}} 

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

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

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

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

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

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

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

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

try: 
    # Calculates key performance indicator by uuid.
    api_response = api_instance.calculate_by_uuid(uuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnKeyPerformanceIndicatorDashletAPIApi->calculateByUuid: %s\n" % e)

Parameters

Path parameters
Name Description
uuid*
Required

Responses

Status: 200 - OK


deleteByUuid2

Deletes key performance indicator dashlet by uuid


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

Usage and SDK Samples

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

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

public class BpmnKeyPerformanceIndicatorDashletAPIApiExample {

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

public class BpmnKeyPerformanceIndicatorDashletAPIApiExample {

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

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

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

var api = new HvlBpmnAdminServer.BpmnKeyPerformanceIndicatorDashletAPIApi()
var uuid = ; // {{}} 

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

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

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

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

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

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

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

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

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

Parameters

Path parameters
Name Description
uuid*
Required

Responses

Status: 200 - OK


getByUuid2

Gets key performance indicator dashlet by uuid


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

Usage and SDK Samples

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

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

public class BpmnKeyPerformanceIndicatorDashletAPIApiExample {

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

public class BpmnKeyPerformanceIndicatorDashletAPIApiExample {

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

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

// Gets key performance indicator dashlet by uuid
[apiInstance getByUuid2With:uuid
              completionHandler: ^(HvlResponseHvlBpmnKeyPerformanceIndicatorDashletModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnKeyPerformanceIndicatorDashletAPIApi()
var uuid = ; // {{}} 

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

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

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

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

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

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

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

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

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

Parameters

Path parameters
Name Description
uuid*
Required

Responses

Status: 200 - OK


queryList5

Queries key performance indicator dashlets according to criteria in query model


/kpi/key-performance-indicator-dashlet/list

Usage and SDK Samples

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

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

public class BpmnKeyPerformanceIndicatorDashletAPIApiExample {

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

public class BpmnKeyPerformanceIndicatorDashletAPIApiExample {

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

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

// Queries key performance indicator dashlets according to criteria in query model
[apiInstance queryList5With:body
              completionHandler: ^(HvlResponseListHvlBpmnKeyPerformanceIndicatorDashletModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnKeyPerformanceIndicatorDashletAPIApi()
var body = ; // {{HvlBpmnKeyPerformanceIndicatorDashletQueryModel}} 

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

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

            var apiInstance = new BpmnKeyPerformanceIndicatorDashletAPIApi();
            var body = new HvlBpmnKeyPerformanceIndicatorDashletQueryModel(); // HvlBpmnKeyPerformanceIndicatorDashletQueryModel | 

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

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

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

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

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

try: 
    # Queries key performance indicator dashlets according to criteria in query model
    api_response = api_instance.query_list5(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnKeyPerformanceIndicatorDashletAPIApi->queryList5: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


queryPage5

Queries key performance indicator dashlets as paginated according to criteria in query model


/kpi/key-performance-indicator-dashlet/page

Usage and SDK Samples

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

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

public class BpmnKeyPerformanceIndicatorDashletAPIApiExample {

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

public class BpmnKeyPerformanceIndicatorDashletAPIApiExample {

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

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

// Queries key performance indicator dashlets as paginated according to criteria in query model
[apiInstance queryPage5With:body
              completionHandler: ^(HvlResponseHvlPageHvlBpmnKeyPerformanceIndicatorDashletModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnKeyPerformanceIndicatorDashletAPIApi()
var body = ; // {{HvlBpmnKeyPerformanceIndicatorDashletQueryModel}} 

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

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

            var apiInstance = new BpmnKeyPerformanceIndicatorDashletAPIApi();
            var body = new HvlBpmnKeyPerformanceIndicatorDashletQueryModel(); // HvlBpmnKeyPerformanceIndicatorDashletQueryModel | 

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

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

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

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

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

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

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


save2

Saves key performance indicator dashlet


/kpi/key-performance-indicator-dashlet

Usage and SDK Samples

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

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

public class BpmnKeyPerformanceIndicatorDashletAPIApiExample {

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

public class BpmnKeyPerformanceIndicatorDashletAPIApiExample {

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

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

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

var api = new HvlBpmnAdminServer.BpmnKeyPerformanceIndicatorDashletAPIApi()
var body = ; // {{HvlBpmnKeyPerformanceIndicatorDashletPersistModel}} 

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

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

            var apiInstance = new BpmnKeyPerformanceIndicatorDashletAPIApi();
            var body = new HvlBpmnKeyPerformanceIndicatorDashletPersistModel(); // HvlBpmnKeyPerformanceIndicatorDashletPersistModel | 

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

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

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

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

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

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

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


update3

Updates key performance indicator dashlet


/kpi/key-performance-indicator-dashlet

Usage and SDK Samples

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

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

public class BpmnKeyPerformanceIndicatorDashletAPIApiExample {

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

public class BpmnKeyPerformanceIndicatorDashletAPIApiExample {

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

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

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

var api = new HvlBpmnAdminServer.BpmnKeyPerformanceIndicatorDashletAPIApi()
var body = ; // {{HvlBpmnKeyPerformanceIndicatorDashletPersistModel}} 

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

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

            var apiInstance = new BpmnKeyPerformanceIndicatorDashletAPIApi();
            var body = new HvlBpmnKeyPerformanceIndicatorDashletPersistModel(); // HvlBpmnKeyPerformanceIndicatorDashletPersistModel | 

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

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

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

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

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

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

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


BpmnKeyPerformanceIndicatorDashletTargetAPI

queryList6

Queries key performance indicator dashlet targets according to criteria in query model


/kpi/key-performance-indicator-dashlet-target/list

Usage and SDK Samples

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

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

public class BpmnKeyPerformanceIndicatorDashletTargetAPIApiExample {

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

public class BpmnKeyPerformanceIndicatorDashletTargetAPIApiExample {

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

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

// Queries key performance indicator dashlet targets according to criteria in query model
[apiInstance queryList6With:body
              completionHandler: ^(HvlResponseListHvlBpmnKeyPerformanceIndicatorDashletTargetModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnKeyPerformanceIndicatorDashletTargetAPIApi()
var body = ; // {{HvlBpmnKeyPerformanceIndicatorDashletTargetQueryModel}} 

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

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

            var apiInstance = new BpmnKeyPerformanceIndicatorDashletTargetAPIApi();
            var body = new HvlBpmnKeyPerformanceIndicatorDashletTargetQueryModel(); // HvlBpmnKeyPerformanceIndicatorDashletTargetQueryModel | 

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

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

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

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

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

try: 
    # Queries key performance indicator dashlet targets according to criteria in query model
    api_response = api_instance.query_list6(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnKeyPerformanceIndicatorDashletTargetAPIApi->queryList6: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


update4

Updates key performance indicator dashlet target


/kpi/key-performance-indicator-dashlet-target

Usage and SDK Samples

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

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

public class BpmnKeyPerformanceIndicatorDashletTargetAPIApiExample {

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

public class BpmnKeyPerformanceIndicatorDashletTargetAPIApiExample {

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

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

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

var api = new HvlBpmnAdminServer.BpmnKeyPerformanceIndicatorDashletTargetAPIApi()
var body = ; // {{HvlBpmnKeyPerformanceIndicatorDashletTargetPersistModel}} 

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

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

            var apiInstance = new BpmnKeyPerformanceIndicatorDashletTargetAPIApi();
            var body = new HvlBpmnKeyPerformanceIndicatorDashletTargetPersistModel(); // HvlBpmnKeyPerformanceIndicatorDashletTargetPersistModel | 

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

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

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

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

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

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

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


BpmnProcessAPI

delete1

Removes object according to provided parameter


/process/delete/{id}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"/gw/bpmn-admin-server/process/delete/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessAPIApi;

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

public class BpmnProcessAPIApiExample {

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

public class BpmnProcessAPIApiExample {

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

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

// Removes object according to provided parameter
[apiInstance delete1With:id
              completionHandler: ^(HvlResponseVoid output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessAPIApi()
var id = ; // {{}} 

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

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

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

            try
            {
                // Removes object according to provided parameter
                HvlResponseVoid result = apiInstance.delete1(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessAPIApi.delete1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

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

try: 
    # Removes object according to provided parameter
    api_response = api_instance.delete1(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnProcessAPIApi->delete1: %s\n" % e)

Parameters

Path parameters
Name Description
id*
(int64)
Required

Responses

Status: 200 - OK


deployProcess

Deploy process


/process/deploy/{processId}

Usage and SDK Samples

curl -X PUT\
-H "Accept: */*"\
"/gw/bpmn-admin-server/process/deploy/{processId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessAPIApi;

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

public class BpmnProcessAPIApiExample {

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

public class BpmnProcessAPIApiExample {

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

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

// Deploy process
[apiInstance deployProcessWith:processId
              completionHandler: ^(HvlResponseVoid output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessAPIApi()
var processId = ; // {{}} 

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

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

            var apiInstance = new BpmnProcessAPIApi();
            var processId = new (); //  | 

            try
            {
                // Deploy process
                HvlResponseVoid result = apiInstance.deployProcess(processId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessAPIApi.deployProcess: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnProcessAPIApi();
$processId = ; //  | 

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

my $api_instance = WWW::SwaggerClient::BpmnProcessAPIApi->new();
my $processId = ; #  | 

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

try: 
    # Deploy process
    api_response = api_instance.deploy_process(processId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnProcessAPIApi->deployProcess: %s\n" % e)

Parameters

Path parameters
Name Description
processId*
(int64)
Required

Responses

Status: 200 - OK


exportAll

Exports all processes as zip file


/process/export/all

Usage and SDK Samples

curl -X POST\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"/gw/bpmn-admin-server/process/export/all"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessAPIApi;

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

public class BpmnProcessAPIApiExample {

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

public class BpmnProcessAPIApiExample {

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

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

// Exports all processes as zip file
[apiInstance exportAllWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessAPIApi()
var body = ; // {{}} 

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

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

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

            try
            {
                // Exports all processes as zip file
                apiInstance.exportAll(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessAPIApi.exportAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

eval { 
    $api_instance->exportAll(body => $body);
};
if ($@) {
    warn "Exception when calling BpmnProcessAPIApi->exportAll: $@\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.BpmnProcessAPIApi()
body =  #  | 

try: 
    # Exports all processes as zip file
    api_instance.export_all(body)
except ApiException as e:
    print("Exception when calling BpmnProcessAPIApi->exportAll: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


exportProcess

Exports process as bpmn xml


/process/export/{processId}

Usage and SDK Samples

curl -X GET\
-H "Accept: */*"\
"/gw/bpmn-admin-server/process/export/{processId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessAPIApi;

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

public class BpmnProcessAPIApiExample {

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

public class BpmnProcessAPIApiExample {

    public static void main(String[] args) {
        BpmnProcessAPIApi apiInstance = new BpmnProcessAPIApi();
         processId = ; //  | 
        try {
            apiInstance.exportProcess(processId);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnProcessAPIApi#exportProcess");
            e.printStackTrace();
        }
    }
}
 *processId = ; // 

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

// Exports process as bpmn xml
[apiInstance exportProcessWith:processId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessAPIApi()
var processId = ; // {{}} 

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

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

            var apiInstance = new BpmnProcessAPIApi();
            var processId = new (); //  | 

            try
            {
                // Exports process as bpmn xml
                apiInstance.exportProcess(processId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessAPIApi.exportProcess: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnProcessAPIApi();
$processId = ; //  | 

try {
    $api_instance->exportProcess($processId);
} catch (Exception $e) {
    echo 'Exception when calling BpmnProcessAPIApi->exportProcess: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BpmnProcessAPIApi;

my $api_instance = WWW::SwaggerClient::BpmnProcessAPIApi->new();
my $processId = ; #  | 

eval { 
    $api_instance->exportProcess(processId => $processId);
};
if ($@) {
    warn "Exception when calling BpmnProcessAPIApi->exportProcess: $@\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.BpmnProcessAPIApi()
processId =  #  | 

try: 
    # Exports process as bpmn xml
    api_instance.export_process(processId)
except ApiException as e:
    print("Exception when calling BpmnProcessAPIApi->exportProcess: %s\n" % e)

Parameters

Path parameters
Name Description
processId*
(int64)
Required

Responses

Status: 200 - OK


getCurrentVersion

Gets current version of process


/process/version/current/{processCode}

Usage and SDK Samples

curl -X GET\
-H "Accept: */*"\
"/gw/bpmn-admin-server/process/version/current/{processCode}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessAPIApi;

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

public class BpmnProcessAPIApiExample {

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

public class BpmnProcessAPIApiExample {

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

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

// Gets current version of process
[apiInstance getCurrentVersionWith:processCode
              completionHandler: ^(HvlResponseLong output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessAPIApi()
var processCode = ; // {{}} 

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

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

            var apiInstance = new BpmnProcessAPIApi();
            var processCode = new (); //  | 

            try
            {
                // Gets current version of process
                HvlResponseLong result = apiInstance.getCurrentVersion(processCode);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessAPIApi.getCurrentVersion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnProcessAPIApi();
$processCode = ; //  | 

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

my $api_instance = WWW::SwaggerClient::BpmnProcessAPIApi->new();
my $processCode = ; #  | 

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

try: 
    # Gets current version of process
    api_response = api_instance.get_current_version(processCode)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnProcessAPIApi->getCurrentVersion: %s\n" % e)

Parameters

Path parameters
Name Description
processCode*
Required

Responses

Status: 200 - OK


getNamespaceList

Gets namespace list


/process/namespaces

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"/gw/bpmn-admin-server/process/namespaces"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessAPIApi;

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

public class BpmnProcessAPIApiExample {

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

public class BpmnProcessAPIApiExample {

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

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

// Gets namespace list
[apiInstance getNamespaceListWithCompletionHandler: 
              ^(HvlResponseListString output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

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

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

            var apiInstance = new BpmnProcessAPIApi();

            try
            {
                // Gets namespace list
                HvlResponseListString result = apiInstance.getNamespaceList();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessAPIApi.getNamespaceList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

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

try: 
    # Gets namespace list
    api_response = api_instance.get_namespace_list()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnProcessAPIApi->getNamespaceList: %s\n" % e)

Parameters

Responses

Status: 200 - OK


getProcessById

Gets process by id


/process/{id}

Usage and SDK Samples

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

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

public class BpmnProcessAPIApiExample {

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

public class BpmnProcessAPIApiExample {

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

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

// Gets process by id
[apiInstance getProcessByIdWith:id
              completionHandler: ^(HvlResponseHvlBpmnProcessModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessAPIApi()
var id = ; // {{}} 

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

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

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

            try
            {
                // Gets process by id
                HvlResponseHvlBpmnProcessModel result = apiInstance.getProcessById(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessAPIApi.getProcessById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

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

try: 
    # Gets process by id
    api_response = api_instance.get_process_by_id(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnProcessAPIApi->getProcessById: %s\n" % e)

Parameters

Path parameters
Name Description
id*
(int64)
Required

Responses

Status: 200 - OK


getProcessByVersion

Gets process by version


/process/version/process/code/{processCode}/version/{processVersion}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"/gw/bpmn-admin-server/process/version/process/code/{processCode}/version/{processVersion}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessAPIApi;

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

public class BpmnProcessAPIApiExample {

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

public class BpmnProcessAPIApiExample {

    public static void main(String[] args) {
        BpmnProcessAPIApi apiInstance = new BpmnProcessAPIApi();
         processCode = ; //  | 
         processVersion = ; //  | 
        try {
            HvlResponseHvlBpmnProcessModel result = apiInstance.getProcessByVersion(processCode, processVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnProcessAPIApi#getProcessByVersion");
            e.printStackTrace();
        }
    }
}
 *processCode = ; // 
 *processVersion = ; // 

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

// Gets process by version
[apiInstance getProcessByVersionWith:processCode
    processVersion:processVersion
              completionHandler: ^(HvlResponseHvlBpmnProcessModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessAPIApi()
var processCode = ; // {{}} 
var processVersion = ; // {{}} 

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

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

            var apiInstance = new BpmnProcessAPIApi();
            var processCode = new (); //  | 
            var processVersion = new (); //  | 

            try
            {
                // Gets process by version
                HvlResponseHvlBpmnProcessModel result = apiInstance.getProcessByVersion(processCode, processVersion);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessAPIApi.getProcessByVersion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnProcessAPIApi();
$processCode = ; //  | 
$processVersion = ; //  | 

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

my $api_instance = WWW::SwaggerClient::BpmnProcessAPIApi->new();
my $processCode = ; #  | 
my $processVersion = ; #  | 

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

try: 
    # Gets process by version
    api_response = api_instance.get_process_by_version(processCode, processVersion)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnProcessAPIApi->getProcessByVersion: %s\n" % e)

Parameters

Path parameters
Name Description
processCode*
Required
processVersion*
(int64)
Required

Responses

Status: 200 - OK


getProcessModelNode

Gets process model node


/process/model/{modelId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"/gw/bpmn-admin-server/process/model/{modelId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessAPIApi;

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

public class BpmnProcessAPIApiExample {

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

public class BpmnProcessAPIApiExample {

    public static void main(String[] args) {
        BpmnProcessAPIApi apiInstance = new BpmnProcessAPIApi();
         modelId = ; //  | 
        try {
            apiInstance.getProcessModelNode(modelId);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnProcessAPIApi#getProcessModelNode");
            e.printStackTrace();
        }
    }
}
 *modelId = ; // 

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

// Gets process model node
[apiInstance getProcessModelNodeWith:modelId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessAPIApi()
var modelId = ; // {{}} 

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

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

            var apiInstance = new BpmnProcessAPIApi();
            var modelId = new (); //  | 

            try
            {
                // Gets process model node
                apiInstance.getProcessModelNode(modelId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessAPIApi.getProcessModelNode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnProcessAPIApi();
$modelId = ; //  | 

try {
    $api_instance->getProcessModelNode($modelId);
} catch (Exception $e) {
    echo 'Exception when calling BpmnProcessAPIApi->getProcessModelNode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BpmnProcessAPIApi;

my $api_instance = WWW::SwaggerClient::BpmnProcessAPIApi->new();
my $modelId = ; #  | 

eval { 
    $api_instance->getProcessModelNode(modelId => $modelId);
};
if ($@) {
    warn "Exception when calling BpmnProcessAPIApi->getProcessModelNode: $@\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.BpmnProcessAPIApi()
modelId =  #  | 

try: 
    # Gets process model node
    api_instance.get_process_model_node(modelId)
except ApiException as e:
    print("Exception when calling BpmnProcessAPIApi->getProcessModelNode: %s\n" % e)

Parameters

Path parameters
Name Description
modelId*
(int64)
Required

Responses

Status: 200 - OK


getProcessVersionList

Gets process version list


/process/version/list/process/code/{processCode}

Usage and SDK Samples

curl -X GET\
-H "Accept: */*"\
"/gw/bpmn-admin-server/process/version/list/process/code/{processCode}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessAPIApi;

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

public class BpmnProcessAPIApiExample {

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

public class BpmnProcessAPIApiExample {

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

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

// Gets process version list
[apiInstance getProcessVersionListWith:processCode
              completionHandler: ^(HvlResponseListLong output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessAPIApi()
var processCode = ; // {{}} 

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

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

            var apiInstance = new BpmnProcessAPIApi();
            var processCode = new (); //  | 

            try
            {
                // Gets process version list
                HvlResponseListLong result = apiInstance.getProcessVersionList(processCode);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessAPIApi.getProcessVersionList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnProcessAPIApi();
$processCode = ; //  | 

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

my $api_instance = WWW::SwaggerClient::BpmnProcessAPIApi->new();
my $processCode = ; #  | 

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

try: 
    # Gets process version list
    api_response = api_instance.get_process_version_list(processCode)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnProcessAPIApi->getProcessVersionList: %s\n" % e)

Parameters

Path parameters
Name Description
processCode*
Required

Responses

Status: 200 - OK


importAll

Imports all bpmn xml files from a zip file


/process/import/all

Usage and SDK Samples

curl -X POST\
-H "Accept: */*"\
-H "Content-Type: multipart/form-data"\
"/gw/bpmn-admin-server/process/import/all"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessAPIApi;

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

public class BpmnProcessAPIApiExample {

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

public class BpmnProcessAPIApiExample {

    public static void main(String[] args) {
        BpmnProcessAPIApi apiInstance = new BpmnProcessAPIApi();
         zipFile = ; //  | 
        try {
            HvlResponseListHvlBpmnProcessModel result = apiInstance.importAll(zipFile);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnProcessAPIApi#importAll");
            e.printStackTrace();
        }
    }
}
 *zipFile = ; //  (optional)

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

// Imports all bpmn xml files from a zip file
[apiInstance importAllWith:zipFile
              completionHandler: ^(HvlResponseListHvlBpmnProcessModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessAPIApi()
var opts = { 
  'zipFile':  // {{}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.importAll(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnProcessAPIApi();
            var zipFile = new (); //  |  (optional) 

            try
            {
                // Imports all bpmn xml files from a zip file
                HvlResponseListHvlBpmnProcessModel result = apiInstance.importAll(zipFile);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessAPIApi.importAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnProcessAPIApi();
$zipFile = ; //  | 

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

my $api_instance = WWW::SwaggerClient::BpmnProcessAPIApi->new();
my $zipFile = ; #  | 

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

try: 
    # Imports all bpmn xml files from a zip file
    api_response = api_instance.import_all(zipFile=zipFile)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnProcessAPIApi->importAll: %s\n" % e)

Parameters

Form parameters
Name Description
zipFile
(binary)

Responses

Status: 200 - OK


importProcess

Imports a bpmn xml


/process/import

Usage and SDK Samples

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

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

public class BpmnProcessAPIApiExample {

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

public class BpmnProcessAPIApiExample {

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

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

// Imports a bpmn xml
[apiInstance importProcessWith:xmlFile
              completionHandler: ^(HvlResponseHvlProcessDefinitionImportResultModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

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

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

            var apiInstance = new BpmnProcessAPIApi();
            var xmlFile = new (); //  |  (optional) 

            try
            {
                // Imports a bpmn xml
                HvlResponseHvlProcessDefinitionImportResultModel result = apiInstance.importProcess(xmlFile);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessAPIApi.importProcess: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

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

try: 
    # Imports a bpmn xml
    api_response = api_instance.import_process(xmlFile=xmlFile)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnProcessAPIApi->importProcess: %s\n" % e)

Parameters

Form parameters
Name Description
xmlFile
(binary)

Responses

Status: 200 - OK


isLocked

Check the process is locked


/process/lock/getLock/process/{id}

Usage and SDK Samples

curl -X GET\
-H "Accept: */*"\
"/gw/bpmn-admin-server/process/lock/getLock/process/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessAPIApi;

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

public class BpmnProcessAPIApiExample {

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

public class BpmnProcessAPIApiExample {

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

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

// Check the process is locked
[apiInstance isLockedWith:id
              completionHandler: ^(HvlResponseBoolean output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessAPIApi()
var id = ; // {{}} 

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

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

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

            try
            {
                // Check the process is locked
                HvlResponseBoolean result = apiInstance.isLocked(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessAPIApi.isLocked: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

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

try: 
    # Check the process is locked
    api_response = api_instance.is_locked(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnProcessAPIApi->isLocked: %s\n" % e)

Parameters

Path parameters
Name Description
id*
(int64)
Required

Responses

Status: 200 - OK


lock

Lock the process


/process/lock/process/{id}

Usage and SDK Samples

curl -X PUT\
-H "Accept: */*"\
"/gw/bpmn-admin-server/process/lock/process/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessAPIApi;

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

public class BpmnProcessAPIApiExample {

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

public class BpmnProcessAPIApiExample {

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

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

// Lock the process
[apiInstance lockWith:id
              completionHandler: ^(HvlResponseVoid output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessAPIApi()
var id = ; // {{}} 

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

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

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

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

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

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

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

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

try: 
    # Lock the process
    api_response = api_instance.lock(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnProcessAPIApi->lock: %s\n" % e)

Parameters

Path parameters
Name Description
id*
(int64)
Required

Responses

Status: 200 - OK


migrateProcessesFromFlowable

Migrates deployed flowable processes to BPMN application.


/process/migrate

Usage and SDK Samples

curl -X PUT\
-H "Accept: */*"\
"/gw/bpmn-admin-server/process/migrate"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessAPIApi;

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

public class BpmnProcessAPIApiExample {

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

public class BpmnProcessAPIApiExample {

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

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

// Migrates deployed flowable processes to BPMN application.
[apiInstance migrateProcessesFromFlowableWithCompletionHandler: 
              ^(HvlResponseVoid output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

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

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

            var apiInstance = new BpmnProcessAPIApi();

            try
            {
                // Migrates deployed flowable processes to BPMN application.
                HvlResponseVoid result = apiInstance.migrateProcessesFromFlowable();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessAPIApi.migrateProcessesFromFlowable: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

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

try: 
    # Migrates deployed flowable processes to BPMN application.
    api_response = api_instance.migrate_processes_from_flowable()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnProcessAPIApi->migrateProcessesFromFlowable: %s\n" % e)

Parameters

Responses

Status: 200 - OK


queryCategoryList

Queries categories according to namespace


/process/list-category/by-name/{namespace}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"/gw/bpmn-admin-server/process/list-category/by-name/{namespace}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessAPIApi;

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

public class BpmnProcessAPIApiExample {

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

public class BpmnProcessAPIApiExample {

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

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

// Queries categories according to namespace
[apiInstance queryCategoryListWith:namespace
              completionHandler: ^(HvlResponseListString output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessAPIApi()
var namespace = ; // {{}} 

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

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

            var apiInstance = new BpmnProcessAPIApi();
            var namespace = new (); //  | 

            try
            {
                // Queries categories according to namespace
                HvlResponseListString result = apiInstance.queryCategoryList(namespace);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessAPIApi.queryCategoryList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnProcessAPIApi();
$namespace = ; //  | 

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

my $api_instance = WWW::SwaggerClient::BpmnProcessAPIApi->new();
my $namespace = ; #  | 

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

try: 
    # Queries categories according to namespace
    api_response = api_instance.query_category_list(namespace)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnProcessAPIApi->queryCategoryList: %s\n" % e)

Parameters

Path parameters
Name Description
namespace*
Required

Responses

Status: 200 - OK


queryList1

Queries processes according to criteria in query model


/process/list

Usage and SDK Samples

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

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

public class BpmnProcessAPIApiExample {

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

public class BpmnProcessAPIApiExample {

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

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

// Queries processes according to criteria in query model
[apiInstance queryList1With:body
              completionHandler: ^(HvlResponseListHvlBpmnProcessModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessAPIApi()
var body = ; // {{HvlBpmnProcessQueryModel}} 

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 BpmnProcessAPIApi();
            var body = new HvlBpmnProcessQueryModel(); // HvlBpmnProcessQueryModel | 

            try
            {
                // Queries processes according to criteria in query model
                HvlResponseListHvlBpmnProcessModel result = apiInstance.queryList1(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessAPIApi.queryList1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

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

try: 
    # Queries processes according to criteria in query model
    api_response = api_instance.query_list1(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnProcessAPIApi->queryList1: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


queryPage1

Queries processes as paginated according to criteria in query model


/process/page

Usage and SDK Samples

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

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

public class BpmnProcessAPIApiExample {

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

public class BpmnProcessAPIApiExample {

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

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

// Queries processes as paginated according to criteria in query model
[apiInstance queryPage1With:body
              completionHandler: ^(HvlResponseHvlPageHvlBpmnProcessModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessAPIApi()
var body = ; // {{HvlBpmnProcessQueryModel}} 

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 BpmnProcessAPIApi();
            var body = new HvlBpmnProcessQueryModel(); // HvlBpmnProcessQueryModel | 

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

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

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

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

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

try: 
    # Queries processes as paginated according to criteria in query model
    api_response = api_instance.query_page1(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnProcessAPIApi->queryPage1: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


save4

Adds provided object


/process/save

Usage and SDK Samples

curl -X POST\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"/gw/bpmn-admin-server/process/save?sourceProcessId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessAPIApi;

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

public class BpmnProcessAPIApiExample {

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

public class BpmnProcessAPIApiExample {

    public static void main(String[] args) {
        BpmnProcessAPIApi apiInstance = new BpmnProcessAPIApi();
        HvlBpmnProcessModel body = ; // HvlBpmnProcessModel | 
         sourceProcessId = ; //  | 
        try {
            HvlResponseLong result = apiInstance.save4(body, sourceProcessId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnProcessAPIApi#save4");
            e.printStackTrace();
        }
    }
}
HvlBpmnProcessModel *body = ; // 
 *sourceProcessId = ; //  (optional)

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

// Adds provided object
[apiInstance save4With:body
    sourceProcessId:sourceProcessId
              completionHandler: ^(HvlResponseLong output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessAPIApi()
var body = ; // {{HvlBpmnProcessModel}} 
var opts = { 
  'sourceProcessId':  // {{}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.save4(body, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnProcessAPIApi();
            var body = new HvlBpmnProcessModel(); // HvlBpmnProcessModel | 
            var sourceProcessId = new (); //  |  (optional) 

            try
            {
                // Adds provided object
                HvlResponseLong result = apiInstance.save4(body, sourceProcessId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessAPIApi.save4: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnProcessAPIApi();
$body = ; // HvlBpmnProcessModel | 
$sourceProcessId = ; //  | 

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

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

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

try: 
    # Adds provided object
    api_response = api_instance.save4(body, sourceProcessId=sourceProcessId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnProcessAPIApi->save4: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
sourceProcessId
(int64)

Responses

Status: 200 - OK


saveProcessModelNode

Saves process model node


/process/model/{modelId}

Usage and SDK Samples

curl -X POST\
-H "Accept: */*"\
-H "Content-Type: application/x-www-form-urlencoded"\
"/gw/bpmn-admin-server/process/model/{modelId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessAPIApi;

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

public class BpmnProcessAPIApiExample {

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

public class BpmnProcessAPIApiExample {

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

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

// Saves process model node
[apiInstance saveProcessModelNodeWith:all
    empty:empty
    modelId:modelId
              completionHandler: ^(HvlResponseVoid output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessAPIApi()
var all = ; // {{}} 
var empty = ; // {{}} 
var modelId = ; // {{}} 

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

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

            var apiInstance = new BpmnProcessAPIApi();
            var all = new (); //  | 
            var empty = new (); //  | 
            var modelId = new (); //  | 

            try
            {
                // Saves process model node
                HvlResponseVoid result = apiInstance.saveProcessModelNode(all, empty, modelId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessAPIApi.saveProcessModelNode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnProcessAPIApi();
$all = ; //  | 
$empty = ; //  | 
$modelId = ; //  | 

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

my $api_instance = WWW::SwaggerClient::BpmnProcessAPIApi->new();
my $all = ; #  | 
my $empty = ; #  | 
my $modelId = ; #  | 

eval { 
    my $result = $api_instance->saveProcessModelNode(all => $all, empty => $empty, modelId => $modelId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnProcessAPIApi->saveProcessModelNode: $@\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.BpmnProcessAPIApi()
all =  #  | 
empty =  #  | 
modelId =  #  | 

try: 
    # Saves process model node
    api_response = api_instance.save_process_model_node(all, empty, modelId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnProcessAPIApi->saveProcessModelNode: %s\n" % e)

Parameters

Path parameters
Name Description
modelId*
(int64)
Required
Form parameters
Name Description
all*
Required
empty*
Required

Responses

Status: 200 - OK


unlock

Unlock the process


/process/lock/unlock/process/{id}

Usage and SDK Samples

curl -X PUT\
-H "Accept: */*"\
"/gw/bpmn-admin-server/process/lock/unlock/process/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessAPIApi;

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

public class BpmnProcessAPIApiExample {

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

public class BpmnProcessAPIApiExample {

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

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

// Unlock the process
[apiInstance unlockWith:id
              completionHandler: ^(HvlResponseVoid output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessAPIApi()
var id = ; // {{}} 

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

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

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

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

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

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

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

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

try: 
    # Unlock the process
    api_response = api_instance.unlock(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnProcessAPIApi->unlock: %s\n" % e)

Parameters

Path parameters
Name Description
id*
(int64)
Required

Responses

Status: 200 - OK


update

Edits object associated provided object


/process/update

Usage and SDK Samples

curl -X PUT\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"/gw/bpmn-admin-server/process/update?newVersion="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessAPIApi;

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

public class BpmnProcessAPIApiExample {

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

public class BpmnProcessAPIApiExample {

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

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

// Edits object associated provided object
[apiInstance updateWith:body
    newVersion:newVersion
              completionHandler: ^(HvlResponseLong output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessAPIApi()
var body = ; // {{HvlBpmnProcessModel}} 
var newVersion = ; // {{}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.update(bodynewVersion, 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 BpmnProcessAPIApi();
            var body = new HvlBpmnProcessModel(); // HvlBpmnProcessModel | 
            var newVersion = new (); //  | 

            try
            {
                // Edits object associated provided object
                HvlResponseLong result = apiInstance.update(body, newVersion);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessAPIApi.update: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnProcessAPIApi();
$body = ; // HvlBpmnProcessModel | 
$newVersion = ; //  | 

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

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

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

try: 
    # Edits object associated provided object
    api_response = api_instance.update(body, newVersion)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnProcessAPIApi->update: %s\n" % e)

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
newVersion*
Required

Responses

Status: 200 - OK


upgradeVersion

Upgrade existing process definition


/process/upgrade-version/{processDefinitionKey}

Usage and SDK Samples

curl -X PUT\
-H "Accept: */*"\
-H "Content-Type: multipart/form-data"\
"/gw/bpmn-admin-server/process/upgrade-version/{processDefinitionKey}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessAPIApi;

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

public class BpmnProcessAPIApiExample {

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

public class BpmnProcessAPIApiExample {

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

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

// Upgrade existing process definition
[apiInstance upgradeVersionWith:processDefinitionKey
    upgradedProcessDefinitionXmlFile:upgradedProcessDefinitionXmlFile
              completionHandler: ^(HvlResponseVoid output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessAPIApi()
var processDefinitionKey = ; // {{}} 
var opts = { 
  'upgradedProcessDefinitionXmlFile':  // {{}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.upgradeVersion(processDefinitionKey, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnProcessAPIApi();
            var processDefinitionKey = new (); //  | 
            var upgradedProcessDefinitionXmlFile = new (); //  |  (optional) 

            try
            {
                // Upgrade existing process definition
                HvlResponseVoid result = apiInstance.upgradeVersion(processDefinitionKey, upgradedProcessDefinitionXmlFile);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessAPIApi.upgradeVersion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnProcessAPIApi();
$processDefinitionKey = ; //  | 
$upgradedProcessDefinitionXmlFile = ; //  | 

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

my $api_instance = WWW::SwaggerClient::BpmnProcessAPIApi->new();
my $processDefinitionKey = ; #  | 
my $upgradedProcessDefinitionXmlFile = ; #  | 

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

try: 
    # Upgrade existing process definition
    api_response = api_instance.upgrade_version(processDefinitionKey, upgradedProcessDefinitionXmlFile=upgradedProcessDefinitionXmlFile)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnProcessAPIApi->upgradeVersion: %s\n" % e)

Parameters

Path parameters
Name Description
processDefinitionKey*
Required
Form parameters
Name Description
upgradedProcessDefinitionXmlFile
(binary)

Responses

Status: 200 - OK


BpmnProcessCommentAPI

deleteByUuid

Deletes process comment by uuid


/process/comments/{uuid}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"/gw/bpmn-admin-server/process/comments/{uuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessCommentAPIApi;

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

public class BpmnProcessCommentAPIApiExample {

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

public class BpmnProcessCommentAPIApiExample {

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

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

// Deletes process comment by uuid
[apiInstance deleteByUuidWith:uuid
              completionHandler: ^(HvlResponseVoid output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessCommentAPIApi()
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 BpmnProcessCommentAPIApi();
            var uuid = new (); //  | 

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

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

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

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

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

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

Parameters

Path parameters
Name Description
uuid*
Required

Responses

Status: 200 - OK


getByUuid

Gets process comment by uuid


/process/comments/{uuid}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"/gw/bpmn-admin-server/process/comments/{uuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessCommentAPIApi;

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

public class BpmnProcessCommentAPIApiExample {

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

public class BpmnProcessCommentAPIApiExample {

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

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

// Gets process comment by uuid
[apiInstance getByUuidWith:uuid
              completionHandler: ^(HvlResponseHvlBpmnProcessCommentModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessCommentAPIApi()
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 BpmnProcessCommentAPIApi();
            var uuid = new (); //  | 

            try
            {
                // Gets process comment by uuid
                HvlResponseHvlBpmnProcessCommentModel result = apiInstance.getByUuid(uuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessCommentAPIApi.getByUuid: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

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

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

Parameters

Path parameters
Name Description
uuid*
Required

Responses

Status: 200 - OK


queryList3

Queries process comments according to criteria in query model


/process/comments/list

Usage and SDK Samples

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

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

public class BpmnProcessCommentAPIApiExample {

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

public class BpmnProcessCommentAPIApiExample {

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

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

// Queries process comments according to criteria in query model
[apiInstance queryList3With:body
              completionHandler: ^(HvlResponseListHvlBpmnProcessCommentModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessCommentAPIApi()
var body = ; // {{HvlBpmnProcessCommentQueryModel}} 

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 BpmnProcessCommentAPIApi();
            var body = new HvlBpmnProcessCommentQueryModel(); // HvlBpmnProcessCommentQueryModel | 

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

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

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

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

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

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

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


queryPage3

Queries process comments as paginated according to criteria in query model


/process/comments/page

Usage and SDK Samples

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

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

public class BpmnProcessCommentAPIApiExample {

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

public class BpmnProcessCommentAPIApiExample {

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

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

// Queries process comments as paginated according to criteria in query model
[apiInstance queryPage3With:body
              completionHandler: ^(HvlResponseHvlPageHvlBpmnProcessCommentModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessCommentAPIApi()
var body = ; // {{HvlBpmnProcessCommentQueryModel}} 

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 BpmnProcessCommentAPIApi();
            var body = new HvlBpmnProcessCommentQueryModel(); // HvlBpmnProcessCommentQueryModel | 

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

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

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

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

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

try: 
    # Queries process comments 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 BpmnProcessCommentAPIApi->queryPage3: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


save

Saves process comment


/process/comments

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/gw/bpmn-admin-server/process/comments"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessCommentAPIApi;

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

public class BpmnProcessCommentAPIApiExample {

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

public class BpmnProcessCommentAPIApiExample {

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

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

// Saves process comment
[apiInstance saveWith:body
              completionHandler: ^(HvlResponseVoid output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessCommentAPIApi()
var body = ; // {{HvlBpmnProcessCommentModel}} 

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 BpmnProcessCommentAPIApi();
            var body = new HvlBpmnProcessCommentModel(); // HvlBpmnProcessCommentModel | 

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

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

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

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

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

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

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


update1

Updates process comment


/process/comments

Usage and SDK Samples

curl -X PUT\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/gw/bpmn-admin-server/process/comments"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessCommentAPIApi;

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

public class BpmnProcessCommentAPIApiExample {

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

public class BpmnProcessCommentAPIApiExample {

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

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

// Updates process comment
[apiInstance update1With:body
              completionHandler: ^(HvlResponseVoid output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessCommentAPIApi()
var body = ; // {{HvlBpmnProcessCommentModel}} 

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

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

            var apiInstance = new BpmnProcessCommentAPIApi();
            var body = new HvlBpmnProcessCommentModel(); // HvlBpmnProcessCommentModel | 

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

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

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

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

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

try: 
    # Updates process comment
    api_response = api_instance.update1(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnProcessCommentAPIApi->update1: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


BpmnProcessDocumentationAPI

generateDocumentation

Generates process documentation


/process/doc/generate-documentation/{processId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"/gw/bpmn-admin-server/process/doc/generate-documentation/{processId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessDocumentationAPIApi;

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

public class BpmnProcessDocumentationAPIApiExample {

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

public class BpmnProcessDocumentationAPIApiExample {

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

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

// Generates process documentation
[apiInstance generateDocumentationWith:processId
              completionHandler: ^(HvlResponseString output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessDocumentationAPIApi()
var processId = ; // {{}} 

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

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

            var apiInstance = new BpmnProcessDocumentationAPIApi();
            var processId = new (); //  | 

            try
            {
                // Generates process documentation
                HvlResponseString result = apiInstance.generateDocumentation(processId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessDocumentationAPIApi.generateDocumentation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnProcessDocumentationAPIApi();
$processId = ; //  | 

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

my $api_instance = WWW::SwaggerClient::BpmnProcessDocumentationAPIApi->new();
my $processId = ; #  | 

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

try: 
    # Generates process documentation
    api_response = api_instance.generate_documentation(processId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnProcessDocumentationAPIApi->generateDocumentation: %s\n" % e)

Parameters

Path parameters
Name Description
processId*
(int64)
Required

Responses

Status: 200 - OK


generateDocumentationForce

Forces process documentation generation


/process/doc/generate-documentation/force/{processId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"/gw/bpmn-admin-server/process/doc/generate-documentation/force/{processId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessDocumentationAPIApi;

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

public class BpmnProcessDocumentationAPIApiExample {

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

public class BpmnProcessDocumentationAPIApiExample {

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

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

// Forces process documentation generation
[apiInstance generateDocumentationForceWith:processId
              completionHandler: ^(HvlResponseString output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessDocumentationAPIApi()
var processId = ; // {{}} 

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

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

            var apiInstance = new BpmnProcessDocumentationAPIApi();
            var processId = new (); //  | 

            try
            {
                // Forces process documentation generation
                HvlResponseString result = apiInstance.generateDocumentationForce(processId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessDocumentationAPIApi.generateDocumentationForce: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnProcessDocumentationAPIApi();
$processId = ; //  | 

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

my $api_instance = WWW::SwaggerClient::BpmnProcessDocumentationAPIApi->new();
my $processId = ; #  | 

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

try: 
    # Forces process documentation generation
    api_response = api_instance.generate_documentation_force(processId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnProcessDocumentationAPIApi->generateDocumentationForce: %s\n" % e)

Parameters

Path parameters
Name Description
processId*
(int64)
Required

Responses

Status: 200 - OK


BpmnProcessDocumentationAttachmentAPI

addFileToDocumentation

Saves process documentation attachment


/process/doc-attachment/add/{processId}

Usage and SDK Samples

curl -X POST\
-H "Accept: */*"\
-H "Content-Type: multipart/form-data"\
"/gw/bpmn-admin-server/process/doc-attachment/add/{processId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessDocumentationAttachmentAPIApi;

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

public class BpmnProcessDocumentationAttachmentAPIApiExample {

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

public class BpmnProcessDocumentationAttachmentAPIApiExample {

    public static void main(String[] args) {
        BpmnProcessDocumentationAttachmentAPIApi apiInstance = new BpmnProcessDocumentationAttachmentAPIApi();
         processId = ; //  | 
         file = ; //  | 
        try {
            HvlResponseLong result = apiInstance.addFileToDocumentation(processId, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnProcessDocumentationAttachmentAPIApi#addFileToDocumentation");
            e.printStackTrace();
        }
    }
}
 *processId = ; // 
 *file = ; //  (optional)

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

// Saves process documentation attachment
[apiInstance addFileToDocumentationWith:processId
    file:file
              completionHandler: ^(HvlResponseLong output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessDocumentationAttachmentAPIApi()
var processId = ; // {{}} 
var opts = { 
  'file':  // {{}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addFileToDocumentation(processId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnProcessDocumentationAttachmentAPIApi();
            var processId = new (); //  | 
            var file = new (); //  |  (optional) 

            try
            {
                // Saves process documentation attachment
                HvlResponseLong result = apiInstance.addFileToDocumentation(processId, file);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessDocumentationAttachmentAPIApi.addFileToDocumentation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnProcessDocumentationAttachmentAPIApi();
$processId = ; //  | 
$file = ; //  | 

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

my $api_instance = WWW::SwaggerClient::BpmnProcessDocumentationAttachmentAPIApi->new();
my $processId = ; #  | 
my $file = ; #  | 

eval { 
    my $result = $api_instance->addFileToDocumentation(processId => $processId, file => $file);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnProcessDocumentationAttachmentAPIApi->addFileToDocumentation: $@\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.BpmnProcessDocumentationAttachmentAPIApi()
processId =  #  | 
file =  #  |  (optional)

try: 
    # Saves process documentation attachment
    api_response = api_instance.add_file_to_documentation(processId, file=file)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnProcessDocumentationAttachmentAPIApi->addFileToDocumentation: %s\n" % e)

Parameters

Path parameters
Name Description
processId*
(int64)
Required
Form parameters
Name Description
file
(binary)

Responses

Status: 200 - OK


delete

Deletes process documentation attachment by uuid and process uuid


/process/doc-attachment/delete/{uuid}/{processUuid}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: */*"\
"/gw/bpmn-admin-server/process/doc-attachment/delete/{uuid}/{processUuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessDocumentationAttachmentAPIApi;

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

public class BpmnProcessDocumentationAttachmentAPIApiExample {

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

public class BpmnProcessDocumentationAttachmentAPIApiExample {

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

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

// Deletes process documentation attachment by uuid and process uuid
[apiInstance deleteWith:uuid
    processUuid:processUuid
              completionHandler: ^(HvlResponseVoid output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessDocumentationAttachmentAPIApi()
var uuid = ; // {{}} 
var processUuid = ; // {{}} 

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

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

            var apiInstance = new BpmnProcessDocumentationAttachmentAPIApi();
            var uuid = new (); //  | 
            var processUuid = new (); //  | 

            try
            {
                // Deletes process documentation attachment by uuid and process uuid
                HvlResponseVoid result = apiInstance.delete(uuid, processUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessDocumentationAttachmentAPIApi.delete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

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

try: 
    # Deletes process documentation attachment by uuid and process uuid
    api_response = api_instance.delete(uuid, processUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnProcessDocumentationAttachmentAPIApi->delete: %s\n" % e)

Parameters

Path parameters
Name Description
uuid*
Required
processUuid*
Required

Responses

Status: 200 - OK


downloadAttachment

Downloads process documentation attachment by uuid


/process/doc-attachment/download/{uuid}

Usage and SDK Samples

curl -X GET\
-H "Accept: */*"\
"/gw/bpmn-admin-server/process/doc-attachment/download/{uuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessDocumentationAttachmentAPIApi;

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

public class BpmnProcessDocumentationAttachmentAPIApiExample {

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

public class BpmnProcessDocumentationAttachmentAPIApiExample {

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

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

// Downloads process documentation attachment by uuid
[apiInstance downloadAttachmentWith:uuid
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessDocumentationAttachmentAPIApi()
var uuid = ; // {{}} 

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

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

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

            try
            {
                // Downloads process documentation attachment by uuid
                apiInstance.downloadAttachment(uuid);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessDocumentationAttachmentAPIApi.downloadAttachment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

eval { 
    $api_instance->downloadAttachment(uuid => $uuid);
};
if ($@) {
    warn "Exception when calling BpmnProcessDocumentationAttachmentAPIApi->downloadAttachment: $@\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.BpmnProcessDocumentationAttachmentAPIApi()
uuid =  #  | 

try: 
    # Downloads process documentation attachment by uuid
    api_instance.download_attachment(uuid)
except ApiException as e:
    print("Exception when calling BpmnProcessDocumentationAttachmentAPIApi->downloadAttachment: %s\n" % e)

Parameters

Path parameters
Name Description
uuid*
Required

Responses

Status: 200 - OK


getDataListByBusinessKey

Queries process documentation attachment by business key


/process/doc-attachment/list/{businessKey}

Usage and SDK Samples

curl -X GET\
-H "Accept: */*"\
"/gw/bpmn-admin-server/process/doc-attachment/list/{businessKey}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessDocumentationAttachmentAPIApi;

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

public class BpmnProcessDocumentationAttachmentAPIApiExample {

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

public class BpmnProcessDocumentationAttachmentAPIApiExample {

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

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

// Queries process documentation attachment by business key
[apiInstance getDataListByBusinessKeyWith:businessKey
              completionHandler: ^(HvlResponseListProjectedProcessDocAttachmentModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessDocumentationAttachmentAPIApi()
var businessKey = ; // {{}} 

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

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

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

            try
            {
                // Queries process documentation attachment by business key
                HvlResponseListProjectedProcessDocAttachmentModel result = apiInstance.getDataListByBusinessKey(businessKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessDocumentationAttachmentAPIApi.getDataListByBusinessKey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

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

try: 
    # Queries process documentation attachment by business key
    api_response = api_instance.get_data_list_by_business_key(businessKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnProcessDocumentationAttachmentAPIApi->getDataListByBusinessKey: %s\n" % e)

Parameters

Path parameters
Name Description
businessKey*
Required

Responses

Status: 200 - OK


BpmnProcessFormAPI

completeProcessFormInstance

Completes process form instance


/process/form/form-model-instance/complete-form

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json"\
"/gw/bpmn-admin-server/process/form/form-model-instance/complete-form"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessFormAPIApi;

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

public class BpmnProcessFormAPIApiExample {

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

public class BpmnProcessFormAPIApiExample {

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

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

// Completes process form instance
[apiInstance completeProcessFormInstanceWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessFormAPIApi()
var body = ; // {{}} 

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

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

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

            try
            {
                // Completes process form instance
                apiInstance.completeProcessFormInstance(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessFormAPIApi.completeProcessFormInstance: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

eval { 
    $api_instance->completeProcessFormInstance(body => $body);
};
if ($@) {
    warn "Exception when calling BpmnProcessFormAPIApi->completeProcessFormInstance: $@\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.BpmnProcessFormAPIApi()
body =  #  | 

try: 
    # Completes process form instance
    api_instance.complete_process_form_instance(body)
except ApiException as e:
    print("Exception when calling BpmnProcessFormAPIApi->completeProcessFormInstance: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


deleteFormConfigurationByUuid

Deletes process form configuration


/process/form/configuration/by-uuid/{uuid}

Usage and SDK Samples

curl -X DELETE\
-H "Accept: application/json"\
"/gw/bpmn-admin-server/process/form/configuration/by-uuid/{uuid}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessFormAPIApi;

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

public class BpmnProcessFormAPIApiExample {

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

public class BpmnProcessFormAPIApiExample {

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

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

// Deletes process form configuration
[apiInstance deleteFormConfigurationByUuidWith:uuid
              completionHandler: ^(HvlResponseVoid output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessFormAPIApi()
var uuid = ; // {{}} 

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

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

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

            try
            {
                // Deletes process form configuration
                HvlResponseVoid result = apiInstance.deleteFormConfigurationByUuid(uuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessFormAPIApi.deleteFormConfigurationByUuid: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

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

try: 
    # Deletes process form configuration
    api_response = api_instance.delete_form_configuration_by_uuid(uuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnProcessFormAPIApi->deleteFormConfigurationByUuid: %s\n" % e)

Parameters

Path parameters
Name Description
uuid*
Required

Responses

Status: 200 - OK


generateForm

Generates process form model node


/process/form/form-model-generate

Usage and SDK Samples

curl -X POST\
-H "Accept: */*"\
-H "Content-Type: multipart/form-data"\
"/gw/bpmn-admin-server/process/form/form-model-generate"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessFormAPIApi;

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

public class BpmnProcessFormAPIApiExample {

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

public class BpmnProcessFormAPIApiExample {

    public static void main(String[] args) {
        BpmnProcessFormAPIApi apiInstance = new BpmnProcessFormAPIApi();
         ddlFile = ; //  | 
        try {
            HvlResponseObjectNode result = apiInstance.generateForm(ddlFile);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnProcessFormAPIApi#generateForm");
            e.printStackTrace();
        }
    }
}
 *ddlFile = ; //  (optional)

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

// Generates process form model node
[apiInstance generateFormWith:ddlFile
              completionHandler: ^(HvlResponseObjectNode output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessFormAPIApi()
var opts = { 
  'ddlFile':  // {{}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.generateForm(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnProcessFormAPIApi();
            var ddlFile = new (); //  |  (optional) 

            try
            {
                // Generates process form model node
                HvlResponseObjectNode result = apiInstance.generateForm(ddlFile);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessFormAPIApi.generateForm: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnProcessFormAPIApi();
$ddlFile = ; //  | 

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

my $api_instance = WWW::SwaggerClient::BpmnProcessFormAPIApi->new();
my $ddlFile = ; #  | 

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

try: 
    # Generates process form model node
    api_response = api_instance.generate_form(ddlFile=ddlFile)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnProcessFormAPIApi->generateForm: %s\n" % e)

Parameters

Form parameters
Name Description
ddlFile
(binary)

Responses

Status: 200 - OK


getFormConfiguration

Gets process form configuration


/process/form/configuration/{hvlProcessId}/{formId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"/gw/bpmn-admin-server/process/form/configuration/{hvlProcessId}/{formId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessFormAPIApi;

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

public class BpmnProcessFormAPIApiExample {

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

public class BpmnProcessFormAPIApiExample {

    public static void main(String[] args) {
        BpmnProcessFormAPIApi apiInstance = new BpmnProcessFormAPIApi();
         hvlProcessId = ; //  | 
         formId = ; //  | 
        try {
            HvlResponseHvlBpmnProcessFormConfigurationModel result = apiInstance.getFormConfiguration(hvlProcessId, formId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnProcessFormAPIApi#getFormConfiguration");
            e.printStackTrace();
        }
    }
}
 *hvlProcessId = ; // 
 *formId = ; // 

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

// Gets process form configuration
[apiInstance getFormConfigurationWith:hvlProcessId
    formId:formId
              completionHandler: ^(HvlResponseHvlBpmnProcessFormConfigurationModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessFormAPIApi()
var hvlProcessId = ; // {{}} 
var formId = ; // {{}} 

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

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

            var apiInstance = new BpmnProcessFormAPIApi();
            var hvlProcessId = new (); //  | 
            var formId = new (); //  | 

            try
            {
                // Gets process form configuration
                HvlResponseHvlBpmnProcessFormConfigurationModel result = apiInstance.getFormConfiguration(hvlProcessId, formId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessFormAPIApi.getFormConfiguration: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnProcessFormAPIApi();
$hvlProcessId = ; //  | 
$formId = ; //  | 

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

my $api_instance = WWW::SwaggerClient::BpmnProcessFormAPIApi->new();
my $hvlProcessId = ; #  | 
my $formId = ; #  | 

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

try: 
    # Gets process form configuration
    api_response = api_instance.get_form_configuration(hvlProcessId, formId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnProcessFormAPIApi->getFormConfiguration: %s\n" % e)

Parameters

Path parameters
Name Description
hvlProcessId*
(int64)
Required
formId*
Required

Responses

Status: 200 - OK


getProcessFormModel

Gets process form model node


/process/form/form-model/{modelId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"/gw/bpmn-admin-server/process/form/form-model/{modelId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessFormAPIApi;

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

public class BpmnProcessFormAPIApiExample {

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

public class BpmnProcessFormAPIApiExample {

    public static void main(String[] args) {
        BpmnProcessFormAPIApi apiInstance = new BpmnProcessFormAPIApi();
         modelId = ; //  | 
        try {
            apiInstance.getProcessFormModel(modelId);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnProcessFormAPIApi#getProcessFormModel");
            e.printStackTrace();
        }
    }
}
 *modelId = ; // 

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

// Gets process form model node
[apiInstance getProcessFormModelWith:modelId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessFormAPIApi()
var modelId = ; // {{}} 

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

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

            var apiInstance = new BpmnProcessFormAPIApi();
            var modelId = new (); //  | 

            try
            {
                // Gets process form model node
                apiInstance.getProcessFormModel(modelId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessFormAPIApi.getProcessFormModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnProcessFormAPIApi();
$modelId = ; //  | 

try {
    $api_instance->getProcessFormModel($modelId);
} catch (Exception $e) {
    echo 'Exception when calling BpmnProcessFormAPIApi->getProcessFormModel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BpmnProcessFormAPIApi;

my $api_instance = WWW::SwaggerClient::BpmnProcessFormAPIApi->new();
my $modelId = ; #  | 

eval { 
    $api_instance->getProcessFormModel(modelId => $modelId);
};
if ($@) {
    warn "Exception when calling BpmnProcessFormAPIApi->getProcessFormModel: $@\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.BpmnProcessFormAPIApi()
modelId =  #  | 

try: 
    # Gets process form model node
    api_instance.get_process_form_model(modelId)
except ApiException as e:
    print("Exception when calling BpmnProcessFormAPIApi->getProcessFormModel: %s\n" % e)

Parameters

Path parameters
Name Description
modelId*
Required

Responses

Status: 200 - OK


getProcessFormModelWithInstance

Gets process form model node with instance


/process/form/form-model/{modelId}/execution-id/{executionId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"/gw/bpmn-admin-server/process/form/form-model/{modelId}/execution-id/{executionId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessFormAPIApi;

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

public class BpmnProcessFormAPIApiExample {

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

public class BpmnProcessFormAPIApiExample {

    public static void main(String[] args) {
        BpmnProcessFormAPIApi apiInstance = new BpmnProcessFormAPIApi();
         modelId = ; //  | 
         executionId = ; //  | 
        try {
            apiInstance.getProcessFormModelWithInstance(modelId, executionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnProcessFormAPIApi#getProcessFormModelWithInstance");
            e.printStackTrace();
        }
    }
}
 *modelId = ; // 
 *executionId = ; // 

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

// Gets process form model node with instance
[apiInstance getProcessFormModelWithInstanceWith:modelId
    executionId:executionId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessFormAPIApi()
var modelId = ; // {{}} 
var executionId = ; // {{}} 

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

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

            var apiInstance = new BpmnProcessFormAPIApi();
            var modelId = new (); //  | 
            var executionId = new (); //  | 

            try
            {
                // Gets process form model node with instance
                apiInstance.getProcessFormModelWithInstance(modelId, executionId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessFormAPIApi.getProcessFormModelWithInstance: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

try {
    $api_instance->getProcessFormModelWithInstance($modelId, $executionId);
} catch (Exception $e) {
    echo 'Exception when calling BpmnProcessFormAPIApi->getProcessFormModelWithInstance: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BpmnProcessFormAPIApi;

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

eval { 
    $api_instance->getProcessFormModelWithInstance(modelId => $modelId, executionId => $executionId);
};
if ($@) {
    warn "Exception when calling BpmnProcessFormAPIApi->getProcessFormModelWithInstance: $@\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.BpmnProcessFormAPIApi()
modelId =  #  | 
executionId =  #  | 

try: 
    # Gets process form model node with instance
    api_instance.get_process_form_model_with_instance(modelId, executionId)
except ApiException as e:
    print("Exception when calling BpmnProcessFormAPIApi->getProcessFormModelWithInstance: %s\n" % e)

Parameters

Path parameters
Name Description
modelId*
Required
executionId*
Required

Responses

Status: 200 - OK


getProcessFormModels

Gets process form models node


/process/form/form-model

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"/gw/bpmn-admin-server/process/form/form-model"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessFormAPIApi;

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

public class BpmnProcessFormAPIApiExample {

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

public class BpmnProcessFormAPIApiExample {

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

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

// Gets process form models node
[apiInstance getProcessFormModelsWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessFormAPIApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getProcessFormModels(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

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

            var apiInstance = new BpmnProcessFormAPIApi();

            try
            {
                // Gets process form models node
                apiInstance.getProcessFormModels();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessFormAPIApi.getProcessFormModels: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

eval { 
    $api_instance->getProcessFormModels();
};
if ($@) {
    warn "Exception when calling BpmnProcessFormAPIApi->getProcessFormModels: $@\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.BpmnProcessFormAPIApi()

try: 
    # Gets process form models node
    api_instance.get_process_form_models()
except ApiException as e:
    print("Exception when calling BpmnProcessFormAPIApi->getProcessFormModels: %s\n" % e)

Parameters

Responses

Status: 200 - OK


getStartProcessFormModel

Gets start process form model node


/process/form/start-form/{key}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"/gw/bpmn-admin-server/process/form/start-form/{key}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessFormAPIApi;

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

public class BpmnProcessFormAPIApiExample {

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

public class BpmnProcessFormAPIApiExample {

    public static void main(String[] args) {
        BpmnProcessFormAPIApi apiInstance = new BpmnProcessFormAPIApi();
         key = ; //  | 
        try {
            apiInstance.getStartProcessFormModel(key);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnProcessFormAPIApi#getStartProcessFormModel");
            e.printStackTrace();
        }
    }
}
 *key = ; // 

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

// Gets start process form model node
[apiInstance getStartProcessFormModelWith:key
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessFormAPIApi()
var key = ; // {{}} 

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

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

            var apiInstance = new BpmnProcessFormAPIApi();
            var key = new (); //  | 

            try
            {
                // Gets start process form model node
                apiInstance.getStartProcessFormModel(key);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessFormAPIApi.getStartProcessFormModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnProcessFormAPIApi();
$key = ; //  | 

try {
    $api_instance->getStartProcessFormModel($key);
} catch (Exception $e) {
    echo 'Exception when calling BpmnProcessFormAPIApi->getStartProcessFormModel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BpmnProcessFormAPIApi;

my $api_instance = WWW::SwaggerClient::BpmnProcessFormAPIApi->new();
my $key = ; #  | 

eval { 
    $api_instance->getStartProcessFormModel(key => $key);
};
if ($@) {
    warn "Exception when calling BpmnProcessFormAPIApi->getStartProcessFormModel: $@\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.BpmnProcessFormAPIApi()
key =  #  | 

try: 
    # Gets start process form model node
    api_instance.get_start_process_form_model(key)
except ApiException as e:
    print("Exception when calling BpmnProcessFormAPIApi->getStartProcessFormModel: %s\n" % e)

Parameters

Path parameters
Name Description
key*
Required

Responses

Status: 200 - OK


saveFormConfiguration

Saves process form configuration


/process/form/configuration

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/gw/bpmn-admin-server/process/form/configuration"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessFormAPIApi;

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

public class BpmnProcessFormAPIApiExample {

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

public class BpmnProcessFormAPIApiExample {

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

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

// Saves process form configuration
[apiInstance saveFormConfigurationWith:body
              completionHandler: ^(HvlResponseVoid output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessFormAPIApi()
var body = ; // {{HvlBpmnProcessFormConfigurationModel}} 

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

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

            var apiInstance = new BpmnProcessFormAPIApi();
            var body = new HvlBpmnProcessFormConfigurationModel(); // HvlBpmnProcessFormConfigurationModel | 

            try
            {
                // Saves process form configuration
                HvlResponseVoid result = apiInstance.saveFormConfiguration(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessFormAPIApi.saveFormConfiguration: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

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

try: 
    # Saves process form configuration
    api_response = api_instance.save_form_configuration(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnProcessFormAPIApi->saveFormConfiguration: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


saveProcessFormInstance

Saves process form instance


/process/form/form-model-instance/save-form

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json"\
"/gw/bpmn-admin-server/process/form/form-model-instance/save-form"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessFormAPIApi;

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

public class BpmnProcessFormAPIApiExample {

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

public class BpmnProcessFormAPIApiExample {

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

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

// Saves process form instance
[apiInstance saveProcessFormInstanceWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessFormAPIApi()
var body = ; // {{}} 

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

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

            var apiInstance = new BpmnProcessFormAPIApi();
            var body = new (); //  | 

            try
            {
                // Saves process form instance
                apiInstance.saveProcessFormInstance(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessFormAPIApi.saveProcessFormInstance: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnProcessFormAPIApi();
$body = ; //  | 

try {
    $api_instance->saveProcessFormInstance($body);
} catch (Exception $e) {
    echo 'Exception when calling BpmnProcessFormAPIApi->saveProcessFormInstance: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BpmnProcessFormAPIApi;

my $api_instance = WWW::SwaggerClient::BpmnProcessFormAPIApi->new();
my $body = WWW::SwaggerClient::Object::->new(); #  | 

eval { 
    $api_instance->saveProcessFormInstance(body => $body);
};
if ($@) {
    warn "Exception when calling BpmnProcessFormAPIApi->saveProcessFormInstance: $@\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.BpmnProcessFormAPIApi()
body =  #  | 

try: 
    # Saves process form instance
    api_instance.save_process_form_instance(body)
except ApiException as e:
    print("Exception when calling BpmnProcessFormAPIApi->saveProcessFormInstance: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


saveProcessFormModel

Saves process form model node


/process/form/form-model

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/gw/bpmn-admin-server/process/form/form-model"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessFormAPIApi;

import java.io.File;
import java.util.*;

public class BpmnProcessFormAPIApiExample {

    public static void main(String[] args) {
        
        BpmnProcessFormAPIApi apiInstance = new BpmnProcessFormAPIApi();
         body = ; //  | 
        try {
            apiInstance.saveProcessFormModel(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnProcessFormAPIApi#saveProcessFormModel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnProcessFormAPIApi;

public class BpmnProcessFormAPIApiExample {

    public static void main(String[] args) {
        BpmnProcessFormAPIApi apiInstance = new BpmnProcessFormAPIApi();
         body = ; //  | 
        try {
            apiInstance.saveProcessFormModel(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnProcessFormAPIApi#saveProcessFormModel");
            e.printStackTrace();
        }
    }
}
 *body = ; // 

BpmnProcessFormAPIApi *apiInstance = [[BpmnProcessFormAPIApi alloc] init];

// Saves process form model node
[apiInstance saveProcessFormModelWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessFormAPIApi()
var body = ; // {{}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.saveProcessFormModel(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class saveProcessFormModelExample
    {
        public void main()
        {

            var apiInstance = new BpmnProcessFormAPIApi();
            var body = new (); //  | 

            try
            {
                // Saves process form model node
                apiInstance.saveProcessFormModel(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessFormAPIApi.saveProcessFormModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnProcessFormAPIApi();
$body = ; //  | 

try {
    $api_instance->saveProcessFormModel($body);
} catch (Exception $e) {
    echo 'Exception when calling BpmnProcessFormAPIApi->saveProcessFormModel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BpmnProcessFormAPIApi;

my $api_instance = WWW::SwaggerClient::BpmnProcessFormAPIApi->new();
my $body = WWW::SwaggerClient::Object::->new(); #  | 

eval { 
    $api_instance->saveProcessFormModel(body => $body);
};
if ($@) {
    warn "Exception when calling BpmnProcessFormAPIApi->saveProcessFormModel: $@\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.BpmnProcessFormAPIApi()
body =  #  | 

try: 
    # Saves process form model node
    api_instance.save_process_form_model(body)
except ApiException as e:
    print("Exception when calling BpmnProcessFormAPIApi->saveProcessFormModel: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


startProcessFormInstance

Starts process form instance


/process/form/form-model-instance/start-form

Usage and SDK Samples

curl -X POST\
-H "Content-Type: application/json"\
"/gw/bpmn-admin-server/process/form/form-model-instance/start-form"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessFormAPIApi;

import java.io.File;
import java.util.*;

public class BpmnProcessFormAPIApiExample {

    public static void main(String[] args) {
        
        BpmnProcessFormAPIApi apiInstance = new BpmnProcessFormAPIApi();
         body = ; //  | 
        try {
            apiInstance.startProcessFormInstance(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnProcessFormAPIApi#startProcessFormInstance");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnProcessFormAPIApi;

public class BpmnProcessFormAPIApiExample {

    public static void main(String[] args) {
        BpmnProcessFormAPIApi apiInstance = new BpmnProcessFormAPIApi();
         body = ; //  | 
        try {
            apiInstance.startProcessFormInstance(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnProcessFormAPIApi#startProcessFormInstance");
            e.printStackTrace();
        }
    }
}
 *body = ; // 

BpmnProcessFormAPIApi *apiInstance = [[BpmnProcessFormAPIApi alloc] init];

// Starts process form instance
[apiInstance startProcessFormInstanceWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessFormAPIApi()
var body = ; // {{}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.startProcessFormInstance(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class startProcessFormInstanceExample
    {
        public void main()
        {

            var apiInstance = new BpmnProcessFormAPIApi();
            var body = new (); //  | 

            try
            {
                // Starts process form instance
                apiInstance.startProcessFormInstance(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessFormAPIApi.startProcessFormInstance: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnProcessFormAPIApi();
$body = ; //  | 

try {
    $api_instance->startProcessFormInstance($body);
} catch (Exception $e) {
    echo 'Exception when calling BpmnProcessFormAPIApi->startProcessFormInstance: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BpmnProcessFormAPIApi;

my $api_instance = WWW::SwaggerClient::BpmnProcessFormAPIApi->new();
my $body = WWW::SwaggerClient::Object::->new(); #  | 

eval { 
    $api_instance->startProcessFormInstance(body => $body);
};
if ($@) {
    warn "Exception when calling BpmnProcessFormAPIApi->startProcessFormInstance: $@\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.BpmnProcessFormAPIApi()
body =  #  | 

try: 
    # Starts process form instance
    api_instance.start_process_form_instance(body)
except ApiException as e:
    print("Exception when calling BpmnProcessFormAPIApi->startProcessFormInstance: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


updateFormConfiguration

Updates process form configuration


/process/form/configuration

Usage and SDK Samples

curl -X PUT\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/gw/bpmn-admin-server/process/form/configuration"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessFormAPIApi;

import java.io.File;
import java.util.*;

public class BpmnProcessFormAPIApiExample {

    public static void main(String[] args) {
        
        BpmnProcessFormAPIApi apiInstance = new BpmnProcessFormAPIApi();
        HvlBpmnProcessFormConfigurationModel body = ; // HvlBpmnProcessFormConfigurationModel | 
        try {
            HvlResponseVoid result = apiInstance.updateFormConfiguration(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnProcessFormAPIApi#updateFormConfiguration");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnProcessFormAPIApi;

public class BpmnProcessFormAPIApiExample {

    public static void main(String[] args) {
        BpmnProcessFormAPIApi apiInstance = new BpmnProcessFormAPIApi();
        HvlBpmnProcessFormConfigurationModel body = ; // HvlBpmnProcessFormConfigurationModel | 
        try {
            HvlResponseVoid result = apiInstance.updateFormConfiguration(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnProcessFormAPIApi#updateFormConfiguration");
            e.printStackTrace();
        }
    }
}
HvlBpmnProcessFormConfigurationModel *body = ; // 

BpmnProcessFormAPIApi *apiInstance = [[BpmnProcessFormAPIApi alloc] init];

// Updates process form configuration
[apiInstance updateFormConfigurationWith:body
              completionHandler: ^(HvlResponseVoid output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessFormAPIApi()
var body = ; // {{HvlBpmnProcessFormConfigurationModel}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateFormConfiguration(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateFormConfigurationExample
    {
        public void main()
        {

            var apiInstance = new BpmnProcessFormAPIApi();
            var body = new HvlBpmnProcessFormConfigurationModel(); // HvlBpmnProcessFormConfigurationModel | 

            try
            {
                // Updates process form configuration
                HvlResponseVoid result = apiInstance.updateFormConfiguration(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessFormAPIApi.updateFormConfiguration: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnProcessFormAPIApi();
$body = ; // HvlBpmnProcessFormConfigurationModel | 

try {
    $result = $api_instance->updateFormConfiguration($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BpmnProcessFormAPIApi->updateFormConfiguration: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BpmnProcessFormAPIApi;

my $api_instance = WWW::SwaggerClient::BpmnProcessFormAPIApi->new();
my $body = WWW::SwaggerClient::Object::HvlBpmnProcessFormConfigurationModel->new(); # HvlBpmnProcessFormConfigurationModel | 

eval { 
    my $result = $api_instance->updateFormConfiguration(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnProcessFormAPIApi->updateFormConfiguration: $@\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.BpmnProcessFormAPIApi()
body =  # HvlBpmnProcessFormConfigurationModel | 

try: 
    # Updates process form configuration
    api_response = api_instance.update_form_configuration(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnProcessFormAPIApi->updateFormConfiguration: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


updateProcessFormModel

Updates process form model node


/process/form/form-model/{modelId}

Usage and SDK Samples

curl -X PUT\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/gw/bpmn-admin-server/process/form/form-model/{modelId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessFormAPIApi;

import java.io.File;
import java.util.*;

public class BpmnProcessFormAPIApiExample {

    public static void main(String[] args) {
        
        BpmnProcessFormAPIApi apiInstance = new BpmnProcessFormAPIApi();
         body = ; //  | 
         modelId = ; //  | 
        try {
            apiInstance.updateProcessFormModel(body, modelId);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnProcessFormAPIApi#updateProcessFormModel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnProcessFormAPIApi;

public class BpmnProcessFormAPIApiExample {

    public static void main(String[] args) {
        BpmnProcessFormAPIApi apiInstance = new BpmnProcessFormAPIApi();
         body = ; //  | 
         modelId = ; //  | 
        try {
            apiInstance.updateProcessFormModel(body, modelId);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnProcessFormAPIApi#updateProcessFormModel");
            e.printStackTrace();
        }
    }
}
 *body = ; // 
 *modelId = ; // 

BpmnProcessFormAPIApi *apiInstance = [[BpmnProcessFormAPIApi alloc] init];

// Updates process form model node
[apiInstance updateProcessFormModelWith:body
    modelId:modelId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessFormAPIApi()
var body = ; // {{}} 
var modelId = ; // {{}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateProcessFormModel(bodymodelId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateProcessFormModelExample
    {
        public void main()
        {

            var apiInstance = new BpmnProcessFormAPIApi();
            var body = new (); //  | 
            var modelId = new (); //  | 

            try
            {
                // Updates process form model node
                apiInstance.updateProcessFormModel(body, modelId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessFormAPIApi.updateProcessFormModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnProcessFormAPIApi();
$body = ; //  | 
$modelId = ; //  | 

try {
    $api_instance->updateProcessFormModel($body, $modelId);
} catch (Exception $e) {
    echo 'Exception when calling BpmnProcessFormAPIApi->updateProcessFormModel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BpmnProcessFormAPIApi;

my $api_instance = WWW::SwaggerClient::BpmnProcessFormAPIApi->new();
my $body = WWW::SwaggerClient::Object::->new(); #  | 
my $modelId = ; #  | 

eval { 
    $api_instance->updateProcessFormModel(body => $body, modelId => $modelId);
};
if ($@) {
    warn "Exception when calling BpmnProcessFormAPIApi->updateProcessFormModel: $@\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.BpmnProcessFormAPIApi()
body =  #  | 
modelId =  #  | 

try: 
    # Updates process form model node
    api_instance.update_process_form_model(body, modelId)
except ApiException as e:
    print("Exception when calling BpmnProcessFormAPIApi->updateProcessFormModel: %s\n" % e)

Parameters

Path parameters
Name Description
modelId*
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK


BpmnProcessInstanceAPI

deleteByDeleteProcessInstanceModel

Deletes process instance with provided delete process instance model


/process/instance/by-delete-process-instance-model

Usage and SDK Samples

curl -X POST\
-H "Accept: */*"\
-H "Content-Type: application/json"\
"/gw/bpmn-admin-server/process/instance/by-delete-process-instance-model"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessInstanceAPIApi;

import java.io.File;
import java.util.*;

public class BpmnProcessInstanceAPIApiExample {

    public static void main(String[] args) {
        
        BpmnProcessInstanceAPIApi apiInstance = new BpmnProcessInstanceAPIApi();
        HvlBpmnDeleteProcessInstanceModel body = ; // HvlBpmnDeleteProcessInstanceModel | 
        try {
            HvlResponseVoid result = apiInstance.deleteByDeleteProcessInstanceModel(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnProcessInstanceAPIApi#deleteByDeleteProcessInstanceModel");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnProcessInstanceAPIApi;

public class BpmnProcessInstanceAPIApiExample {

    public static void main(String[] args) {
        BpmnProcessInstanceAPIApi apiInstance = new BpmnProcessInstanceAPIApi();
        HvlBpmnDeleteProcessInstanceModel body = ; // HvlBpmnDeleteProcessInstanceModel | 
        try {
            HvlResponseVoid result = apiInstance.deleteByDeleteProcessInstanceModel(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnProcessInstanceAPIApi#deleteByDeleteProcessInstanceModel");
            e.printStackTrace();
        }
    }
}
HvlBpmnDeleteProcessInstanceModel *body = ; // 

BpmnProcessInstanceAPIApi *apiInstance = [[BpmnProcessInstanceAPIApi alloc] init];

// Deletes process instance with provided delete process instance model
[apiInstance deleteByDeleteProcessInstanceModelWith:body
              completionHandler: ^(HvlResponseVoid output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessInstanceAPIApi()
var body = ; // {{HvlBpmnDeleteProcessInstanceModel}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteByDeleteProcessInstanceModel(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteByDeleteProcessInstanceModelExample
    {
        public void main()
        {

            var apiInstance = new BpmnProcessInstanceAPIApi();
            var body = new HvlBpmnDeleteProcessInstanceModel(); // HvlBpmnDeleteProcessInstanceModel | 

            try
            {
                // Deletes process instance with provided delete process instance model
                HvlResponseVoid result = apiInstance.deleteByDeleteProcessInstanceModel(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessInstanceAPIApi.deleteByDeleteProcessInstanceModel: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnProcessInstanceAPIApi();
$body = ; // HvlBpmnDeleteProcessInstanceModel | 

try {
    $result = $api_instance->deleteByDeleteProcessInstanceModel($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BpmnProcessInstanceAPIApi->deleteByDeleteProcessInstanceModel: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BpmnProcessInstanceAPIApi;

my $api_instance = WWW::SwaggerClient::BpmnProcessInstanceAPIApi->new();
my $body = WWW::SwaggerClient::Object::HvlBpmnDeleteProcessInstanceModel->new(); # HvlBpmnDeleteProcessInstanceModel | 

eval { 
    my $result = $api_instance->deleteByDeleteProcessInstanceModel(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnProcessInstanceAPIApi->deleteByDeleteProcessInstanceModel: $@\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.BpmnProcessInstanceAPIApi()
body =  # HvlBpmnDeleteProcessInstanceModel | 

try: 
    # Deletes process instance with provided delete process instance model
    api_response = api_instance.delete_by_delete_process_instance_model(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnProcessInstanceAPIApi->deleteByDeleteProcessInstanceModel: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


queryInstanceLogs

Queries process instances logs as paginated according to criteria in query model


/process/instance/logs/page

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/gw/bpmn-admin-server/process/instance/logs/page"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessInstanceAPIApi;

import java.io.File;
import java.util.*;

public class BpmnProcessInstanceAPIApiExample {

    public static void main(String[] args) {
        
        BpmnProcessInstanceAPIApi apiInstance = new BpmnProcessInstanceAPIApi();
        HvlBpmnEventLogQueryModel body = ; // HvlBpmnEventLogQueryModel | 
        try {
            HvlResponseHvlPageHvlBpmnProcessInstanceLogModel result = apiInstance.queryInstanceLogs(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnProcessInstanceAPIApi#queryInstanceLogs");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnProcessInstanceAPIApi;

public class BpmnProcessInstanceAPIApiExample {

    public static void main(String[] args) {
        BpmnProcessInstanceAPIApi apiInstance = new BpmnProcessInstanceAPIApi();
        HvlBpmnEventLogQueryModel body = ; // HvlBpmnEventLogQueryModel | 
        try {
            HvlResponseHvlPageHvlBpmnProcessInstanceLogModel result = apiInstance.queryInstanceLogs(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnProcessInstanceAPIApi#queryInstanceLogs");
            e.printStackTrace();
        }
    }
}
HvlBpmnEventLogQueryModel *body = ; // 

BpmnProcessInstanceAPIApi *apiInstance = [[BpmnProcessInstanceAPIApi alloc] init];

// Queries process instances logs as paginated according to criteria in query model
[apiInstance queryInstanceLogsWith:body
              completionHandler: ^(HvlResponseHvlPageHvlBpmnProcessInstanceLogModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessInstanceAPIApi()
var body = ; // {{HvlBpmnEventLogQueryModel}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.queryInstanceLogs(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class queryInstanceLogsExample
    {
        public void main()
        {

            var apiInstance = new BpmnProcessInstanceAPIApi();
            var body = new HvlBpmnEventLogQueryModel(); // HvlBpmnEventLogQueryModel | 

            try
            {
                // Queries process instances logs as paginated according to criteria in query model
                HvlResponseHvlPageHvlBpmnProcessInstanceLogModel result = apiInstance.queryInstanceLogs(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessInstanceAPIApi.queryInstanceLogs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnProcessInstanceAPIApi();
$body = ; // HvlBpmnEventLogQueryModel | 

try {
    $result = $api_instance->queryInstanceLogs($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BpmnProcessInstanceAPIApi->queryInstanceLogs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BpmnProcessInstanceAPIApi;

my $api_instance = WWW::SwaggerClient::BpmnProcessInstanceAPIApi->new();
my $body = WWW::SwaggerClient::Object::HvlBpmnEventLogQueryModel->new(); # HvlBpmnEventLogQueryModel | 

eval { 
    my $result = $api_instance->queryInstanceLogs(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnProcessInstanceAPIApi->queryInstanceLogs: $@\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.BpmnProcessInstanceAPIApi()
body =  # HvlBpmnEventLogQueryModel | 

try: 
    # Queries process instances logs as paginated according to criteria in query model
    api_response = api_instance.query_instance_logs(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnProcessInstanceAPIApi->queryInstanceLogs: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


queryList2

Queries process instances according to criteria in query model


/process/instance/list

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/gw/bpmn-admin-server/process/instance/list"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessInstanceAPIApi;

import java.io.File;
import java.util.*;

public class BpmnProcessInstanceAPIApiExample {

    public static void main(String[] args) {
        
        BpmnProcessInstanceAPIApi apiInstance = new BpmnProcessInstanceAPIApi();
        HvlBpmnAdminProcessInstanceQueryModel_WithActive body = ; // HvlBpmnAdminProcessInstanceQueryModel_WithActive | 
        try {
            HvlResponseListHvlBpmnAdminProcessInstanceModel_WithActive result = apiInstance.queryList2(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnProcessInstanceAPIApi#queryList2");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnProcessInstanceAPIApi;

public class BpmnProcessInstanceAPIApiExample {

    public static void main(String[] args) {
        BpmnProcessInstanceAPIApi apiInstance = new BpmnProcessInstanceAPIApi();
        HvlBpmnAdminProcessInstanceQueryModel_WithActive body = ; // HvlBpmnAdminProcessInstanceQueryModel_WithActive | 
        try {
            HvlResponseListHvlBpmnAdminProcessInstanceModel_WithActive result = apiInstance.queryList2(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnProcessInstanceAPIApi#queryList2");
            e.printStackTrace();
        }
    }
}
HvlBpmnAdminProcessInstanceQueryModel_WithActive *body = ; // 

BpmnProcessInstanceAPIApi *apiInstance = [[BpmnProcessInstanceAPIApi alloc] init];

// Queries process instances according to criteria in query model
[apiInstance queryList2With:body
              completionHandler: ^(HvlResponseListHvlBpmnAdminProcessInstanceModel_WithActive output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessInstanceAPIApi()
var body = ; // {{HvlBpmnAdminProcessInstanceQueryModel_WithActive}} 

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 BpmnProcessInstanceAPIApi();
            var body = new HvlBpmnAdminProcessInstanceQueryModel_WithActive(); // HvlBpmnAdminProcessInstanceQueryModel_WithActive | 

            try
            {
                // Queries process instances according to criteria in query model
                HvlResponseListHvlBpmnAdminProcessInstanceModel_WithActive result = apiInstance.queryList2(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessInstanceAPIApi.queryList2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnProcessInstanceAPIApi();
$body = ; // HvlBpmnAdminProcessInstanceQueryModel_WithActive | 

try {
    $result = $api_instance->queryList2($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BpmnProcessInstanceAPIApi->queryList2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BpmnProcessInstanceAPIApi;

my $api_instance = WWW::SwaggerClient::BpmnProcessInstanceAPIApi->new();
my $body = WWW::SwaggerClient::Object::HvlBpmnAdminProcessInstanceQueryModel_WithActive->new(); # HvlBpmnAdminProcessInstanceQueryModel_WithActive | 

eval { 
    my $result = $api_instance->queryList2(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnProcessInstanceAPIApi->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.BpmnProcessInstanceAPIApi()
body =  # HvlBpmnAdminProcessInstanceQueryModel_WithActive | 

try: 
    # Queries process instances according to criteria in query model
    api_response = api_instance.query_list2(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnProcessInstanceAPIApi->queryList2: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


queryPage2

Queries process instances as paginated according to criteria in query model


/process/instance/page

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/gw/bpmn-admin-server/process/instance/page"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessInstanceAPIApi;

import java.io.File;
import java.util.*;

public class BpmnProcessInstanceAPIApiExample {

    public static void main(String[] args) {
        
        BpmnProcessInstanceAPIApi apiInstance = new BpmnProcessInstanceAPIApi();
        HvlBpmnAdminProcessInstanceQueryModel_WithActive body = ; // HvlBpmnAdminProcessInstanceQueryModel_WithActive | 
        try {
            HvlResponseHvlPageHvlBpmnAdminProcessInstanceModel_WithActive result = apiInstance.queryPage2(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnProcessInstanceAPIApi#queryPage2");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnProcessInstanceAPIApi;

public class BpmnProcessInstanceAPIApiExample {

    public static void main(String[] args) {
        BpmnProcessInstanceAPIApi apiInstance = new BpmnProcessInstanceAPIApi();
        HvlBpmnAdminProcessInstanceQueryModel_WithActive body = ; // HvlBpmnAdminProcessInstanceQueryModel_WithActive | 
        try {
            HvlResponseHvlPageHvlBpmnAdminProcessInstanceModel_WithActive result = apiInstance.queryPage2(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnProcessInstanceAPIApi#queryPage2");
            e.printStackTrace();
        }
    }
}
HvlBpmnAdminProcessInstanceQueryModel_WithActive *body = ; // 

BpmnProcessInstanceAPIApi *apiInstance = [[BpmnProcessInstanceAPIApi alloc] init];

// Queries process instances as paginated according to criteria in query model
[apiInstance queryPage2With:body
              completionHandler: ^(HvlResponseHvlPageHvlBpmnAdminProcessInstanceModel_WithActive output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessInstanceAPIApi()
var body = ; // {{HvlBpmnAdminProcessInstanceQueryModel_WithActive}} 

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 BpmnProcessInstanceAPIApi();
            var body = new HvlBpmnAdminProcessInstanceQueryModel_WithActive(); // HvlBpmnAdminProcessInstanceQueryModel_WithActive | 

            try
            {
                // Queries process instances as paginated according to criteria in query model
                HvlResponseHvlPageHvlBpmnAdminProcessInstanceModel_WithActive result = apiInstance.queryPage2(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessInstanceAPIApi.queryPage2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnProcessInstanceAPIApi();
$body = ; // HvlBpmnAdminProcessInstanceQueryModel_WithActive | 

try {
    $result = $api_instance->queryPage2($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BpmnProcessInstanceAPIApi->queryPage2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BpmnProcessInstanceAPIApi;

my $api_instance = WWW::SwaggerClient::BpmnProcessInstanceAPIApi->new();
my $body = WWW::SwaggerClient::Object::HvlBpmnAdminProcessInstanceQueryModel_WithActive->new(); # HvlBpmnAdminProcessInstanceQueryModel_WithActive | 

eval { 
    my $result = $api_instance->queryPage2(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnProcessInstanceAPIApi->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.BpmnProcessInstanceAPIApi()
body =  # HvlBpmnAdminProcessInstanceQueryModel_WithActive | 

try: 
    # Queries process instances as paginated according to criteria in query model
    api_response = api_instance.query_page2(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnProcessInstanceAPIApi->queryPage2: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


queryTaskPage

Queries tasks by process instances as paginated according to criteria in query model


/process/instance/task/page

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/gw/bpmn-admin-server/process/instance/task/page"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessInstanceAPIApi;

import java.io.File;
import java.util.*;

public class BpmnProcessInstanceAPIApiExample {

    public static void main(String[] args) {
        
        BpmnProcessInstanceAPIApi apiInstance = new BpmnProcessInstanceAPIApi();
        HvlBpmnTaskQueryModel body = ; // HvlBpmnTaskQueryModel | 
        try {
            HvlResponseHvlPageHvlBpmnTaskModel result = apiInstance.queryTaskPage(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnProcessInstanceAPIApi#queryTaskPage");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnProcessInstanceAPIApi;

public class BpmnProcessInstanceAPIApiExample {

    public static void main(String[] args) {
        BpmnProcessInstanceAPIApi apiInstance = new BpmnProcessInstanceAPIApi();
        HvlBpmnTaskQueryModel body = ; // HvlBpmnTaskQueryModel | 
        try {
            HvlResponseHvlPageHvlBpmnTaskModel result = apiInstance.queryTaskPage(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnProcessInstanceAPIApi#queryTaskPage");
            e.printStackTrace();
        }
    }
}
HvlBpmnTaskQueryModel *body = ; // 

BpmnProcessInstanceAPIApi *apiInstance = [[BpmnProcessInstanceAPIApi alloc] init];

// Queries tasks by process instances as paginated according to criteria in query model
[apiInstance queryTaskPageWith:body
              completionHandler: ^(HvlResponseHvlPageHvlBpmnTaskModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessInstanceAPIApi()
var body = ; // {{HvlBpmnTaskQueryModel}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.queryTaskPage(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class queryTaskPageExample
    {
        public void main()
        {

            var apiInstance = new BpmnProcessInstanceAPIApi();
            var body = new HvlBpmnTaskQueryModel(); // HvlBpmnTaskQueryModel | 

            try
            {
                // Queries tasks by process instances as paginated according to criteria in query model
                HvlResponseHvlPageHvlBpmnTaskModel result = apiInstance.queryTaskPage(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessInstanceAPIApi.queryTaskPage: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnProcessInstanceAPIApi();
$body = ; // HvlBpmnTaskQueryModel | 

try {
    $result = $api_instance->queryTaskPage($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BpmnProcessInstanceAPIApi->queryTaskPage: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BpmnProcessInstanceAPIApi;

my $api_instance = WWW::SwaggerClient::BpmnProcessInstanceAPIApi->new();
my $body = WWW::SwaggerClient::Object::HvlBpmnTaskQueryModel->new(); # HvlBpmnTaskQueryModel | 

eval { 
    my $result = $api_instance->queryTaskPage(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnProcessInstanceAPIApi->queryTaskPage: $@\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.BpmnProcessInstanceAPIApi()
body =  # HvlBpmnTaskQueryModel | 

try: 
    # Queries tasks by process instances as paginated according to criteria in query model
    api_response = api_instance.query_task_page(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnProcessInstanceAPIApi->queryTaskPage: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


BpmnProcessStatsAPI

getProcessDefinitionCategoryCounts

Queries process definition category counts according to criteria in query model


/process/stats/process-definition-category-counts

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/gw/bpmn-admin-server/process/stats/process-definition-category-counts"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessStatsAPIApi;

import java.io.File;
import java.util.*;

public class BpmnProcessStatsAPIApiExample {

    public static void main(String[] args) {
        
        BpmnProcessStatsAPIApi apiInstance = new BpmnProcessStatsAPIApi();
        HvlBpmnProcessQueryModel body = ; // HvlBpmnProcessQueryModel | 
        try {
            HvlResponseMapStringLong result = apiInstance.getProcessDefinitionCategoryCounts(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnProcessStatsAPIApi#getProcessDefinitionCategoryCounts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnProcessStatsAPIApi;

public class BpmnProcessStatsAPIApiExample {

    public static void main(String[] args) {
        BpmnProcessStatsAPIApi apiInstance = new BpmnProcessStatsAPIApi();
        HvlBpmnProcessQueryModel body = ; // HvlBpmnProcessQueryModel | 
        try {
            HvlResponseMapStringLong result = apiInstance.getProcessDefinitionCategoryCounts(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnProcessStatsAPIApi#getProcessDefinitionCategoryCounts");
            e.printStackTrace();
        }
    }
}
HvlBpmnProcessQueryModel *body = ; // 

BpmnProcessStatsAPIApi *apiInstance = [[BpmnProcessStatsAPIApi alloc] init];

// Queries process definition category counts according to criteria in query model
[apiInstance getProcessDefinitionCategoryCountsWith:body
              completionHandler: ^(HvlResponseMapStringLong output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessStatsAPIApi()
var body = ; // {{HvlBpmnProcessQueryModel}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProcessDefinitionCategoryCounts(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getProcessDefinitionCategoryCountsExample
    {
        public void main()
        {

            var apiInstance = new BpmnProcessStatsAPIApi();
            var body = new HvlBpmnProcessQueryModel(); // HvlBpmnProcessQueryModel | 

            try
            {
                // Queries process definition category counts according to criteria in query model
                HvlResponseMapStringLong result = apiInstance.getProcessDefinitionCategoryCounts(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessStatsAPIApi.getProcessDefinitionCategoryCounts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnProcessStatsAPIApi();
$body = ; // HvlBpmnProcessQueryModel | 

try {
    $result = $api_instance->getProcessDefinitionCategoryCounts($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BpmnProcessStatsAPIApi->getProcessDefinitionCategoryCounts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BpmnProcessStatsAPIApi;

my $api_instance = WWW::SwaggerClient::BpmnProcessStatsAPIApi->new();
my $body = WWW::SwaggerClient::Object::HvlBpmnProcessQueryModel->new(); # HvlBpmnProcessQueryModel | 

eval { 
    my $result = $api_instance->getProcessDefinitionCategoryCounts(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnProcessStatsAPIApi->getProcessDefinitionCategoryCounts: $@\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.BpmnProcessStatsAPIApi()
body =  # HvlBpmnProcessQueryModel | 

try: 
    # Queries process definition category counts according to criteria in query model
    api_response = api_instance.get_process_definition_category_counts(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnProcessStatsAPIApi->getProcessDefinitionCategoryCounts: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


getProcessDefinitionInstanceCounts

Queries process definition instance counts according to criteria in query model


/process/stats/process-definition-instance-counts

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/gw/bpmn-admin-server/process/stats/process-definition-instance-counts"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessStatsAPIApi;

import java.io.File;
import java.util.*;

public class BpmnProcessStatsAPIApiExample {

    public static void main(String[] args) {
        
        BpmnProcessStatsAPIApi apiInstance = new BpmnProcessStatsAPIApi();
        HvlBpmnProcessQueryModel body = ; // HvlBpmnProcessQueryModel | 
        try {
            HvlResponseListInteger result = apiInstance.getProcessDefinitionInstanceCounts(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnProcessStatsAPIApi#getProcessDefinitionInstanceCounts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnProcessStatsAPIApi;

public class BpmnProcessStatsAPIApiExample {

    public static void main(String[] args) {
        BpmnProcessStatsAPIApi apiInstance = new BpmnProcessStatsAPIApi();
        HvlBpmnProcessQueryModel body = ; // HvlBpmnProcessQueryModel | 
        try {
            HvlResponseListInteger result = apiInstance.getProcessDefinitionInstanceCounts(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnProcessStatsAPIApi#getProcessDefinitionInstanceCounts");
            e.printStackTrace();
        }
    }
}
HvlBpmnProcessQueryModel *body = ; // 

BpmnProcessStatsAPIApi *apiInstance = [[BpmnProcessStatsAPIApi alloc] init];

// Queries process definition instance counts according to criteria in query model
[apiInstance getProcessDefinitionInstanceCountsWith:body
              completionHandler: ^(HvlResponseListInteger output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessStatsAPIApi()
var body = ; // {{HvlBpmnProcessQueryModel}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProcessDefinitionInstanceCounts(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getProcessDefinitionInstanceCountsExample
    {
        public void main()
        {

            var apiInstance = new BpmnProcessStatsAPIApi();
            var body = new HvlBpmnProcessQueryModel(); // HvlBpmnProcessQueryModel | 

            try
            {
                // Queries process definition instance counts according to criteria in query model
                HvlResponseListInteger result = apiInstance.getProcessDefinitionInstanceCounts(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessStatsAPIApi.getProcessDefinitionInstanceCounts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnProcessStatsAPIApi();
$body = ; // HvlBpmnProcessQueryModel | 

try {
    $result = $api_instance->getProcessDefinitionInstanceCounts($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BpmnProcessStatsAPIApi->getProcessDefinitionInstanceCounts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BpmnProcessStatsAPIApi;

my $api_instance = WWW::SwaggerClient::BpmnProcessStatsAPIApi->new();
my $body = WWW::SwaggerClient::Object::HvlBpmnProcessQueryModel->new(); # HvlBpmnProcessQueryModel | 

eval { 
    my $result = $api_instance->getProcessDefinitionInstanceCounts(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnProcessStatsAPIApi->getProcessDefinitionInstanceCounts: $@\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.BpmnProcessStatsAPIApi()
body =  # HvlBpmnProcessQueryModel | 

try: 
    # Queries process definition instance counts according to criteria in query model
    api_response = api_instance.get_process_definition_instance_counts(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnProcessStatsAPIApi->getProcessDefinitionInstanceCounts: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


getProcessDefinitionStatusCounts

Queries process definition status counts according to criteria in query model


/process/stats/process-definition-status-counts

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/gw/bpmn-admin-server/process/stats/process-definition-status-counts"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnProcessStatsAPIApi;

import java.io.File;
import java.util.*;

public class BpmnProcessStatsAPIApiExample {

    public static void main(String[] args) {
        
        BpmnProcessStatsAPIApi apiInstance = new BpmnProcessStatsAPIApi();
        HvlBpmnProcessQueryModel body = ; // HvlBpmnProcessQueryModel | 
        try {
            HvlResponseListInteger result = apiInstance.getProcessDefinitionStatusCounts(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnProcessStatsAPIApi#getProcessDefinitionStatusCounts");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnProcessStatsAPIApi;

public class BpmnProcessStatsAPIApiExample {

    public static void main(String[] args) {
        BpmnProcessStatsAPIApi apiInstance = new BpmnProcessStatsAPIApi();
        HvlBpmnProcessQueryModel body = ; // HvlBpmnProcessQueryModel | 
        try {
            HvlResponseListInteger result = apiInstance.getProcessDefinitionStatusCounts(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnProcessStatsAPIApi#getProcessDefinitionStatusCounts");
            e.printStackTrace();
        }
    }
}
HvlBpmnProcessQueryModel *body = ; // 

BpmnProcessStatsAPIApi *apiInstance = [[BpmnProcessStatsAPIApi alloc] init];

// Queries process definition status counts according to criteria in query model
[apiInstance getProcessDefinitionStatusCountsWith:body
              completionHandler: ^(HvlResponseListInteger output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnProcessStatsAPIApi()
var body = ; // {{HvlBpmnProcessQueryModel}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProcessDefinitionStatusCounts(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getProcessDefinitionStatusCountsExample
    {
        public void main()
        {

            var apiInstance = new BpmnProcessStatsAPIApi();
            var body = new HvlBpmnProcessQueryModel(); // HvlBpmnProcessQueryModel | 

            try
            {
                // Queries process definition status counts according to criteria in query model
                HvlResponseListInteger result = apiInstance.getProcessDefinitionStatusCounts(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnProcessStatsAPIApi.getProcessDefinitionStatusCounts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnProcessStatsAPIApi();
$body = ; // HvlBpmnProcessQueryModel | 

try {
    $result = $api_instance->getProcessDefinitionStatusCounts($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BpmnProcessStatsAPIApi->getProcessDefinitionStatusCounts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BpmnProcessStatsAPIApi;

my $api_instance = WWW::SwaggerClient::BpmnProcessStatsAPIApi->new();
my $body = WWW::SwaggerClient::Object::HvlBpmnProcessQueryModel->new(); # HvlBpmnProcessQueryModel | 

eval { 
    my $result = $api_instance->getProcessDefinitionStatusCounts(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnProcessStatsAPIApi->getProcessDefinitionStatusCounts: $@\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.BpmnProcessStatsAPIApi()
body =  # HvlBpmnProcessQueryModel | 

try: 
    # Queries process definition status counts according to criteria in query model
    api_response = api_instance.get_process_definition_status_counts(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnProcessStatsAPIApi->getProcessDefinitionStatusCounts: %s\n" % e)

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - OK


BpmnSchedulerAdminPublicAPI

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-admin-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.BpmnSchedulerAdminPublicAPIApi;

import java.io.File;
import java.util.*;

public class BpmnSchedulerAdminPublicAPIApiExample {

    public static void main(String[] args) {
        
        BpmnSchedulerAdminPublicAPIApi apiInstance = new BpmnSchedulerAdminPublicAPIApi();
         body = ; //  | 
        try {
            HvlResponseVoid result = apiInstance.finishScheduler(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnSchedulerAdminPublicAPIApi#finishScheduler");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnSchedulerAdminPublicAPIApi;

public class BpmnSchedulerAdminPublicAPIApiExample {

    public static void main(String[] args) {
        BpmnSchedulerAdminPublicAPIApi apiInstance = new BpmnSchedulerAdminPublicAPIApi();
         body = ; //  | 
        try {
            HvlResponseVoid result = apiInstance.finishScheduler(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnSchedulerAdminPublicAPIApi#finishScheduler");
            e.printStackTrace();
        }
    }
}
 *body = ; // 

BpmnSchedulerAdminPublicAPIApi *apiInstance = [[BpmnSchedulerAdminPublicAPIApi alloc] init];

// Finishs scheduler job.
[apiInstance finishSchedulerWith:body
              completionHandler: ^(HvlResponseVoid output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnSchedulerAdminPublicAPIApi()
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 BpmnSchedulerAdminPublicAPIApi();
            var body = new (); //  | 

            try
            {
                // Finishs scheduler job.
                HvlResponseVoid result = apiInstance.finishScheduler(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnSchedulerAdminPublicAPIApi.finishScheduler: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnSchedulerAdminPublicAPIApi();
$body = ; //  | 

try {
    $result = $api_instance->finishScheduler($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BpmnSchedulerAdminPublicAPIApi->finishScheduler: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BpmnSchedulerAdminPublicAPIApi;

my $api_instance = WWW::SwaggerClient::BpmnSchedulerAdminPublicAPIApi->new();
my $body = WWW::SwaggerClient::Object::->new(); #  | 

eval { 
    my $result = $api_instance->finishScheduler(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnSchedulerAdminPublicAPIApi->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.BpmnSchedulerAdminPublicAPIApi()
body =  #  | 

try: 
    # Finishs scheduler job.
    api_response = api_instance.finish_scheduler(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnSchedulerAdminPublicAPIApi->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-admin-server/scheduler/restart/{processInstanceId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnSchedulerAdminPublicAPIApi;

import java.io.File;
import java.util.*;

public class BpmnSchedulerAdminPublicAPIApiExample {

    public static void main(String[] args) {
        
        BpmnSchedulerAdminPublicAPIApi apiInstance = new BpmnSchedulerAdminPublicAPIApi();
         processInstanceId = ; //  | 
        try {
            HvlResponseHvlBpmnProcessInstanceModel result = apiInstance.restartScheduler(processInstanceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnSchedulerAdminPublicAPIApi#restartScheduler");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnSchedulerAdminPublicAPIApi;

public class BpmnSchedulerAdminPublicAPIApiExample {

    public static void main(String[] args) {
        BpmnSchedulerAdminPublicAPIApi apiInstance = new BpmnSchedulerAdminPublicAPIApi();
         processInstanceId = ; //  | 
        try {
            HvlResponseHvlBpmnProcessInstanceModel result = apiInstance.restartScheduler(processInstanceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnSchedulerAdminPublicAPIApi#restartScheduler");
            e.printStackTrace();
        }
    }
}
 *processInstanceId = ; // 

BpmnSchedulerAdminPublicAPIApi *apiInstance = [[BpmnSchedulerAdminPublicAPIApi alloc] init];

// Restarts async scheduler job.
[apiInstance restartSchedulerWith:processInstanceId
              completionHandler: ^(HvlResponseHvlBpmnProcessInstanceModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnSchedulerAdminPublicAPIApi()
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 BpmnSchedulerAdminPublicAPIApi();
            var processInstanceId = new (); //  | 

            try
            {
                // Restarts async scheduler job.
                HvlResponseHvlBpmnProcessInstanceModel result = apiInstance.restartScheduler(processInstanceId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnSchedulerAdminPublicAPIApi.restartScheduler: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnSchedulerAdminPublicAPIApi();
$processInstanceId = ; //  | 

try {
    $result = $api_instance->restartScheduler($processInstanceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BpmnSchedulerAdminPublicAPIApi->restartScheduler: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BpmnSchedulerAdminPublicAPIApi;

my $api_instance = WWW::SwaggerClient::BpmnSchedulerAdminPublicAPIApi->new();
my $processInstanceId = ; #  | 

eval { 
    my $result = $api_instance->restartScheduler(processInstanceId => $processInstanceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnSchedulerAdminPublicAPIApi->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.BpmnSchedulerAdminPublicAPIApi()
processInstanceId =  #  | 

try: 
    # Restarts async scheduler job.
    api_response = api_instance.restart_scheduler(processInstanceId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnSchedulerAdminPublicAPIApi->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-admin-server/scheduler/start/async/{overrideJob}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnSchedulerAdminPublicAPIApi;

import java.io.File;
import java.util.*;

public class BpmnSchedulerAdminPublicAPIApiExample {

    public static void main(String[] args) {
        
        BpmnSchedulerAdminPublicAPIApi apiInstance = new BpmnSchedulerAdminPublicAPIApi();
        HvlBpmnSchedulerModel body = ; // HvlBpmnSchedulerModel | 
         overrideJob = ; //  | 
        try {
            HvlResponseHvlBpmnProcessInstanceModel result = apiInstance.startAsyncScheduler(body, overrideJob);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnSchedulerAdminPublicAPIApi#startAsyncScheduler");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnSchedulerAdminPublicAPIApi;

public class BpmnSchedulerAdminPublicAPIApiExample {

    public static void main(String[] args) {
        BpmnSchedulerAdminPublicAPIApi apiInstance = new BpmnSchedulerAdminPublicAPIApi();
        HvlBpmnSchedulerModel body = ; // HvlBpmnSchedulerModel | 
         overrideJob = ; //  | 
        try {
            HvlResponseHvlBpmnProcessInstanceModel result = apiInstance.startAsyncScheduler(body, overrideJob);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnSchedulerAdminPublicAPIApi#startAsyncScheduler");
            e.printStackTrace();
        }
    }
}
HvlBpmnSchedulerModel *body = ; // 
 *overrideJob = ; // 

BpmnSchedulerAdminPublicAPIApi *apiInstance = [[BpmnSchedulerAdminPublicAPIApi 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 HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnSchedulerAdminPublicAPIApi()
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 BpmnSchedulerAdminPublicAPIApi();
            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 BpmnSchedulerAdminPublicAPIApi.startAsyncScheduler: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnSchedulerAdminPublicAPIApi();
$body = ; // HvlBpmnSchedulerModel | 
$overrideJob = ; //  | 

try {
    $result = $api_instance->startAsyncScheduler($body, $overrideJob);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BpmnSchedulerAdminPublicAPIApi->startAsyncScheduler: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BpmnSchedulerAdminPublicAPIApi;

my $api_instance = WWW::SwaggerClient::BpmnSchedulerAdminPublicAPIApi->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 BpmnSchedulerAdminPublicAPIApi->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.BpmnSchedulerAdminPublicAPIApi()
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 BpmnSchedulerAdminPublicAPIApi->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-admin-server/scheduler/start/sync/{overrideJob}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BpmnSchedulerAdminPublicAPIApi;

import java.io.File;
import java.util.*;

public class BpmnSchedulerAdminPublicAPIApiExample {

    public static void main(String[] args) {
        
        BpmnSchedulerAdminPublicAPIApi apiInstance = new BpmnSchedulerAdminPublicAPIApi();
        HvlBpmnSchedulerModel body = ; // HvlBpmnSchedulerModel | 
         overrideJob = ; //  | 
        try {
            HvlResponseHvlBpmnProcessInstanceModel result = apiInstance.startSyncScheduler(body, overrideJob);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnSchedulerAdminPublicAPIApi#startSyncScheduler");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnSchedulerAdminPublicAPIApi;

public class BpmnSchedulerAdminPublicAPIApiExample {

    public static void main(String[] args) {
        BpmnSchedulerAdminPublicAPIApi apiInstance = new BpmnSchedulerAdminPublicAPIApi();
        HvlBpmnSchedulerModel body = ; // HvlBpmnSchedulerModel | 
         overrideJob = ; //  | 
        try {
            HvlResponseHvlBpmnProcessInstanceModel result = apiInstance.startSyncScheduler(body, overrideJob);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnSchedulerAdminPublicAPIApi#startSyncScheduler");
            e.printStackTrace();
        }
    }
}
HvlBpmnSchedulerModel *body = ; // 
 *overrideJob = ; // 

BpmnSchedulerAdminPublicAPIApi *apiInstance = [[BpmnSchedulerAdminPublicAPIApi 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 HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnSchedulerAdminPublicAPIApi()
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 BpmnSchedulerAdminPublicAPIApi();
            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 BpmnSchedulerAdminPublicAPIApi.startSyncScheduler: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnSchedulerAdminPublicAPIApi();
$body = ; // HvlBpmnSchedulerModel | 
$overrideJob = ; //  | 

try {
    $result = $api_instance->startSyncScheduler($body, $overrideJob);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BpmnSchedulerAdminPublicAPIApi->startSyncScheduler: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BpmnSchedulerAdminPublicAPIApi;

my $api_instance = WWW::SwaggerClient::BpmnSchedulerAdminPublicAPIApi->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 BpmnSchedulerAdminPublicAPIApi->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.BpmnSchedulerAdminPublicAPIApi()
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 BpmnSchedulerAdminPublicAPIApi->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-admin-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 HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.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-admin-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 HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.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-admin-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 HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.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-admin-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 HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.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


getVariable

Gets the task variable.


/task/variable/{taskId}/{variableName}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"/gw/bpmn-admin-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.getVariable(taskId, variableName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnTaskPublicAPIApi#getVariable");
            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.getVariable(taskId, variableName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnTaskPublicAPIApi#getVariable");
            e.printStackTrace();
        }
    }
}
 *taskId = ; // 
 *variableName = ; // 

BpmnTaskPublicAPIApi *apiInstance = [[BpmnTaskPublicAPIApi alloc] init];

// Gets the task variable.
[apiInstance getVariableWith:taskId
    variableName:variableName
              completionHandler: ^(HvlResponseObject output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.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.getVariable(taskId, 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 BpmnTaskPublicAPIApi();
            var taskId = new (); //  | 
            var variableName = new (); //  | 

            try
            {
                // Gets the task variable.
                HvlResponseObject result = apiInstance.getVariable(taskId, variableName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnTaskPublicAPIApi.getVariable: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnTaskPublicAPIApi();
$taskId = ; //  | 
$variableName = ; //  | 

try {
    $result = $api_instance->getVariable($taskId, $variableName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BpmnTaskPublicAPIApi->getVariable: ', $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->getVariable(taskId => $taskId, variableName => $variableName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnTaskPublicAPIApi->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.BpmnTaskPublicAPIApi()
taskId =  #  | 
variableName =  #  | 

try: 
    # Gets the task variable.
    api_response = api_instance.get_variable(taskId, variableName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnTaskPublicAPIApi->getVariable: %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-admin-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 HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.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-admin-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 HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.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-admin-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 HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.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-admin-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 HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.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-admin-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 HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.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


startProcessInstanceByKey

Start process instance by process definition id.


/task/start/by-process-defitinion-key/{processDefinitionKey}

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/gw/bpmn-admin-server/task/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.BpmnTaskPublicAPIApi;

import java.io.File;
import java.util.*;

public class BpmnTaskPublicAPIApiExample {

    public static void main(String[] args) {
        
        BpmnTaskPublicAPIApi apiInstance = new BpmnTaskPublicAPIApi();
        HvlBpmnStartProcessInstanceModel body = ; // HvlBpmnStartProcessInstanceModel | 
         processDefinitionKey = ; //  | 
        try {
            HvlResponseHvlBpmnProcessInstanceModel result = apiInstance.startProcessInstanceByKey(body, processDefinitionKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnTaskPublicAPIApi#startProcessInstanceByKey");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BpmnTaskPublicAPIApi;

public class BpmnTaskPublicAPIApiExample {

    public static void main(String[] args) {
        BpmnTaskPublicAPIApi apiInstance = new BpmnTaskPublicAPIApi();
        HvlBpmnStartProcessInstanceModel body = ; // HvlBpmnStartProcessInstanceModel | 
         processDefinitionKey = ; //  | 
        try {
            HvlResponseHvlBpmnProcessInstanceModel result = apiInstance.startProcessInstanceByKey(body, processDefinitionKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BpmnTaskPublicAPIApi#startProcessInstanceByKey");
            e.printStackTrace();
        }
    }
}
HvlBpmnStartProcessInstanceModel *body = ; // 
 *processDefinitionKey = ; // 

BpmnTaskPublicAPIApi *apiInstance = [[BpmnTaskPublicAPIApi alloc] init];

// Start process instance by process definition id.
[apiInstance startProcessInstanceByKeyWith:body
    processDefinitionKey:processDefinitionKey
              completionHandler: ^(HvlResponseHvlBpmnProcessInstanceModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.BpmnTaskPublicAPIApi()
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 BpmnTaskPublicAPIApi();
            var body = new HvlBpmnStartProcessInstanceModel(); // HvlBpmnStartProcessInstanceModel | 
            var processDefinitionKey = new (); //  | 

            try
            {
                // Start process instance by process definition id.
                HvlResponseHvlBpmnProcessInstanceModel result = apiInstance.startProcessInstanceByKey(body, processDefinitionKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BpmnTaskPublicAPIApi.startProcessInstanceByKey: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBpmnTaskPublicAPIApi();
$body = ; // HvlBpmnStartProcessInstanceModel | 
$processDefinitionKey = ; //  | 

try {
    $result = $api_instance->startProcessInstanceByKey($body, $processDefinitionKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BpmnTaskPublicAPIApi->startProcessInstanceByKey: ', $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::HvlBpmnStartProcessInstanceModel->new(); # HvlBpmnStartProcessInstanceModel | 
my $processDefinitionKey = ; #  | 

eval { 
    my $result = $api_instance->startProcessInstanceByKey(body => $body, processDefinitionKey => $processDefinitionKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BpmnTaskPublicAPIApi->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.BpmnTaskPublicAPIApi()
body =  # HvlBpmnStartProcessInstanceModel | 
processDefinitionKey =  #  | 

try: 
    # Start process instance by process definition id.
    api_response = api_instance.start_process_instance_by_key(body, processDefinitionKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BpmnTaskPublicAPIApi->startProcessInstanceByKey: %s\n" % e)

Parameters

Path parameters
Name Description
processDefinitionKey*
Required
Body parameters
Name Description
body *

Responses

Status: 200 - OK


unclaim

Unclaims the task.


/task/{id}/unclaim

Usage and SDK Samples

curl -X GET\
-H "Accept: */*"\
"/gw/bpmn-admin-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 HvlBpmnAdminServer = require('hvl_bpmn_admin_server');

var api = new HvlBpmnAdminServer.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