Search Workflow Executions

Used to retrieve a list of workflow executions based on the provided search criteria.

Input Payload

Attribute	Description
start	The start of the search results list, which is used for pagination. Default value: 0
size	The number of search results that should be returned from the specified start. Default value = 100
sort	The manner in which the list will be sorted, in the format "FIELD:ASC
freeText	All full-text indexed data associated with the workflow execution (workflow input, output, and task outputs), up to a certain limit. Default value: * Note: Check with you admins to get the size limit.
query	The query expression in the format “FIELD = VALUE” or “FIELD IN (value1, value2)”. Supported fields for querying: workflowId correlationId workflowType status startTime modifiedTime Only AND operations are supported. Example queries: workflowType = your_workflow_name status IN (SCHEDULED, IN_PROGRESS) startTime >1726655978410 startTime < 1696143600000 workflowType = your_workflow_name AND status = SCHEDULED workflowId IN (3434546, 45365767, 20984885) AND workflowType = test_workflow
skipCache	Whether to skip caching. Default value: false

API Endpoint

GET /workflow/search

Client SDK Methods

Java

SearchResult<WorkflowSummary> search(Integer start, Integer size, String sort, String freeText, String query)

Go

func (e *WorkflowExecutor) Search(start int32, size int32, query string, freeText string) ([]model.WorkflowSummary, error)

Python

WorkflowResourceApi.search(self, **kwargs)

C#

ScrollableSearchResultWorkflowSummary WorkflowResourceApi.Search(string queryId = null, int? start = null, int? size = null, string sort = null, string freeText = null, string query = null, bool? skipCache = null)

JavaScript

WorkflowResourceService.search(
    start?: number,
    size: number = 100,
    sort?: string,
    freeText: string = '*',
    query?: string,
): CancelablePromise<SearchResultWorkflowSummary>

Typescript

WorkflowExecutor.search(
    start?: number,
    size: number = 100,
    sort?: string,
    freeText: string = '*',
    query?: string,
): CancelablePromise<SearchResultWorkflowSummary>

Clojure

(workflow-resource/search [options query])