WorkflowExecutionHistoryConnection

WorkflowExecutionHistoryConnection Type - Paginated workflow history results

Audience: Programmer

A connection type for paginated access to workflow execution history. This type follows the Relay connection specification and is returned by the workflowHistory query.

Fields

Field	Type	Description
edges	[WorkflowExecutionHistoryEdge!]!	List of workflow execution history edges
pageInfo	WorkflowPageInfo!	Information for pagination
totalCount	Int!	Total number of matching workflow executions

Related Types

WorkflowExecutionHistoryEdge

Field	Type	Description
node	WorkflowExecutionHistory!	The workflow execution with its history
cursor	String!	Cursor for use in pagination

WorkflowPageInfo

Field	Type	Description
hasNextPage	Boolean!	Whether there are more items after this page
hasPreviousPage	Boolean!	Whether there are more items before this page
startCursor	String	Cursor of the first item
endCursor	String	Cursor of the last item

Service

This type is defined in the Workflow service.

Usage Example

Query with Pagination

query {
  workflowHistory(
    where: {
      typeName: "PickingWorkflow"
      status: "COMPLETED"
    }
    limit: 10
  ) {
    edges {
      node {
        execution {
          workflowId
          id
        }
        typeName
        history {
          eventId
          eventType
          eventTime
        }
      }
      cursor
    }
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
    }
    totalCount
  }
}

Example Response

{
  "data": {
    "workflowHistory": {
      "edges": [
        {
          "node": {
            "execution": {
              "workflowId": "picking-order-12345",
              "id": "run-abc-123"
            },
            "typeName": "PickingWorkflow",
            "history": [
              {
                "eventId": 1,
                "eventType": "EVENT_TYPE_WORKFLOW_EXECUTION_STARTED",
                "eventTime": "2024-01-15T10:30:00Z"
              },
              {
                "eventId": 2,
                "eventType": "EVENT_TYPE_WORKFLOW_EXECUTION_COMPLETED",
                "eventTime": "2024-01-15T10:35:00Z"
              }
            ]
          },
          "cursor": "eyJ3b3JrZmxvd0lkIjoicGlja2luZy1vcmRlci0xMjM0NSJ9"
        }
      ],
      "pageInfo": {
        "hasNextPage": true,
        "hasPreviousPage": false,
        "startCursor": "eyJ3b3JrZmxvd0lkIjoicGlja2luZy1vcmRlci0xMjM0NSJ9",
        "endCursor": "eyJ3b3JrZmxvd0lkIjoicGlja2luZy1vcmRlci0xMjM0NSJ9"
      },
      "totalCount": 25
    }
  }
}

Notes

• This connection type wraps WorkflowExecutionHistory objects

• The limit parameter on workflowHistory controls the number of executions returned

• Each execution includes its complete history (no pagination within an execution's history)

• Use totalCount to determine the total number of matching executions

Related Documentation

• workflowHistory Query - Query that returns this connection type

• WorkflowExecutionHistory - The node type in this connection

• WorkflowEvent - History event type

• WorkflowExecutionInfoConnection - Similar connection for execution info