Get Workflow by ID

Get workflow execution by workflow ID.

Input Payload

Attribute	Description
workflowId	The ID of the workflow whose details are to be fetched.
includeTasks	If set to true, it fetches all the task details.

API Endpoint

GET /workflow/{workflowId}

Returns nil if no workflow is found by the id.

Client SDK Methods

Java

WorkflowStatus getWorkflowStatusSummary(String workflowId, Boolean includeOutput, Boolean includeVariables)

Go

func (e *WorkflowExecutor) GetWorkflow(workflowId string, includeTasks bool) (*model.Workflow, error)

Python

## Get workflow including tasks

workflow = workflow_client.getWorkflow(workflow_id, True)

## Get workflow excluding tasks

workflow = workflow_client.getWorkflow(workflow_id, False)

C#

WorkflowStatus WorkflowResourceApi.GetWorkflowStatusSummary(string workflowId, bool? includeOutput = null, bool? includeVariables = null)

JavaScript

WorkflowExecutor.getWorkflowStatusSummary(
    workflowId: string,
    includeOutput: boolean
    includeVariables: boolean,
): CancelablePromise<WorkflowStatus>

Typescript

WorkflowExecutor.getWorkflowStatusSummary(
    workflowId: string,
    includeOutput: boolean
    includeVariables: boolean,
): CancelablePromise<WorkflowStatus>

Clojure

(workflow-resource/get-workflow [options workflow-id & {:keys [includeTasks], :or {includeTasks true}}])