Get Workflow by ID

Get workflow execution by workflow ID. If includeTasks is set, it also fetches all the task details.

Input Payload

Attribute	Description
name	The name of the workflow whose details are to be fetched.

API Endpoint

GET /workflow/{name}

Returns nil if no workflow is found by the id.

Client SDK Methods

Java

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

Golang

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

Python

WorkflowResourceApi.get_execution_status(self, workflow_id, **kwargs)

CSharp

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}}])