From 347b400940a440c8320796e420eaef86e8ab4a48 Mon Sep 17 00:00:00 2001 From: Yaron Dayagi Date: Thu, 5 Sep 2024 15:15:16 +0300 Subject: [PATCH] feat(orchestrator): add open api documentation (#2127) FLPATH-1407 https://issues.redhat.com/browse/FLPATH-1407 make open api documentation of backend available via backend plugin Signed-off-by: Yaron Dayagi --- .../src/OrchestratorPlugin.ts | 4 + .../src/service/router.ts | 9 + plugins/orchestrator-common/package.json | 3 +- .../orchestrator-common/scripts/openapi.sh | 1 + .../src/generated/docs/html/index.html | 7393 +++++++++++++++++ 5 files changed, 7409 insertions(+), 1 deletion(-) create mode 100644 plugins/orchestrator-common/src/generated/docs/html/index.html diff --git a/plugins/orchestrator-backend/src/OrchestratorPlugin.ts b/plugins/orchestrator-backend/src/OrchestratorPlugin.ts index 1e5927c562..67b21f323b 100644 --- a/plugins/orchestrator-backend/src/OrchestratorPlugin.ts +++ b/plugins/orchestrator-backend/src/OrchestratorPlugin.ts @@ -54,6 +54,10 @@ export const orchestratorPlugin = createBackendPlugin({ path: '/health', allow: 'unauthenticated', }); + httpRouter.addAuthPolicy({ + path: '/docs', + allow: 'unauthenticated', + }); }, }); }, diff --git a/plugins/orchestrator-backend/src/service/router.ts b/plugins/orchestrator-backend/src/service/router.ts index d0e45d1293..22c3532388 100644 --- a/plugins/orchestrator-backend/src/service/router.ts +++ b/plugins/orchestrator-backend/src/service/router.ts @@ -119,6 +119,15 @@ export async function createBackendRouter( router.use(permissionsIntegrationRouter); router.use('/workflows', express.text()); router.use('/static', express.static(resolvePackagePath(pkg.name, 'static'))); + router.use( + '/docs', + express.static( + resolvePackagePath( + '@janus-idp/backstage-plugin-orchestrator-common', + 'src/generated/docs/html', + ), + ), + ); router.get('/health', (_, response) => { logger.info('PONG!'); diff --git a/plugins/orchestrator-common/package.json b/plugins/orchestrator-common/package.json index cb1c0c6f89..3507c31202 100644 --- a/plugins/orchestrator-common/package.json +++ b/plugins/orchestrator-common/package.json @@ -37,7 +37,8 @@ ], "files": [ "config.d.ts", - "dist" + "dist", + "src/generated/docs/html" ], "configSchema": "config.d.ts", "sideEffects": false, diff --git a/plugins/orchestrator-common/scripts/openapi.sh b/plugins/orchestrator-common/scripts/openapi.sh index 05af66a7e3..a712a16e96 100755 --- a/plugins/orchestrator-common/scripts/openapi.sh +++ b/plugins/orchestrator-common/scripts/openapi.sh @@ -15,6 +15,7 @@ openapi_generate() { # Docs generation npx --yes @openapitools/openapi-generator-cli@v2.13.4 generate -g markdown -i ${OPENAPI_SPEC_FILE} -o ./src/generated/docs/markdown/ + npx --yes @openapitools/openapi-generator-cli@v2.13.4 generate -g html2 -i ${OPENAPI_SPEC_FILE} -o ./src/generated/docs/html npx --yes --package=js-yaml-cli@0.6.0 -- yaml2json -f ${OPENAPI_SPEC_FILE} diff --git a/plugins/orchestrator-common/src/generated/docs/html/index.html b/plugins/orchestrator-common/src/generated/docs/html/index.html new file mode 100644 index 0000000000..99758c3ee7 --- /dev/null +++ b/plugins/orchestrator-common/src/generated/docs/html/index.html @@ -0,0 +1,7393 @@ + + + + + Orchestrator plugin + + + + + + + + + + + + + + + + + +
+
+ +
+
+
+

Orchestrator plugin

+
+
+
+ +
+
+

Default

+
+
+
+

abortWorkflow

+

Abort a workflow instance

+
+
+
+

+

Aborts a workflow instance identified by the provided instanceId.

+

+
+ 
/v2/instances/{instanceId}/abort
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X DELETE \
+ -H "Accept: text/plain,application/json" \
+ "http://localhost/v2/instances/{instanceId}/abort"
+
+
+
+ 
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        DefaultApi apiInstance = new DefaultApi();
+        String instanceId = instanceId_example; // String | The identifier of the workflow instance to abort.
+
+        try {
+            'String' result = apiInstance.abortWorkflow(instanceId);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#abortWorkflow");
+            e.printStackTrace();
+        }
+    }
+}
+
+
+ +
+ 
import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String instanceId = new String(); // String | The identifier of the workflow instance to abort.
+
+try {
+    final result = await api_instance.abortWorkflow(instanceId);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->abortWorkflow: $e\n');
+}
+
+
+
+ +
+ 
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String instanceId = instanceId_example; // String | The identifier of the workflow instance to abort.
+
+        try {
+            'String' result = apiInstance.abortWorkflow(instanceId);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#abortWorkflow");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 

+
+// Create an instance of the API class
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+String *instanceId = instanceId_example; // The identifier of the workflow instance to abort. (default to null)
+
+// Abort a workflow instance
+[apiInstance abortWorkflowWith:instanceId
+              completionHandler: ^('String' output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+
+
+ +
+ 
var OrchestratorPlugin = require('orchestrator_plugin');
+
+// Create an instance of the API class
+var api = new OrchestratorPlugin.DefaultApi()
+var instanceId = instanceId_example; // {String} The identifier of the workflow instance to abort.
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.abortWorkflow(instanceId, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class abortWorkflowExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new DefaultApi();
+            var instanceId = instanceId_example;  // String | The identifier of the workflow instance to abort. (default to null)
+
+            try {
+                // Abort a workflow instance
+                'String' result = apiInstance.abortWorkflow(instanceId);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling DefaultApi.abortWorkflow: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$instanceId = instanceId_example; // String | The identifier of the workflow instance to abort.
+
+try {
+    $result = $api_instance->abortWorkflow($instanceId);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->abortWorkflow: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $instanceId = instanceId_example; # String | The identifier of the workflow instance to abort.
+
+eval {
+    my $result = $api_instance->abortWorkflow(instanceId => $instanceId);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->abortWorkflow: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+instanceId = instanceId_example # String | The identifier of the workflow instance to abort. (default to null)
+
+try:
+    # Abort a workflow instance
+    api_response = api_instance.abort_workflow(instanceId)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->abortWorkflow: %s\n" % e)
+
+ +
+ 
extern crate DefaultApi;
+
+pub fn main() {
+    let instanceId = instanceId_example; // String
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.abortWorkflow(instanceId, &context).wait();
+
+    println!("{:?}", result);
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ +
Path parameters
+ + + + + + + + + +
NameDescription
instanceId* + + +
+
+
+ + String + + +
+The identifier of the workflow instance to abort. +
+
+
+ Required +
+
+
+
+ + + + + +

Responses

+

+

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

+

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

executeWorkflow

+

Execute a workflow

+
+
+
+

+

+

+
+ 
/v2/workflows/{workflowId}/execute
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X POST \
+ -H "Accept: application/json" \
+ -H "Content-Type: application/json" \
+ "http://localhost/v2/workflows/{workflowId}/execute" \
+ -d '{
+  "inputData" : "{}"
+}'
+
+
+
+ 
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        DefaultApi apiInstance = new DefaultApi();
+        String workflowId = workflowId_example; // String | ID of the workflow to execute
+        ExecuteWorkflowRequestDTO executeWorkflowRequestDTO = ; // ExecuteWorkflowRequestDTO | 
+
+        try {
+            ExecuteWorkflowResponseDTO result = apiInstance.executeWorkflow(workflowId, executeWorkflowRequestDTO);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#executeWorkflow");
+            e.printStackTrace();
+        }
+    }
+}
+
+
+ +
+ 
import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String workflowId = new String(); // String | ID of the workflow to execute
+final ExecuteWorkflowRequestDTO executeWorkflowRequestDTO = new ExecuteWorkflowRequestDTO(); // ExecuteWorkflowRequestDTO | 
+
+try {
+    final result = await api_instance.executeWorkflow(workflowId, executeWorkflowRequestDTO);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->executeWorkflow: $e\n');
+}
+
+
+
+ +
+ 
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String workflowId = workflowId_example; // String | ID of the workflow to execute
+        ExecuteWorkflowRequestDTO executeWorkflowRequestDTO = ; // ExecuteWorkflowRequestDTO | 
+
+        try {
+            ExecuteWorkflowResponseDTO result = apiInstance.executeWorkflow(workflowId, executeWorkflowRequestDTO);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#executeWorkflow");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 

+
+// Create an instance of the API class
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+String *workflowId = workflowId_example; // ID of the workflow to execute (default to null)
+ExecuteWorkflowRequestDTO *executeWorkflowRequestDTO = ; // 
+
+// Execute a workflow
+[apiInstance executeWorkflowWith:workflowId
+    executeWorkflowRequestDTO:executeWorkflowRequestDTO
+              completionHandler: ^(ExecuteWorkflowResponseDTO output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+
+
+ +
+ 
var OrchestratorPlugin = require('orchestrator_plugin');
+
+// Create an instance of the API class
+var api = new OrchestratorPlugin.DefaultApi()
+var workflowId = workflowId_example; // {String} ID of the workflow to execute
+var executeWorkflowRequestDTO = ; // {ExecuteWorkflowRequestDTO} 
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.executeWorkflow(workflowId, executeWorkflowRequestDTO, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class executeWorkflowExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new DefaultApi();
+            var workflowId = workflowId_example;  // String | ID of the workflow to execute (default to null)
+            var executeWorkflowRequestDTO = new ExecuteWorkflowRequestDTO(); // ExecuteWorkflowRequestDTO | 
+
+            try {
+                // Execute a workflow
+                ExecuteWorkflowResponseDTO result = apiInstance.executeWorkflow(workflowId, executeWorkflowRequestDTO);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling DefaultApi.executeWorkflow: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$workflowId = workflowId_example; // String | ID of the workflow to execute
+$executeWorkflowRequestDTO = ; // ExecuteWorkflowRequestDTO | 
+
+try {
+    $result = $api_instance->executeWorkflow($workflowId, $executeWorkflowRequestDTO);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->executeWorkflow: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $workflowId = workflowId_example; # String | ID of the workflow to execute
+my $executeWorkflowRequestDTO = WWW::OPenAPIClient::Object::ExecuteWorkflowRequestDTO->new(); # ExecuteWorkflowRequestDTO | 
+
+eval {
+    my $result = $api_instance->executeWorkflow(workflowId => $workflowId, executeWorkflowRequestDTO => $executeWorkflowRequestDTO);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->executeWorkflow: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+workflowId = workflowId_example # String | ID of the workflow to execute (default to null)
+executeWorkflowRequestDTO =  # ExecuteWorkflowRequestDTO | 
+
+try:
+    # Execute a workflow
+    api_response = api_instance.execute_workflow(workflowId, executeWorkflowRequestDTO)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->executeWorkflow: %s\n" % e)
+
+ +
+ 
extern crate DefaultApi;
+
+pub fn main() {
+    let workflowId = workflowId_example; // String
+    let executeWorkflowRequestDTO = ; // ExecuteWorkflowRequestDTO
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.executeWorkflow(workflowId, executeWorkflowRequestDTO, &context).wait();
+
+    println!("{:?}", result);
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ +
Path parameters
+ + + + + + + + + +
NameDescription
workflowId* + + +
+
+
+ + String + + +
+ID of the workflow to execute +
+
+
+ Required +
+
+
+
+ + +
Body parameters
+ + + + + + + + + +
NameDescription
executeWorkflowRequestDTO * +

+ +
+
+ + + +

Responses

+

+

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

+

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

getInstanceById

+

Get Workflow Instance by ID

+
+
+
+

+

+

+
+ 
/v2/workflows/instances/{instanceId}
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X GET \
+ -H "Accept: application/json" \
+ "http://localhost/v2/workflows/instances/{instanceId}?includeAssessment=true"
+
+
+
+ 
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        DefaultApi apiInstance = new DefaultApi();
+        String instanceId = instanceId_example; // String | ID of the workflow instance
+        Boolean includeAssessment = true; // Boolean | Whether to include assessment
+
+        try {
+            AssessedProcessInstanceDTO result = apiInstance.getInstanceById(instanceId, includeAssessment);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#getInstanceById");
+            e.printStackTrace();
+        }
+    }
+}
+
+
+ +
+ 
import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String instanceId = new String(); // String | ID of the workflow instance
+final Boolean includeAssessment = new Boolean(); // Boolean | Whether to include assessment
+
+try {
+    final result = await api_instance.getInstanceById(instanceId, includeAssessment);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getInstanceById: $e\n');
+}
+
+
+
+ +
+ 
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String instanceId = instanceId_example; // String | ID of the workflow instance
+        Boolean includeAssessment = true; // Boolean | Whether to include assessment
+
+        try {
+            AssessedProcessInstanceDTO result = apiInstance.getInstanceById(instanceId, includeAssessment);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#getInstanceById");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 

+
+// Create an instance of the API class
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+String *instanceId = instanceId_example; // ID of the workflow instance (default to null)
+Boolean *includeAssessment = true; // Whether to include assessment (optional) (default to false)
+
+// Get Workflow Instance by ID
+[apiInstance getInstanceByIdWith:instanceId
+    includeAssessment:includeAssessment
+              completionHandler: ^(AssessedProcessInstanceDTO output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+
+
+ +
+ 
var OrchestratorPlugin = require('orchestrator_plugin');
+
+// Create an instance of the API class
+var api = new OrchestratorPlugin.DefaultApi()
+var instanceId = instanceId_example; // {String} ID of the workflow instance
+var opts = {
+  'includeAssessment': true // {Boolean} Whether to include assessment
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.getInstanceById(instanceId, opts, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class getInstanceByIdExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new DefaultApi();
+            var instanceId = instanceId_example;  // String | ID of the workflow instance (default to null)
+            var includeAssessment = true;  // Boolean | Whether to include assessment (optional)  (default to false)
+
+            try {
+                // Get Workflow Instance by ID
+                AssessedProcessInstanceDTO result = apiInstance.getInstanceById(instanceId, includeAssessment);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling DefaultApi.getInstanceById: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$instanceId = instanceId_example; // String | ID of the workflow instance
+$includeAssessment = true; // Boolean | Whether to include assessment
+
+try {
+    $result = $api_instance->getInstanceById($instanceId, $includeAssessment);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->getInstanceById: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $instanceId = instanceId_example; # String | ID of the workflow instance
+my $includeAssessment = true; # Boolean | Whether to include assessment
+
+eval {
+    my $result = $api_instance->getInstanceById(instanceId => $instanceId, includeAssessment => $includeAssessment);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->getInstanceById: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+instanceId = instanceId_example # String | ID of the workflow instance (default to null)
+includeAssessment = true # Boolean | Whether to include assessment (optional) (default to false)
+
+try:
+    # Get Workflow Instance by ID
+    api_response = api_instance.get_instance_by_id(instanceId, includeAssessment=includeAssessment)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->getInstanceById: %s\n" % e)
+
+ +
+ 
extern crate DefaultApi;
+
+pub fn main() {
+    let instanceId = instanceId_example; // String
+    let includeAssessment = true; // Boolean
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.getInstanceById(instanceId, includeAssessment, &context).wait();
+
+    println!("{:?}", result);
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ +
Path parameters
+ + + + + + + + + +
NameDescription
instanceId* + + +
+
+
+ + String + + +
+ID of the workflow instance +
+
+
+ Required +
+
+
+
+ + + + +
Query parameters
+ + + + + + + + + +
NameDescription
includeAssessment + + +
+
+
+ + Boolean + + +
+Whether to include assessment +
+
+
+
+
+ +

Responses

+

+

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

+

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

getInstances

+

Get instances

+
+
+
+

+

Retrieve an array of instances

+

+
+ 
/v2/workflows/instances
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X POST \
+ -H "Accept: application/json" \
+ -H "Content-Type: application/json" \
+ "http://localhost/v2/workflows/instances" \
+ -d '{
+  "paginationInfo" : {
+    "offset" : 5.962133916683182,
+    "pageSize" : 1.4658129805029452,
+    "orderDirection" : "ASC",
+    "orderBy" : "orderBy",
+    "totalCount" : 5.637376656633329
+  },
+  "filterInfo" : {
+    "fieldName" : "fieldName",
+    "fieldValue" : "FilterValue"
+  }
+}'
+
+
+
+ 
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        DefaultApi apiInstance = new DefaultApi();
+        GetInstancesRequestParams getInstancesRequestParams = ; // GetInstancesRequestParams | 
+
+        try {
+            ProcessInstanceListResultDTO result = apiInstance.getInstances(getInstancesRequestParams);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#getInstances");
+            e.printStackTrace();
+        }
+    }
+}
+
+
+ +
+ 
import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final GetInstancesRequestParams getInstancesRequestParams = new GetInstancesRequestParams(); // GetInstancesRequestParams | 
+
+try {
+    final result = await api_instance.getInstances(getInstancesRequestParams);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getInstances: $e\n');
+}
+
+
+
+ +
+ 
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        GetInstancesRequestParams getInstancesRequestParams = ; // GetInstancesRequestParams | 
+
+        try {
+            ProcessInstanceListResultDTO result = apiInstance.getInstances(getInstancesRequestParams);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#getInstances");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 

+
+// Create an instance of the API class
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+GetInstancesRequestParams *getInstancesRequestParams = ; //  (optional)
+
+// Get instances
+[apiInstance getInstancesWith:getInstancesRequestParams
+              completionHandler: ^(ProcessInstanceListResultDTO output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+
+
+ +
+ 
var OrchestratorPlugin = require('orchestrator_plugin');
+
+// Create an instance of the API class
+var api = new OrchestratorPlugin.DefaultApi()
+var opts = {
+  'getInstancesRequestParams':  // {GetInstancesRequestParams} 
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.getInstances(opts, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class getInstancesExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new DefaultApi();
+            var getInstancesRequestParams = new GetInstancesRequestParams(); // GetInstancesRequestParams |  (optional) 
+
+            try {
+                // Get instances
+                ProcessInstanceListResultDTO result = apiInstance.getInstances(getInstancesRequestParams);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling DefaultApi.getInstances: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$getInstancesRequestParams = ; // GetInstancesRequestParams | 
+
+try {
+    $result = $api_instance->getInstances($getInstancesRequestParams);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->getInstances: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $getInstancesRequestParams = WWW::OPenAPIClient::Object::GetInstancesRequestParams->new(); # GetInstancesRequestParams | 
+
+eval {
+    my $result = $api_instance->getInstances(getInstancesRequestParams => $getInstancesRequestParams);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->getInstances: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+getInstancesRequestParams =  # GetInstancesRequestParams |  (optional)
+
+try:
+    # Get instances
+    api_response = api_instance.get_instances(getInstancesRequestParams=getInstancesRequestParams)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->getInstances: %s\n" % e)
+
+ +
+ 
extern crate DefaultApi;
+
+pub fn main() {
+    let getInstancesRequestParams = ; // GetInstancesRequestParams
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.getInstances(getInstancesRequestParams, &context).wait();
+
+    println!("{:?}", result);
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + +
Body parameters
+ + + + + + + + + +
NameDescription
getInstancesRequestParams +

Parameters for retrieving instances

+ +
+
+ + + +

Responses

+

+

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

+

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

getWorkflowById

+

+
+
+
+

+

Get a workflow by ID

+

+
+ 
/v2/workflows/{workflowId}
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X GET \
+ -H "Accept: application/json" \
+ "http://localhost/v2/workflows/{workflowId}"
+
+
+
+ 
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        DefaultApi apiInstance = new DefaultApi();
+        String workflowId = workflowId_example; // String | ID of the workflow to fetch
+
+        try {
+            WorkflowDTO result = apiInstance.getWorkflowById(workflowId);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#getWorkflowById");
+            e.printStackTrace();
+        }
+    }
+}
+
+
+ +
+ 
import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String workflowId = new String(); // String | ID of the workflow to fetch
+
+try {
+    final result = await api_instance.getWorkflowById(workflowId);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getWorkflowById: $e\n');
+}
+
+
+
+ +
+ 
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String workflowId = workflowId_example; // String | ID of the workflow to fetch
+
+        try {
+            WorkflowDTO result = apiInstance.getWorkflowById(workflowId);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#getWorkflowById");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 

+
+// Create an instance of the API class
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+String *workflowId = workflowId_example; // ID of the workflow to fetch (default to null)
+
+[apiInstance getWorkflowByIdWith:workflowId
+              completionHandler: ^(WorkflowDTO output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+
+
+ +
+ 
var OrchestratorPlugin = require('orchestrator_plugin');
+
+// Create an instance of the API class
+var api = new OrchestratorPlugin.DefaultApi()
+var workflowId = workflowId_example; // {String} ID of the workflow to fetch
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.getWorkflowById(workflowId, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class getWorkflowByIdExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new DefaultApi();
+            var workflowId = workflowId_example;  // String | ID of the workflow to fetch (default to null)
+
+            try {
+                WorkflowDTO result = apiInstance.getWorkflowById(workflowId);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling DefaultApi.getWorkflowById: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$workflowId = workflowId_example; // String | ID of the workflow to fetch
+
+try {
+    $result = $api_instance->getWorkflowById($workflowId);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->getWorkflowById: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $workflowId = workflowId_example; # String | ID of the workflow to fetch
+
+eval {
+    my $result = $api_instance->getWorkflowById(workflowId => $workflowId);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->getWorkflowById: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+workflowId = workflowId_example # String | ID of the workflow to fetch (default to null)
+
+try:
+    api_response = api_instance.get_workflow_by_id(workflowId)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->getWorkflowById: %s\n" % e)
+
+ +
+ 
extern crate DefaultApi;
+
+pub fn main() {
+    let workflowId = workflowId_example; // String
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.getWorkflowById(workflowId, &context).wait();
+
+    println!("{:?}", result);
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ +
Path parameters
+ + + + + + + + + +
NameDescription
workflowId* + + +
+
+
+ + String + + +
+ID of the workflow to fetch +
+
+
+ Required +
+
+
+
+ + + + + +

Responses

+

+

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

+

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

getWorkflowInputSchemaById

+

+
+
+
+

+

Get a workflow input schema by ID

+

+
+ 
/v2/workflows/{workflowId}/inputSchema
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X GET \
+ -H "Accept: application/json" \
+ "http://localhost/v2/workflows/{workflowId}/inputSchema?instanceId=instanceId_example"
+
+
+
+ 
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        DefaultApi apiInstance = new DefaultApi();
+        String workflowId = workflowId_example; // String | ID of the workflow to fetch
+        String instanceId = instanceId_example; // String | ID of instance
+
+        try {
+            Object result = apiInstance.getWorkflowInputSchemaById(workflowId, instanceId);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#getWorkflowInputSchemaById");
+            e.printStackTrace();
+        }
+    }
+}
+
+
+ +
+ 
import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String workflowId = new String(); // String | ID of the workflow to fetch
+final String instanceId = new String(); // String | ID of instance
+
+try {
+    final result = await api_instance.getWorkflowInputSchemaById(workflowId, instanceId);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getWorkflowInputSchemaById: $e\n');
+}
+
+
+
+ +
+ 
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String workflowId = workflowId_example; // String | ID of the workflow to fetch
+        String instanceId = instanceId_example; // String | ID of instance
+
+        try {
+            Object result = apiInstance.getWorkflowInputSchemaById(workflowId, instanceId);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#getWorkflowInputSchemaById");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 

+
+// Create an instance of the API class
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+String *workflowId = workflowId_example; // ID of the workflow to fetch (default to null)
+String *instanceId = instanceId_example; // ID of instance (optional) (default to null)
+
+[apiInstance getWorkflowInputSchemaByIdWith:workflowId
+    instanceId:instanceId
+              completionHandler: ^(Object output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+
+
+ +
+ 
var OrchestratorPlugin = require('orchestrator_plugin');
+
+// Create an instance of the API class
+var api = new OrchestratorPlugin.DefaultApi()
+var workflowId = workflowId_example; // {String} ID of the workflow to fetch
+var opts = {
+  'instanceId': instanceId_example // {String} ID of instance
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.getWorkflowInputSchemaById(workflowId, opts, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class getWorkflowInputSchemaByIdExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new DefaultApi();
+            var workflowId = workflowId_example;  // String | ID of the workflow to fetch (default to null)
+            var instanceId = instanceId_example;  // String | ID of instance (optional)  (default to null)
+
+            try {
+                Object result = apiInstance.getWorkflowInputSchemaById(workflowId, instanceId);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling DefaultApi.getWorkflowInputSchemaById: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$workflowId = workflowId_example; // String | ID of the workflow to fetch
+$instanceId = instanceId_example; // String | ID of instance
+
+try {
+    $result = $api_instance->getWorkflowInputSchemaById($workflowId, $instanceId);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->getWorkflowInputSchemaById: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $workflowId = workflowId_example; # String | ID of the workflow to fetch
+my $instanceId = instanceId_example; # String | ID of instance
+
+eval {
+    my $result = $api_instance->getWorkflowInputSchemaById(workflowId => $workflowId, instanceId => $instanceId);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->getWorkflowInputSchemaById: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+workflowId = workflowId_example # String | ID of the workflow to fetch (default to null)
+instanceId = instanceId_example # String | ID of instance (optional) (default to null)
+
+try:
+    api_response = api_instance.get_workflow_input_schema_by_id(workflowId, instanceId=instanceId)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->getWorkflowInputSchemaById: %s\n" % e)
+
+ +
+ 
extern crate DefaultApi;
+
+pub fn main() {
+    let workflowId = workflowId_example; // String
+    let instanceId = instanceId_example; // String
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.getWorkflowInputSchemaById(workflowId, instanceId, &context).wait();
+
+    println!("{:?}", result);
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ +
Path parameters
+ + + + + + + + + +
NameDescription
workflowId* + + +
+
+
+ + String + + +
+ID of the workflow to fetch +
+
+
+ Required +
+
+
+
+ + + + +
Query parameters
+ + + + + + + + + +
NameDescription
instanceId + + +
+
+
+ + String + + +
+ID of instance +
+
+
+
+
+ +

Responses

+

+

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

+

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

getWorkflowOverviewById

+

+
+
+
+

+

Get a workflow overview by ID

+

+
+ 
/v2/workflows/{workflowId}/overview
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X GET \
+ -H "Accept: application/json" \
+ "http://localhost/v2/workflows/{workflowId}/overview"
+
+
+
+ 
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        DefaultApi apiInstance = new DefaultApi();
+        String workflowId = workflowId_example; // String | Unique identifier of the workflow
+
+        try {
+            WorkflowOverviewDTO result = apiInstance.getWorkflowOverviewById(workflowId);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#getWorkflowOverviewById");
+            e.printStackTrace();
+        }
+    }
+}
+
+
+ +
+ 
import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String workflowId = new String(); // String | Unique identifier of the workflow
+
+try {
+    final result = await api_instance.getWorkflowOverviewById(workflowId);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getWorkflowOverviewById: $e\n');
+}
+
+
+
+ +
+ 
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String workflowId = workflowId_example; // String | Unique identifier of the workflow
+
+        try {
+            WorkflowOverviewDTO result = apiInstance.getWorkflowOverviewById(workflowId);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#getWorkflowOverviewById");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 

+
+// Create an instance of the API class
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+String *workflowId = workflowId_example; // Unique identifier of the workflow (default to null)
+
+[apiInstance getWorkflowOverviewByIdWith:workflowId
+              completionHandler: ^(WorkflowOverviewDTO output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+
+
+ +
+ 
var OrchestratorPlugin = require('orchestrator_plugin');
+
+// Create an instance of the API class
+var api = new OrchestratorPlugin.DefaultApi()
+var workflowId = workflowId_example; // {String} Unique identifier of the workflow
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.getWorkflowOverviewById(workflowId, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class getWorkflowOverviewByIdExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new DefaultApi();
+            var workflowId = workflowId_example;  // String | Unique identifier of the workflow (default to null)
+
+            try {
+                WorkflowOverviewDTO result = apiInstance.getWorkflowOverviewById(workflowId);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling DefaultApi.getWorkflowOverviewById: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$workflowId = workflowId_example; // String | Unique identifier of the workflow
+
+try {
+    $result = $api_instance->getWorkflowOverviewById($workflowId);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->getWorkflowOverviewById: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $workflowId = workflowId_example; # String | Unique identifier of the workflow
+
+eval {
+    my $result = $api_instance->getWorkflowOverviewById(workflowId => $workflowId);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->getWorkflowOverviewById: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+workflowId = workflowId_example # String | Unique identifier of the workflow (default to null)
+
+try:
+    api_response = api_instance.get_workflow_overview_by_id(workflowId)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->getWorkflowOverviewById: %s\n" % e)
+
+ +
+ 
extern crate DefaultApi;
+
+pub fn main() {
+    let workflowId = workflowId_example; // String
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.getWorkflowOverviewById(workflowId, &context).wait();
+
+    println!("{:?}", result);
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ +
Path parameters
+ + + + + + + + + +
NameDescription
workflowId* + + +
+
+
+ + String + + +
+Unique identifier of the workflow +
+
+
+ Required +
+
+
+
+ + + + + +

Responses

+

+

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

+

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

getWorkflowSourceById

+

+
+
+
+

+

Get a workflow source by ID

+

+
+ 
/v2/workflows/{workflowId}/source
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X GET \
+ -H "Accept: text/plain,application/json" \
+ "http://localhost/v2/workflows/{workflowId}/source"
+
+
+
+ 
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        DefaultApi apiInstance = new DefaultApi();
+        String workflowId = workflowId_example; // String | ID of the workflow to fetch
+
+        try {
+            'String' result = apiInstance.getWorkflowSourceById(workflowId);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#getWorkflowSourceById");
+            e.printStackTrace();
+        }
+    }
+}
+
+
+ +
+ 
import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final String workflowId = new String(); // String | ID of the workflow to fetch
+
+try {
+    final result = await api_instance.getWorkflowSourceById(workflowId);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getWorkflowSourceById: $e\n');
+}
+
+
+
+ +
+ 
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        String workflowId = workflowId_example; // String | ID of the workflow to fetch
+
+        try {
+            'String' result = apiInstance.getWorkflowSourceById(workflowId);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#getWorkflowSourceById");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 

+
+// Create an instance of the API class
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+String *workflowId = workflowId_example; // ID of the workflow to fetch (default to null)
+
+[apiInstance getWorkflowSourceByIdWith:workflowId
+              completionHandler: ^('String' output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+
+
+ +
+ 
var OrchestratorPlugin = require('orchestrator_plugin');
+
+// Create an instance of the API class
+var api = new OrchestratorPlugin.DefaultApi()
+var workflowId = workflowId_example; // {String} ID of the workflow to fetch
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.getWorkflowSourceById(workflowId, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class getWorkflowSourceByIdExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new DefaultApi();
+            var workflowId = workflowId_example;  // String | ID of the workflow to fetch (default to null)
+
+            try {
+                'String' result = apiInstance.getWorkflowSourceById(workflowId);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling DefaultApi.getWorkflowSourceById: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$workflowId = workflowId_example; // String | ID of the workflow to fetch
+
+try {
+    $result = $api_instance->getWorkflowSourceById($workflowId);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->getWorkflowSourceById: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $workflowId = workflowId_example; # String | ID of the workflow to fetch
+
+eval {
+    my $result = $api_instance->getWorkflowSourceById(workflowId => $workflowId);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->getWorkflowSourceById: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+workflowId = workflowId_example # String | ID of the workflow to fetch (default to null)
+
+try:
+    api_response = api_instance.get_workflow_source_by_id(workflowId)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->getWorkflowSourceById: %s\n" % e)
+
+ +
+ 
extern crate DefaultApi;
+
+pub fn main() {
+    let workflowId = workflowId_example; // String
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.getWorkflowSourceById(workflowId, &context).wait();
+
+    println!("{:?}", result);
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ +
Path parameters
+ + + + + + + + + +
NameDescription
workflowId* + + +
+
+
+ + String + + +
+ID of the workflow to fetch +
+
+
+ Required +
+
+
+
+ + + + + +

Responses

+

+

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

+

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

getWorkflowStatuses

+

Get workflow status list

+
+
+
+

+

Retrieve an array of workflow statuses

+

+
+ 
/v2/workflows/instances/statuses
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X GET \
+ -H "Accept: application/json" \
+ "http://localhost/v2/workflows/instances/statuses"
+
+
+
+ 
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        DefaultApi apiInstance = new DefaultApi();
+
+        try {
+            array[WorkflowRunStatusDTO] result = apiInstance.getWorkflowStatuses();
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#getWorkflowStatuses");
+            e.printStackTrace();
+        }
+    }
+}
+
+
+ +
+ 
import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+
+try {
+    final result = await api_instance.getWorkflowStatuses();
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getWorkflowStatuses: $e\n');
+}
+
+
+
+ +
+ 
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+
+        try {
+            array[WorkflowRunStatusDTO] result = apiInstance.getWorkflowStatuses();
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#getWorkflowStatuses");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 

+
+// Create an instance of the API class
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+
+// Get workflow status list
+[apiInstance getWorkflowStatusesWithCompletionHandler: 
+              ^(array[WorkflowRunStatusDTO] output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+
+
+ +
+ 
var OrchestratorPlugin = require('orchestrator_plugin');
+
+// Create an instance of the API class
+var api = new OrchestratorPlugin.DefaultApi()
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.getWorkflowStatuses(callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class getWorkflowStatusesExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new DefaultApi();
+
+            try {
+                // Get workflow status list
+                array[WorkflowRunStatusDTO] result = apiInstance.getWorkflowStatuses();
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling DefaultApi.getWorkflowStatuses: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+
+try {
+    $result = $api_instance->getWorkflowStatuses();
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->getWorkflowStatuses: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+
+eval {
+    my $result = $api_instance->getWorkflowStatuses();
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->getWorkflowStatuses: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+
+try:
+    # Get workflow status list
+    api_response = api_instance.get_workflow_statuses()
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->getWorkflowStatuses: %s\n" % e)
+
+ +
+ 
extern crate DefaultApi;
+
+pub fn main() {
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.getWorkflowStatuses(&context).wait();
+
+    println!("{:?}", result);
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + + + + +

Responses

+

+

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

+

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

getWorkflowsOverview

+

+
+
+
+

+

Get a list of workflow overviews

+

+
+ 
/v2/workflows/overview
+

+

Usage and SDK Samples

+

+ + +
+
+ 
curl -X POST \
+ -H "Accept: application/json" \
+ -H "Content-Type: application/json" \
+ "http://localhost/v2/workflows/overview" \
+ -d '{
+  "paginationInfo" : {
+    "offset" : 5.962133916683182,
+    "pageSize" : 1.4658129805029452,
+    "orderDirection" : "ASC",
+    "orderBy" : "orderBy",
+    "totalCount" : 5.637376656633329
+  },
+  "filterInfo" : {
+    "fieldName" : "fieldName",
+    "fieldValue" : "FilterValue"
+  }
+}'
+
+
+
+ 
import org.openapitools.client.*;
+import org.openapitools.client.auth.*;
+import org.openapitools.client.model.*;
+import org.openapitools.client.api.DefaultApi;
+
+import java.io.File;
+import java.util.*;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+
+        // Create an instance of the API class
+        DefaultApi apiInstance = new DefaultApi();
+        GetOverviewsRequestParams getOverviewsRequestParams = ; // GetOverviewsRequestParams | 
+
+        try {
+            WorkflowOverviewListResultDTO result = apiInstance.getWorkflowsOverview(getOverviewsRequestParams);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#getWorkflowsOverview");
+            e.printStackTrace();
+        }
+    }
+}
+
+
+ +
+ 
import 'package:openapi/api.dart';
+
+final api_instance = DefaultApi();
+
+final GetOverviewsRequestParams getOverviewsRequestParams = new GetOverviewsRequestParams(); // GetOverviewsRequestParams | 
+
+try {
+    final result = await api_instance.getWorkflowsOverview(getOverviewsRequestParams);
+    print(result);
+} catch (e) {
+    print('Exception when calling DefaultApi->getWorkflowsOverview: $e\n');
+}
+
+
+
+ +
+ 
import org.openapitools.client.api.DefaultApi;
+
+public class DefaultApiExample {
+    public static void main(String[] args) {
+        DefaultApi apiInstance = new DefaultApi();
+        GetOverviewsRequestParams getOverviewsRequestParams = ; // GetOverviewsRequestParams | 
+
+        try {
+            WorkflowOverviewListResultDTO result = apiInstance.getWorkflowsOverview(getOverviewsRequestParams);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling DefaultApi#getWorkflowsOverview");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+ 

+
+// Create an instance of the API class
+DefaultApi *apiInstance = [[DefaultApi alloc] init];
+GetOverviewsRequestParams *getOverviewsRequestParams = ; //  (optional)
+
+[apiInstance getWorkflowsOverviewWith:getOverviewsRequestParams
+              completionHandler: ^(WorkflowOverviewListResultDTO output, NSError* error) {
+    if (output) {
+        NSLog(@"%@", output);
+    }
+    if (error) {
+        NSLog(@"Error: %@", error);
+    }
+}];
+
+
+ +
+ 
var OrchestratorPlugin = require('orchestrator_plugin');
+
+// Create an instance of the API class
+var api = new OrchestratorPlugin.DefaultApi()
+var opts = {
+  'getOverviewsRequestParams':  // {GetOverviewsRequestParams} 
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.getWorkflowsOverview(opts, callback);
+
+
+ + +
+ 
using System;
+using System.Diagnostics;
+using Org.OpenAPITools.Api;
+using Org.OpenAPITools.Client;
+using Org.OpenAPITools.Model;
+
+namespace Example
+{
+    public class getWorkflowsOverviewExample
+    {
+        public void main()
+        {
+
+            // Create an instance of the API class
+            var apiInstance = new DefaultApi();
+            var getOverviewsRequestParams = new GetOverviewsRequestParams(); // GetOverviewsRequestParams |  (optional) 
+
+            try {
+                WorkflowOverviewListResultDTO result = apiInstance.getWorkflowsOverview(getOverviewsRequestParams);
+                Debug.WriteLine(result);
+            } catch (Exception e) {
+                Debug.Print("Exception when calling DefaultApi.getWorkflowsOverview: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+ 
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+// Create an instance of the API class
+$api_instance = new OpenAPITools\Client\Api\DefaultApi();
+$getOverviewsRequestParams = ; // GetOverviewsRequestParams | 
+
+try {
+    $result = $api_instance->getWorkflowsOverview($getOverviewsRequestParams);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling DefaultApi->getWorkflowsOverview: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+ 
use Data::Dumper;
+use WWW::OPenAPIClient::Configuration;
+use WWW::OPenAPIClient::DefaultApi;
+
+# Create an instance of the API class
+my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
+my $getOverviewsRequestParams = WWW::OPenAPIClient::Object::GetOverviewsRequestParams->new(); # GetOverviewsRequestParams | 
+
+eval {
+    my $result = $api_instance->getWorkflowsOverview(getOverviewsRequestParams => $getOverviewsRequestParams);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling DefaultApi->getWorkflowsOverview: $@\n";
+}
+
+ +
+ 
from __future__ import print_statement
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Create an instance of the API class
+api_instance = openapi_client.DefaultApi()
+getOverviewsRequestParams =  # GetOverviewsRequestParams |  (optional)
+
+try:
+    api_response = api_instance.get_workflows_overview(getOverviewsRequestParams=getOverviewsRequestParams)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling DefaultApi->getWorkflowsOverview: %s\n" % e)
+
+ +
+ 
extern crate DefaultApi;
+
+pub fn main() {
+    let getOverviewsRequestParams = ; // GetOverviewsRequestParams
+
+    let mut context = DefaultApi::Context::default();
+    let result = client.getWorkflowsOverview(getOverviewsRequestParams, &context).wait();
+
+    println!("{:?}", result);
+}
+
+
+
+ +

Scopes

+ + +
+ +

Parameters

+ + + +
Body parameters
+ + + + + + + + + +
NameDescription
getOverviewsRequestParams +

Parameters for retrieving of workflow overviews

+ +
+
+ + + +

Responses

+

+

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

+

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