githubEdit

circle-playWorkflowExecutionInfo

WorkflowExecutionInfo Type - Temporal workflow execution details

Represents detailed information about a Temporal workflow execution. This type provides comprehensive data about running and completed workflows, including execution status, timing, and associated metadata.

History is NOT included in this type for performance reasons. To retrieve workflow history events, use the dedicated workflowHistory query.

Fields

Field
Type
Description

execution

WorkflowExecution!

The workflow execution identifier containing workflowId and runId

type

WorkflowType!

The type/name of the workflow

startTime

String!

ISO 8601 timestamp when the workflow started

closeTime

String

ISO 8601 timestamp when the workflow completed (null if still running)

status

String!

Current workflow status (e.g., RUNNING, COMPLETED, FAILED, CANCELED, TERMINATED, TIMED_OUT)

historyLength

Int!

Number of events in the workflow history

parentNamespaceId

String

Namespace ID of the parent workflow (if this is a child workflow)

parentExecution

WorkflowExecution

Parent workflow execution details (if this is a child workflow)

executionTime

String

ISO 8601 timestamp of execution time

memo

WorkflowMemo

Structured metadata associated with the workflow

searchAttributes

[TemporalMetadata!]!

Searchable attributes for workflow filtering

autoResetPoints

Map

Auto-reset points for workflow recovery

taskQueue

String!

The task queue this workflow is running on

stateTransitionCount

Int!

Number of state transitions in the workflow

historySizeBytes

Int!

Size of the workflow history in bytes

mostRecentWorkerVersionStamp

Map

Version stamp of the most recent worker

executionDuration

String

Duration of the workflow execution

rootExecution

WorkflowExecution

Root workflow execution (for nested child workflows)

WorkflowExecution

Field
Type
Description

workflowId

String!

The unique workflow identifier

id

String!

The run ID for this specific execution

WorkflowType

Field
Type
Description

name

String!

The name of the workflow type

Service

This type is defined in the Workflow service.

Breaking Changes

History Field Removed

The history field has been removed from WorkflowExecutionInfo for performance reasons. Clients must now use the dedicated workflowHistory query to fetch workflow history events.

Before:

After:

Query Return Type Changed

The workflowExecutions query now returns WorkflowExecutionInfoConnection! instead of [WorkflowExecutionInfo!]!. This adds pagination support via the Relay connection pattern.

Before:

After:

Previous Breaking Change: Memo Field

The memo field type changed from Map (unstructured map[string]any) to WorkflowMemo (structured type with title, subtitle, and data fields).

Before:

After:

Usage Example

Query Workflow Executions with Pagination

Query with Multiple Filters

Query Child Workflows

Paginating Through Results

Example Response

Workflow Status Values

Status
Description

RUNNING

Workflow is currently executing

COMPLETED

Workflow completed successfully

FAILED

Workflow failed with an error

CANCELED

Workflow was canceled

TERMINATED

Workflow was forcefully terminated

TIMED_OUT

Workflow exceeded its timeout

CONTINUED_AS_NEW

Workflow continued as a new execution

Notes

  • Use workflowExecutions query to retrieve workflow execution information with pagination

  • History is NOT included - use workflowHistory query to fetch history events separately

  • The memo field provides structured metadata for display and identification purposes

  • Search attributes allow efficient filtering of workflows by custom criteria

  • Parent and root execution references help track workflow hierarchies

  • History size and length can be used to monitor workflow complexity

  • Pagination uses Temporal's NextPageToken directly for efficient cursor-based pagination

Last updated

Was this helpful?