Flow

Update Flow

Changed on

Used to update existing flows. flow_type is fixed at create; a value sent here is ignored.

patch/flows/{id}

Request

  • Base URL: https://api.mabl.com
  • URL: https://api.mabl.com/flows/{id}
  • Auth: one of:
    • HTTP basic
    • API key in header Authorization

Path parameters

idstring required

The ID of the flow to update

Query parameters

branchstring

The branch the flow update should be applied to. Defaults to master

forceboolean

Force an update to occur, even if no changes have been made

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

namestring

The display name of the flow. Required (non-blank) for reusable flows. When absent on older reusable data, the API serves the description value here; non-reusable flows are never given a name they did not have.

descriptionstring

Usage notes and considerations for the flow. Historically this field held the flow's display name; that role has moved to name. To rename a flow, write name — writing this field edits the description only. When a flow has no description, the API serves the flow's name here for backwards compatibility.

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

reuse_browser_state_in_plan_runboolean

Shares the browser state this flow produces with the rest of a cloud plan run.

Tests that reach the flow before any state has been stored each run it and store their own result. The tests in a plan stage start together, so that is the common case; a test that starts once state already exists for the same application and credentials begins from that stored state instead.

To sign in once per plan run, put a test that runs this flow in an earlier plan stage, against the same application URL and with the same credentials. Stages run in order, so the tests of later stages all start from the state that test stored.

A marked flow still runs every time. It is not skipped, so it must decide for itself whether there is anything left to do — a login flow, for example, should wrap its sign-in steps in a condition that only holds when the login page is actually showing. A marked flow that unconditionally repeats its work will do so on a browser that already carries the session.

The stored state lasts only for the plan run. Has no effect on local CLI runs.

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.

Response

The updated flow

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

namestring

The display name of the flow. Required (non-blank) for reusable flows. When absent on older reusable data, the API serves the description value here; non-reusable flows are never given a name they did not have.

descriptionstring

Usage notes and considerations for the flow. Historically this field held the flow's display name; that role has moved to name. To rename a flow, write name — writing this field edits the description only. When a flow has no description, the API serves the flow's name here for backwards compatibility.

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

reuse_browser_state_in_plan_runboolean

Shares the browser state this flow produces with the rest of a cloud plan run.

Tests that reach the flow before any state has been stored each run it and store their own result. The tests in a plan stage start together, so that is the common case; a test that starts once state already exists for the same application and credentials begins from that stored state instead.

To sign in once per plan run, put a test that runs this flow in an earlier plan stage, against the same application URL and with the same credentials. Stages run in order, so the tests of later stages all start from the state that test stored.

A marked flow still runs every time. It is not skipped, so it must decide for itself whether there is anything left to do — a login flow, for example, should wrap its sign-in steps in a condition that only holds when the login page is actually showing. A marked flow that unconditionally repeats its work will do so on a browser that already carries the session.

The stored state lasts only for the plan run. Has no effect on local CLI runs.

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.

Changes

  • d0a5100df4c1Revision changes
    • breaking

      added to the ///// request property allOf list

    • breaking

      removed the enum value api of the request property /////

    • breaking

      removed the enum value check_links of the request property /////

    • breaking

      removed the enum value login of the request property /////

    • breaking

      removed the enum value mablscript of the request property /////

    • breaking

      removed the enum value mobile of the request property /////

    • breaking

      removed the enum value validate_page of the request property /////

    • breaking

      removed the enum value verify_url of the request property /////

    • breaking

      removed the enum value visual_page_validation of the request property /////

    • breaking

      the ///// request property type changed from string to no type

    • breaking

      the ///// response's property type changed from string to no type for status

    • info

      added to the ///// response property allOf list for the response status

    • info

      removed the api enum value from the ///// response property for the response status

    • info

      removed the check_links enum value from the ///// response property for the response status

    • info

      removed the login enum value from the ///// response property for the response status

    • info

      removed the mablscript enum value from the ///// response property for the response status

    • info

      removed the mobile enum value from the ///// response property for the response status

    • info

      removed the validate_page enum value from the ///// response property for the response status

    • info

      removed the verify_url enum value from the ///// response property for the response status

    • info

      removed the visual_page_validation enum value from the ///// response property for the response status

  • 213a66c2bc25Revision changes
    • info

      added the new optional request property /////

    • info

      added the optional property ///// to the response with the status