Synchronous Execution

Starts a workflow and waits until the workflow completes or the waitUntilTask completes.

Input Payload

Attribute	Description
name	Name of the workflow to be executed.
version	Choose the required version of the workflow.

API Endpoint

POST /api/workflow/execute/{name}/{version}

Returns the output of the workflow.

Client SDK Methods

Java

CompletableFuture<WorkflowRun> executeWorkflow(StartWorkflowRequest request, String waitUntilTask)

Go

func (e *WorkflowExecutor) ExecuteWorkflow(startWorkflowRequest *model.StartWorkflowRequest, waitUntilTask string) (run *model.WorkflowRun, err error)

Python

WorkflowResourceApi.execute_workflow(self, body, request_id, name, version, **kwargs)

C#

WorkflowRun WorkflowResourceApi.ExecuteWorkflow(StartWorkflowRequest body, string requestId, string name, int? version, string waitUntilTaskRef = null)

JavaScript

WorkflowExecutor.executeWorkflow(
    workflowRequest: StartWorkflowRequest,
    name: string,
    version: number,
    requestId: string,
    waitUntilTaskRef: string = '',
  ): Promise<WorkflowRun>

Typescript

WorkflowExecutor.executeWorkflow(
    workflowRequest: StartWorkflowRequest,
    name: string,
    version: number,
    requestId: string,
    waitUntilTaskRef: string = '',
  ): Promise<WorkflowRun>

Clojure

(run-workflow-sync [options name version requestId {}])