Sign in
latestOpenAPI 3.0.32026-08-227451,2751.8 MB

d0fc0114da66

Flow

Get flow

Used to retrieve a flow by ID

get/flows/{id}

Path parameters

idstring required

The ID of the flow to retrieve

Query parameters

sourceControlTagstring

A source control tag to retrieve the version of the flow for

Response

The flow with the given ID

idstring

Unique identifier

created_by_idstring

The ID of the user who created this test

last_updated_timeinteger

Time the test was last updated in epoch milliseconds

last_updated_by_idstring

The ID of the user who last updated this test

created_timeinteger

Time the test was created in epoch milliseconds

revision_historystring

Serialized graph describing the test's version history. Managed by mabl API only.

version_tagsobject

Mapping of version tags to version numbers that the tag is currently applied to

latest_versioninteger

The latest numeric version of this test

organization_idstring

(deprecated) The ID of the organization that this journey belongs to

workspace_idstring

Workspace Id

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

the type of flow

reusableboolean

Indicates whether this can be used by multiple tests

descriptionstring

Summary of the flow

source_control_tagsobject

mapping of tags to version numbers the tag is currently applied to

import_source_id'postman' | 'selenium_node_proxy' | 'selenium_java_agent'
import_source_versionstring

Version of the import tool used to import this flow

mobile_platform'android' | 'ios'

The mobile platform associated with this object

minimize_execution_overheadboolean

When enabled, mabl will not capture screenshots, network logs, DOM snapshots, or other test artifacts in order to report the most accurate flow execution time

is_latestboolean

Indicates whether this was the latest variant when retrieved

versioninteger

The generation number of this variant

previous_versioninteger

The generation number of the variant that was edited to create this variant (if applicable)

merged_versioninteger

The generation number of the variant that was merged with the previous version to create this variant (if applicable)

merged_from_branchstring

Name of the source branch whose version was merged to create this variant (if applicable)

created_on_branchstring

Branch name the test was created on

change_descriptionstring

Description of the change between this variant and the previous variant

variant_last_updated_by_app_versionstring

The version of the desktop app used to create this version.

scriptstring

The flow's script

script_descriptionstring

Description of what the script does

step_annotationsobject

Step descriptions and notes keyed by the step index

selectorsstring[]

the selectors from mablscript

page_urlsstring[]

URLs that should be visited for a visual page checker test

api_stepsobject

API steps for API only flow (stored in postman collection format)

json_stepsobject

Steps in the new json format that replaces mablscript

created_by_app_versionstring

The version of the desktop app used to create this version.

urlstring

the URL used when creating the flow

agent_session_idstring

the id of the agent session that authored this flow version, if any

variant_last_updated_timeinteger

Time the variant was last updated

variant_last_updated_by_idstring

ID of the user who last updated the variant

cloud_safe_invariant_idstring

Cloud safe ID representation (e.g. GCP/email/Kubernetes safe)

invariant_idstring

Object ID for the parent type. Set by system.