Sign in
latestOpenAPI 3.0.32026-08-227451,2751.8 MB

d0fc0114da66

Flow

Update flow metadata only

Update the unversioned metadata of an existing flow

patch/flows/{id}/metadata

Path parameters

idstring required

The ID of the flow to update

Headers

If-Matchstring

If-Match header according to http/1.1 spec section 14.24

Request body

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

Response

The updated flow metadata

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