Sign in
latestOpenAPI 3.0.32026-08-227451,2751.8 MB

d0fc0114da66

Flow

Search active reusable flow references by full-text token query.

Token-based full-text search across flow description (the flow's display name), annotated step descriptions, GenAI task summary, and labels using the Spanner SEARCH() function and idx_flow_reference_search. Returns rich per-flow rows ordered by SCORE() descending.

The query follows Spanner search syntax — multi-token queries default to AND. Callers can join keywords with " OR " for broader recall, or quote phrases.

post/flows/references/search

Query parameters

workspace_idstring required

The workspace to search in.

Request body

querystring required

Token query. Multi-token defaults to AND; join with " OR " to broaden recall (e.g., "login OR signin OR authentication"). Adjacent tokens are treated as a phrase. Empty query returns zero rows.

search_field'combined' | 'description' | 'steps' | 'task_summary' | 'labels' | 'api_endpoint' | 'api_parameters'

Which tokenized column to search. "combined" searches description+steps+task_summary+labels plus api flow url, parameter-name/value, and assertion text. Use a single field name to scope to one column. "description" is the flow's display name. "api_endpoint" scopes to api_steps request URL paths and "api_parameters" to api_steps request parameter names, each optionally paired with a truncated value (e.g. a search for "42" can match a "customerId" parameter valued "42"); both match api-type flows only — browser/mobile flows never match on them ("steps" covers their annotated step text), and flow input parameters are not searched. All fields match whole words (relevance-ranked); partial-word fragments do not match.

application_idstring

Optional. When set, returns flows used by at least one test that resolves to this application (plan membership, training-time application, or recent run history), plus reusable flows used by no test at all (returned with usage_count 0); flows used only by tests that resolve to a different application are excluded. Tests with no discoverable application association are treated as in-scope (the same resolution application-scoped test search uses), so flows used only by such tests stay findable. usage_count reflects usage within this application.

flow_type'validate_page' | 'login' | 'verify_url' | 'mablscript' | 'check_links' | 'visual_page_validation' | 'api' | 'mobile'

the type of flow

mobile_platform'android' | 'ios'

The mobile platform associated with this object

label_filterstring[]

Exact-match label filter. When set, only flows whose labels array contains every entry in this list are returned. Max 20 entries.

updated_afterstring date-time

Optional. Only return flows edited at or after this timestamp. Backed by the creation time of the flow's latest variant (every flow edit creates a new variant).

include_non_reusableboolean

When true, include non-reusable flows (inline test-step fragments) in the results. These rows rarely have descriptions and are sparsely indexed, so the default excludes them.

limitinteger required

Per-call hard limit. Capped at 200 server-side.

Response

Search results ordered by relevance score (descending).

truncatedboolean required

True if any match's steps_text was trimmed by the server-side character cap. Derived from the per-match steps_truncated flags.