Search for Workflow Executions

Used to search for workflow executions.

Input Payload

Attribute	Description
Start	Indicates the start index, which is used for pagination.
Size	Indicates the number of results to return.
Query	The query expression in the format FIELD = 'VALUE' or FIELD IN (value1, value2). Only AND operations are supported. E.g., workflowId IN ('a', 'b', 'c') AND workflowType ='test_workflow' AND startTime BETWEEN 1000 and 2000. Supported fields for Query are: workflowId,correlationId, taskId, workflowType, taskType, status, startTime and modifiedTime.
FreeText	All the workflow input, output, and task outputs up to a certain limit (check with your admins to find the size limit) are full-text indexed and can be used to search.

API Endpoint

GET /workflow/search

Client SDK Methods

Java

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

Golang

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

Python

WorkflowResourceApi.search(self, **kwargs)

CSharp

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