Get Workflows by Correlation ID

With the list of correlation IDs, this API helps in finding and returning workflows.

Input Payload

Attribute	Description
name	The name of the workflow for which the correlated workflow is to be fetched.

API Endpoint

POST /workflow/{name}/correlated

Returns a map with key as correlationId and value as a list of Workflows. When IncludeClosed is set to true, the return value also includes workflows that are completed; otherwise, only running workflows are returned,

Client SDK Methods

Java

Map<String, List<Workflow>> getWorkflowsByNamesAndCorrelationIds(List<String> correlationIds, List<String> workflowNames, Boolean includeClosed, Boolean includeTasks)

Go

func (e *WorkflowExecutor) GetByCorrelationIds(workflowName string, includeClosed bool, includeTasks bool, correlationIds ...string) (map[string][]model.Workflow, error)

Python

WorkflowResourceApi.get_workflows(self, body, name, **kwargs)

C#

string WorkflowResourceApi.StartWorkflow(StartWorkflowRequest body)

JavaScript

WorkflowResourceService.getWorkflow1(
    name: string,
    correlationId: string,
    includeClosed: boolean = false,
    includeTasks: boolean = false,
): CancelablePromise<Record<string, Array<Workflow>>>

Typescript

WorkflowResourceService.getWorkflow1(
    name: string,
    correlationId: string,
    includeClosed: boolean = false,
    includeTasks: boolean = false,
): CancelablePromise<Record<string, Array<Workflow>>>

Clojure

(workflow-resource/get-workflows [options wf-name correlation-id o-options])