From 9a3841eadc588c3b3f50f2351b741edd139ca13c Mon Sep 17 00:00:00 2001 From: seshukm Date: Fri, 30 Nov 2018 13:24:01 +0800 Subject: [PATCH] Add the monitoring interfaces Issue-ID: SO-1230 Change-Id: Ic0ed949f9238d263effe706ef22e2266e0d22d49 Signed-off-by: seshukm --- docs/api/swagger/SO_MONITORING_SWAGGER.html | 4650 +++++++++++++++++++++++++++ 1 file changed, 4650 insertions(+) create mode 100644 docs/api/swagger/SO_MONITORING_SWAGGER.html diff --git a/docs/api/swagger/SO_MONITORING_SWAGGER.html b/docs/api/swagger/SO_MONITORING_SWAGGER.html new file mode 100644 index 0000000000..fe85ab6bd1 --- /dev/null +++ b/docs/api/swagger/SO_MONITORING_SWAGGER.html @@ -0,0 +1,4650 @@ + + + + + SO Monitoring APIs + + + + + + + + + + + + + + + + + +
+
+ +
+
+
+

SO Monitoring APIs

+
+
+
+ +
+
+

GetActivityInstanceDetail

+
+
+
+

getActivityInstanceDetail

+

Get activity instance details for given process instance ID

+
+
+
+

+

+

+
+ 
/so/monitoring/activity-instance/{processInstanceId}
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X GET "http://localhost/so/monitoring/activity-instance/{processInstanceId}"
+
+
+ 
import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import io.swagger.client.api.GetActivityInstanceDetailApi;
+
+import java.io.File;
+import java.util.*;
+
+public class GetActivityInstanceDetailApiExample {
+
+    public static void main(String[] args) {
+        
+        GetActivityInstanceDetailApi apiInstance = new GetActivityInstanceDetailApi();
+        String processInstanceId = processInstanceId_example; // String | 
+        try {
+            array[inline_response_200_3] result = apiInstance.getActivityInstanceDetail(processInstanceId);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling GetActivityInstanceDetailApi#getActivityInstanceDetail");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
import io.swagger.client.api.GetActivityInstanceDetailApi;
+
+public class GetActivityInstanceDetailApiExample {
+
+    public static void main(String[] args) {
+        GetActivityInstanceDetailApi apiInstance = new GetActivityInstanceDetailApi();
+        String processInstanceId = processInstanceId_example; // String | 
+        try {
+            array[inline_response_200_3] result = apiInstance.getActivityInstanceDetail(processInstanceId);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling GetActivityInstanceDetailApi#getActivityInstanceDetail");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
String *processInstanceId = processInstanceId_example; // 
+
+GetActivityInstanceDetailApi *apiInstance = [[GetActivityInstanceDetailApi alloc] init];
+
+// Get activity instance details for given process instance ID
+[apiInstance getActivityInstanceDetailWith:processInstanceId
+              completionHandler: ^(array[inline_response_200_3] output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+ 
var SoMonitoringApIs = require('so_monitoring_ap_is');
+
+var api = new SoMonitoringApIs.GetActivityInstanceDetailApi()
+
+var processInstanceId = processInstanceId_example; // {String} 
+
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.getActivityInstanceDetail(processInstanceId, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using IO.Swagger.Api;
+using IO.Swagger.Client;
+using IO.Swagger.Model;
+
+namespace Example
+{
+    public class getActivityInstanceDetailExample
+    {
+        public void main()
+        {
+            
+            var apiInstance = new GetActivityInstanceDetailApi();
+            var processInstanceId = processInstanceId_example;  // String | 
+
+            try
+            {
+                // Get activity instance details for given process instance ID
+                array[inline_response_200_3] result = apiInstance.getActivityInstanceDetail(processInstanceId);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling GetActivityInstanceDetailApi.getActivityInstanceDetail: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new Swagger\Client\Api\GetActivityInstanceDetailApi();
+$processInstanceId = processInstanceId_example; // String | 
+
+try {
+    $result = $api_instance->getActivityInstanceDetail($processInstanceId);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling GetActivityInstanceDetailApi->getActivityInstanceDetail: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::SwaggerClient::Configuration;
+use WWW::SwaggerClient::GetActivityInstanceDetailApi;
+
+my $api_instance = WWW::SwaggerClient::GetActivityInstanceDetailApi->new();
+my $processInstanceId = processInstanceId_example; # String | 
+
+eval { 
+    my $result = $api_instance->getActivityInstanceDetail(processInstanceId => $processInstanceId);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling GetActivityInstanceDetailApi->getActivityInstanceDetail: $@\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.GetActivityInstanceDetailApi()
+processInstanceId = processInstanceId_example # String | 
+
+try: 
+    # Get activity instance details for given process instance ID
+    api_response = api_instance.get_activity_instance_detail(processInstanceId)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling GetActivityInstanceDetailApi->getActivityInstanceDetail: %s\n" % e)
+
+
+ +

Parameters

+ +
Path parameters
+ + + + + + + + + +
NameDescription
processInstanceId* + + +
+
+
+ + String + + +
+
+ Required +
+
+
+
+ + + + + +

Responses

+

Status: 200 - A ActivityInstanceDetail object

+ + + +
+
+
+ +
+ +
+
+ +

Status: 204 - Unable to find process instance variables for given process instance ID.

+ +
    +
+ +
+
+ +

Status: 400 - Unable to find process instance variables for given process instance ID.

+ +
    +
+ +
+
+ +

Status: 500 - Unable to find process instance variables for given process instance ID.

+ +
    +
+ +
+
+ +
+
+
+
+
+

GetInfraActiveRequests

+
+
+
+

getInfraActiveRequests

+

Search infra active request for given parameter map and parameters

+
+
+
+

+

+

+
+ 
/so/monitoring/v1/search
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X POST "http://localhost/so/monitoring/v1/search?from=&to=&maxResult="
+
+
+ 
import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import io.swagger.client.api.GetInfraActiveRequestsApi;
+
+import java.io.File;
+import java.util.*;
+
+public class GetInfraActiveRequestsApiExample {
+
+    public static void main(String[] args) {
+        
+        GetInfraActiveRequestsApi apiInstance = new GetInfraActiveRequestsApi();
+        Object filters = ; // Object | 
+        BigDecimal from = 8.14; // BigDecimal | 
+        BigDecimal to = 8.14; // BigDecimal | 
+        BigDecimal maxResult = 8.14; // BigDecimal | 
+        try {
+            array[inline_response_200_5] result = apiInstance.getInfraActiveRequests(filters, from, to, maxResult);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling GetInfraActiveRequestsApi#getInfraActiveRequests");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
import io.swagger.client.api.GetInfraActiveRequestsApi;
+
+public class GetInfraActiveRequestsApiExample {
+
+    public static void main(String[] args) {
+        GetInfraActiveRequestsApi apiInstance = new GetInfraActiveRequestsApi();
+        Object filters = ; // Object | 
+        BigDecimal from = 8.14; // BigDecimal | 
+        BigDecimal to = 8.14; // BigDecimal | 
+        BigDecimal maxResult = 8.14; // BigDecimal | 
+        try {
+            array[inline_response_200_5] result = apiInstance.getInfraActiveRequests(filters, from, to, maxResult);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling GetInfraActiveRequestsApi#getInfraActiveRequests");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
Object *filters = ; // 
+BigDecimal *from = 8.14; // 
+BigDecimal *to = 8.14; // 
+BigDecimal *maxResult = 8.14; //  (optional)
+
+GetInfraActiveRequestsApi *apiInstance = [[GetInfraActiveRequestsApi alloc] init];
+
+// Search infra active request for given parameter map and parameters
+[apiInstance getInfraActiveRequestsWith:filters
+    from:from
+    to:to
+    maxResult:maxResult
+              completionHandler: ^(array[inline_response_200_5] output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+ 
var SoMonitoringApIs = require('so_monitoring_ap_is');
+
+var api = new SoMonitoringApIs.GetInfraActiveRequestsApi()
+
+var filters = ; // {Object} 
+
+var from = 8.14; // {BigDecimal} 
+
+var to = 8.14; // {BigDecimal} 
+
+var opts = { 
+  'maxResult': 8.14 // {BigDecimal} 
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.getInfraActiveRequests(filters, from, to, opts, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using IO.Swagger.Api;
+using IO.Swagger.Client;
+using IO.Swagger.Model;
+
+namespace Example
+{
+    public class getInfraActiveRequestsExample
+    {
+        public void main()
+        {
+            
+            var apiInstance = new GetInfraActiveRequestsApi();
+            var filters = new Object(); // Object | 
+            var from = 8.14;  // BigDecimal | 
+            var to = 8.14;  // BigDecimal | 
+            var maxResult = 8.14;  // BigDecimal |  (optional) 
+
+            try
+            {
+                // Search infra active request for given parameter map and parameters
+                array[inline_response_200_5] result = apiInstance.getInfraActiveRequests(filters, from, to, maxResult);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling GetInfraActiveRequestsApi.getInfraActiveRequests: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new Swagger\Client\Api\GetInfraActiveRequestsApi();
+$filters = ; // Object | 
+$from = 8.14; // BigDecimal | 
+$to = 8.14; // BigDecimal | 
+$maxResult = 8.14; // BigDecimal | 
+
+try {
+    $result = $api_instance->getInfraActiveRequests($filters, $from, $to, $maxResult);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling GetInfraActiveRequestsApi->getInfraActiveRequests: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::SwaggerClient::Configuration;
+use WWW::SwaggerClient::GetInfraActiveRequestsApi;
+
+my $api_instance = WWW::SwaggerClient::GetInfraActiveRequestsApi->new();
+my $filters = WWW::SwaggerClient::Object::Object->new(); # Object | 
+my $from = 8.14; # BigDecimal | 
+my $to = 8.14; # BigDecimal | 
+my $maxResult = 8.14; # BigDecimal | 
+
+eval { 
+    my $result = $api_instance->getInfraActiveRequests(filters => $filters, from => $from, to => $to, maxResult => $maxResult);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling GetInfraActiveRequestsApi->getInfraActiveRequests: $@\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.GetInfraActiveRequestsApi()
+filters =  # Object | 
+from = 8.14 # BigDecimal | 
+to = 8.14 # BigDecimal | 
+maxResult = 8.14 # BigDecimal |  (optional)
+
+try: 
+    # Search infra active request for given parameter map and parameters
+    api_response = api_instance.get_infra_active_requests(filters, from, to, maxResult=maxResult)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling GetInfraActiveRequestsApi->getInfraActiveRequests: %s\n" % e)
+
+
+ +

Parameters

+ + + +
Body parameters
+ + + + + + + + + +
NameDescription
filters * + + + +
+
+ + +
Query parameters
+ + + + + + + + + + + + + + + + + +
NameDescription
from* + + +
+
+
+ + BigDecimal + + +
+
+ Required +
+
+
+
to* + + +
+
+
+ + BigDecimal + + +
+
+ Required +
+
+
+
maxResult + + +
+
+
+ + BigDecimal + + +
+
+
+
+ +

Responses

+

Status: 200 - A SoInfraRequest object

+ + + +
+
+
+ +
+ +
+
+ +

Status: 204 - Unable to find search request for given filter and parameters.

+ +
    +
+ +
+
+ +

Status: 400 - Unable to find search request for given filter and parameters

+ +
    +
+ +
+
+ +

Status: 500 - Unable to find search request for given filter and parameters

+ +
    +
+ +
+
+ +
+
+
+
+
+

GetProcessDefinitionXml

+
+
+
+

getProcessDefinitionXml

+

Get process definition for given process definition ID

+
+
+
+

+

+

+
+ 
/so/monitoring/process-definition/{processDefinitionId}
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X GET "http://localhost/so/monitoring/process-definition/{processDefinitionId}"
+
+
+ 
import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import io.swagger.client.api.GetProcessDefinitionXmlApi;
+
+import java.io.File;
+import java.util.*;
+
+public class GetProcessDefinitionXmlApiExample {
+
+    public static void main(String[] args) {
+        
+        GetProcessDefinitionXmlApi apiInstance = new GetProcessDefinitionXmlApi();
+        String processDefinitionId = processDefinitionId_example; // String | 
+        try {
+            inline_response_200_2 result = apiInstance.getProcessDefinitionXml(processDefinitionId);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling GetProcessDefinitionXmlApi#getProcessDefinitionXml");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
import io.swagger.client.api.GetProcessDefinitionXmlApi;
+
+public class GetProcessDefinitionXmlApiExample {
+
+    public static void main(String[] args) {
+        GetProcessDefinitionXmlApi apiInstance = new GetProcessDefinitionXmlApi();
+        String processDefinitionId = processDefinitionId_example; // String | 
+        try {
+            inline_response_200_2 result = apiInstance.getProcessDefinitionXml(processDefinitionId);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling GetProcessDefinitionXmlApi#getProcessDefinitionXml");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
String *processDefinitionId = processDefinitionId_example; // 
+
+GetProcessDefinitionXmlApi *apiInstance = [[GetProcessDefinitionXmlApi alloc] init];
+
+// Get process definition for given process definition ID
+[apiInstance getProcessDefinitionXmlWith:processDefinitionId
+              completionHandler: ^(inline_response_200_2 output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+ 
var SoMonitoringApIs = require('so_monitoring_ap_is');
+
+var api = new SoMonitoringApIs.GetProcessDefinitionXmlApi()
+
+var processDefinitionId = processDefinitionId_example; // {String} 
+
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.getProcessDefinitionXml(processDefinitionId, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using IO.Swagger.Api;
+using IO.Swagger.Client;
+using IO.Swagger.Model;
+
+namespace Example
+{
+    public class getProcessDefinitionXmlExample
+    {
+        public void main()
+        {
+            
+            var apiInstance = new GetProcessDefinitionXmlApi();
+            var processDefinitionId = processDefinitionId_example;  // String | 
+
+            try
+            {
+                // Get process definition for given process definition ID
+                inline_response_200_2 result = apiInstance.getProcessDefinitionXml(processDefinitionId);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling GetProcessDefinitionXmlApi.getProcessDefinitionXml: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new Swagger\Client\Api\GetProcessDefinitionXmlApi();
+$processDefinitionId = processDefinitionId_example; // String | 
+
+try {
+    $result = $api_instance->getProcessDefinitionXml($processDefinitionId);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling GetProcessDefinitionXmlApi->getProcessDefinitionXml: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::SwaggerClient::Configuration;
+use WWW::SwaggerClient::GetProcessDefinitionXmlApi;
+
+my $api_instance = WWW::SwaggerClient::GetProcessDefinitionXmlApi->new();
+my $processDefinitionId = processDefinitionId_example; # String | 
+
+eval { 
+    my $result = $api_instance->getProcessDefinitionXml(processDefinitionId => $processDefinitionId);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling GetProcessDefinitionXmlApi->getProcessDefinitionXml: $@\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.GetProcessDefinitionXmlApi()
+processDefinitionId = processDefinitionId_example # String | 
+
+try: 
+    # Get process definition for given process definition ID
+    api_response = api_instance.get_process_definition_xml(processDefinitionId)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling GetProcessDefinitionXmlApi->getProcessDefinitionXml: %s\n" % e)
+
+
+ +

Parameters

+ +
Path parameters
+ + + + + + + + + +
NameDescription
processDefinitionId* + + +
+
+
+ + String + + +
+
+ Required +
+
+
+
+ + + + + +

Responses

+

Status: 200 - A ProcessDefinitionDetail object

+ + + +
+
+
+ +
+ +
+
+ +

Status: 204 - Unable to find process definition xml for given process definition ID.

+ +
    +
+ +
+
+ +

Status: 400 - Unable to find process definition xml for given process definition ID.

+ +
    +
+ +
+
+ +

Status: 500 - Unable to find process definition xml for given process definition ID.

+ +
    +
+ +
+
+ +
+
+
+
+
+

GetProcessInstanceId

+
+
+
+

getProcessInstanceId

+

Get process instance ID for given request ID

+
+
+
+

+

+

+
+ 
/so/monitoring/process-instance-id/{requestId}
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X GET "http://localhost/so/monitoring/process-instance-id/{requestId}"
+
+
+ 
import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import io.swagger.client.api.GetProcessInstanceIdApi;
+
+import java.io.File;
+import java.util.*;
+
+public class GetProcessInstanceIdApiExample {
+
+    public static void main(String[] args) {
+        
+        GetProcessInstanceIdApi apiInstance = new GetProcessInstanceIdApi();
+        String requestId = requestId_example; // String | 
+        try {
+            inline_response_200 result = apiInstance.getProcessInstanceId(requestId);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling GetProcessInstanceIdApi#getProcessInstanceId");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
import io.swagger.client.api.GetProcessInstanceIdApi;
+
+public class GetProcessInstanceIdApiExample {
+
+    public static void main(String[] args) {
+        GetProcessInstanceIdApi apiInstance = new GetProcessInstanceIdApi();
+        String requestId = requestId_example; // String | 
+        try {
+            inline_response_200 result = apiInstance.getProcessInstanceId(requestId);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling GetProcessInstanceIdApi#getProcessInstanceId");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
String *requestId = requestId_example; // 
+
+GetProcessInstanceIdApi *apiInstance = [[GetProcessInstanceIdApi alloc] init];
+
+// Get process instance ID for given request ID
+[apiInstance getProcessInstanceIdWith:requestId
+              completionHandler: ^(inline_response_200 output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+ 
var SoMonitoringApIs = require('so_monitoring_ap_is');
+
+var api = new SoMonitoringApIs.GetProcessInstanceIdApi()
+
+var requestId = requestId_example; // {String} 
+
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.getProcessInstanceId(requestId, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using IO.Swagger.Api;
+using IO.Swagger.Client;
+using IO.Swagger.Model;
+
+namespace Example
+{
+    public class getProcessInstanceIdExample
+    {
+        public void main()
+        {
+            
+            var apiInstance = new GetProcessInstanceIdApi();
+            var requestId = requestId_example;  // String | 
+
+            try
+            {
+                // Get process instance ID for given request ID
+                inline_response_200 result = apiInstance.getProcessInstanceId(requestId);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling GetProcessInstanceIdApi.getProcessInstanceId: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new Swagger\Client\Api\GetProcessInstanceIdApi();
+$requestId = requestId_example; // String | 
+
+try {
+    $result = $api_instance->getProcessInstanceId($requestId);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling GetProcessInstanceIdApi->getProcessInstanceId: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::SwaggerClient::Configuration;
+use WWW::SwaggerClient::GetProcessInstanceIdApi;
+
+my $api_instance = WWW::SwaggerClient::GetProcessInstanceIdApi->new();
+my $requestId = requestId_example; # String | 
+
+eval { 
+    my $result = $api_instance->getProcessInstanceId(requestId => $requestId);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling GetProcessInstanceIdApi->getProcessInstanceId: $@\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.GetProcessInstanceIdApi()
+requestId = requestId_example # String | 
+
+try: 
+    # Get process instance ID for given request ID
+    api_response = api_instance.get_process_instance_id(requestId)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling GetProcessInstanceIdApi->getProcessInstanceId: %s\n" % e)
+
+
+ +

Parameters

+ +
Path parameters
+ + + + + + + + + +
NameDescription
requestId* + + +
+
+
+ + String + + +
+
+ Required +
+
+
+
+ + + + + +

Responses

+

Status: 200 - A ProcessInstanceIdDetail object

+ + + +
+
+
+ +
+ +
+
+ +

Status: 204 - Unable to find process instance id for given request ID.

+ +
    +
+ +
+
+ +

Status: 400 - Unable to find process instance id for given request ID.

+ +
    +
+ +
+
+ +

Status: 500 - Unable to find process instance id for given request ID.

+ +
    +
+ +
+
+ +
+
+
+
+
+

GetProcessInstanceVariables

+
+
+
+

getProcessInstanceVariables

+

Get process instance variables for given process instance ID

+
+
+
+

+

+

+
+ 
/so/monitoring/variable-instance/{processInstanceId}
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X GET "http://localhost/so/monitoring/variable-instance/{processInstanceId}"
+
+
+ 
import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import io.swagger.client.api.GetProcessInstanceVariablesApi;
+
+import java.io.File;
+import java.util.*;
+
+public class GetProcessInstanceVariablesApiExample {
+
+    public static void main(String[] args) {
+        
+        GetProcessInstanceVariablesApi apiInstance = new GetProcessInstanceVariablesApi();
+        String processInstanceId = processInstanceId_example; // String | 
+        try {
+            inline_response_200_4 result = apiInstance.getProcessInstanceVariables(processInstanceId);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling GetProcessInstanceVariablesApi#getProcessInstanceVariables");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
import io.swagger.client.api.GetProcessInstanceVariablesApi;
+
+public class GetProcessInstanceVariablesApiExample {
+
+    public static void main(String[] args) {
+        GetProcessInstanceVariablesApi apiInstance = new GetProcessInstanceVariablesApi();
+        String processInstanceId = processInstanceId_example; // String | 
+        try {
+            inline_response_200_4 result = apiInstance.getProcessInstanceVariables(processInstanceId);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling GetProcessInstanceVariablesApi#getProcessInstanceVariables");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
String *processInstanceId = processInstanceId_example; // 
+
+GetProcessInstanceVariablesApi *apiInstance = [[GetProcessInstanceVariablesApi alloc] init];
+
+// Get process instance variables for given process instance ID
+[apiInstance getProcessInstanceVariablesWith:processInstanceId
+              completionHandler: ^(inline_response_200_4 output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+ 
var SoMonitoringApIs = require('so_monitoring_ap_is');
+
+var api = new SoMonitoringApIs.GetProcessInstanceVariablesApi()
+
+var processInstanceId = processInstanceId_example; // {String} 
+
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.getProcessInstanceVariables(processInstanceId, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using IO.Swagger.Api;
+using IO.Swagger.Client;
+using IO.Swagger.Model;
+
+namespace Example
+{
+    public class getProcessInstanceVariablesExample
+    {
+        public void main()
+        {
+            
+            var apiInstance = new GetProcessInstanceVariablesApi();
+            var processInstanceId = processInstanceId_example;  // String | 
+
+            try
+            {
+                // Get process instance variables for given process instance ID
+                inline_response_200_4 result = apiInstance.getProcessInstanceVariables(processInstanceId);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling GetProcessInstanceVariablesApi.getProcessInstanceVariables: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new Swagger\Client\Api\GetProcessInstanceVariablesApi();
+$processInstanceId = processInstanceId_example; // String | 
+
+try {
+    $result = $api_instance->getProcessInstanceVariables($processInstanceId);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling GetProcessInstanceVariablesApi->getProcessInstanceVariables: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::SwaggerClient::Configuration;
+use WWW::SwaggerClient::GetProcessInstanceVariablesApi;
+
+my $api_instance = WWW::SwaggerClient::GetProcessInstanceVariablesApi->new();
+my $processInstanceId = processInstanceId_example; # String | 
+
+eval { 
+    my $result = $api_instance->getProcessInstanceVariables(processInstanceId => $processInstanceId);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling GetProcessInstanceVariablesApi->getProcessInstanceVariables: $@\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.GetProcessInstanceVariablesApi()
+processInstanceId = processInstanceId_example # String | 
+
+try: 
+    # Get process instance variables for given process instance ID
+    api_response = api_instance.get_process_instance_variables(processInstanceId)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling GetProcessInstanceVariablesApi->getProcessInstanceVariables: %s\n" % e)
+
+
+ +

Parameters

+ +
Path parameters
+ + + + + + + + + +
NameDescription
processInstanceId* + + +
+
+
+ + String + + +
+
+ Required +
+
+
+
+ + + + + +

Responses

+

Status: 200 - A ProcessInstanceVariableDetail object

+ + + +
+
+
+ +
+ +
+
+ +

Status: 204 - Unable to find activity instance for given process instance ID.

+ +
    +
+ +
+
+ +

Status: 400 - Unable to find activity instance for given process instance ID.

+ +
    +
+ +
+
+ +

Status: 500 - Unable to find activity instance for given process instance ID.

+ +
    +
+ +
+
+ +
+
+
+
+
+

GetSingleProcessInstance

+
+
+
+

getSingleProcessInstance

+

Get process instance for given process instance ID

+
+
+
+

+

+

+
+ 
/so/monitoring/process-instance/{processInstanceId}
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X GET "http://localhost/so/monitoring/process-instance/{processInstanceId}"
+
+
+ 
import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import io.swagger.client.api.GetSingleProcessInstanceApi;
+
+import java.io.File;
+import java.util.*;
+
+public class GetSingleProcessInstanceApiExample {
+
+    public static void main(String[] args) {
+        
+        GetSingleProcessInstanceApi apiInstance = new GetSingleProcessInstanceApi();
+        String processInstanceId = processInstanceId_example; // String | 
+        try {
+            inline_response_200_1 result = apiInstance.getSingleProcessInstance(processInstanceId);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling GetSingleProcessInstanceApi#getSingleProcessInstance");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
import io.swagger.client.api.GetSingleProcessInstanceApi;
+
+public class GetSingleProcessInstanceApiExample {
+
+    public static void main(String[] args) {
+        GetSingleProcessInstanceApi apiInstance = new GetSingleProcessInstanceApi();
+        String processInstanceId = processInstanceId_example; // String | 
+        try {
+            inline_response_200_1 result = apiInstance.getSingleProcessInstance(processInstanceId);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling GetSingleProcessInstanceApi#getSingleProcessInstance");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 
String *processInstanceId = processInstanceId_example; // 
+
+GetSingleProcessInstanceApi *apiInstance = [[GetSingleProcessInstanceApi alloc] init];
+
+// Get process instance for given process instance ID
+[apiInstance getSingleProcessInstanceWith:processInstanceId
+              completionHandler: ^(inline_response_200_1 output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+ 
var SoMonitoringApIs = require('so_monitoring_ap_is');
+
+var api = new SoMonitoringApIs.GetSingleProcessInstanceApi()
+
+var processInstanceId = processInstanceId_example; // {String} 
+
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.getSingleProcessInstance(processInstanceId, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using IO.Swagger.Api;
+using IO.Swagger.Client;
+using IO.Swagger.Model;
+
+namespace Example
+{
+    public class getSingleProcessInstanceExample
+    {
+        public void main()
+        {
+            
+            var apiInstance = new GetSingleProcessInstanceApi();
+            var processInstanceId = processInstanceId_example;  // String | 
+
+            try
+            {
+                // Get process instance for given process instance ID
+                inline_response_200_1 result = apiInstance.getSingleProcessInstance(processInstanceId);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling GetSingleProcessInstanceApi.getSingleProcessInstance: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new Swagger\Client\Api\GetSingleProcessInstanceApi();
+$processInstanceId = processInstanceId_example; // String | 
+
+try {
+    $result = $api_instance->getSingleProcessInstance($processInstanceId);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling GetSingleProcessInstanceApi->getSingleProcessInstance: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::SwaggerClient::Configuration;
+use WWW::SwaggerClient::GetSingleProcessInstanceApi;
+
+my $api_instance = WWW::SwaggerClient::GetSingleProcessInstanceApi->new();
+my $processInstanceId = processInstanceId_example; # String | 
+
+eval { 
+    my $result = $api_instance->getSingleProcessInstance(processInstanceId => $processInstanceId);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling GetSingleProcessInstanceApi->getSingleProcessInstance: $@\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.GetSingleProcessInstanceApi()
+processInstanceId = processInstanceId_example # String | 
+
+try: 
+    # Get process instance for given process instance ID
+    api_response = api_instance.get_single_process_instance(processInstanceId)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling GetSingleProcessInstanceApi->getSingleProcessInstance: %s\n" % e)
+
+
+ +

Parameters

+ +
Path parameters
+ + + + + + + + + +
NameDescription
processInstanceId* + + +
+
+
+ + String + + +
+
+ Required +
+
+
+
+ + + + + +

Responses

+

Status: 200 - A ProcessInstanceDetail object

+ + + +
+
+
+ +
+ +
+
+ +

Status: 204 - Unable to find process instance for given process instance ID.

+ +
    +
+ +
+
+ +

Status: 400 - Unable to find process instance for given process instance ID.

+ +
    +
+ +
+
+ +

Status: 500 - Unable to find process instance for given process instance ID.

+ +
    +
+ +
+
+ +
+
+
+
+
+ +
+
+ Generated 2018-11-19T03:21:44.307Z +
+
+
+
+
+ + + + + + + + + + + + + + -- 2.16.6