Sign in
latestOpenAPI 3.0.32026-08-227451,2751.8 MB

d0fc0114da66

Test

Update test metadata

Update the unversioned metadata of an existing test

patch/test/{id}/metadata

Path parameters

idstring required

The ID of the test to update

Query parameters

field_maskstring[]

A comma separated set of fields to update. If provided, only fields in the field mask will be updated. Fields in the field mask but not in the body will be set to null.

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

enabledboolean

If test is enabled to execute

namestring

The display name of the test

descriptionstring

Brief description the test

defaultboolean

Whether this test is a default test generated for all customers from a template

datatablesstring[]

Array of datatable IDs for datatables that satisfy the parameter requirements of the test

export_variablesboolean

Whether this test should export variables

source_control_tagsobject

(deprecated, use versionTags) mapping of source control tags to version numbers the tag is currently applied to

ref_idstring

Reference id to this test in another system

test_type'api' | 'browser' | 'performance' | 'mobile'

Type of test

test_source'mabl_cloud' | 'external' | 'mabl_local' | 'mabl_agent'

Where the test lives

send_mabl_headerboolean

Controls whether or not the x-mabl-agent header is sent on requests

execution_runner_size'x1' | 'x2' | 'x3' | 'x4' | 'x5' | 'x6' | 'small' | 'medium' | 'large' | 'inherit'

available runner sizes

mobile_platform'android' | 'ios'

The mobile platform associated with this object

intentstring

The intent of the test as natural language

test_case_idstring

Unique identifier of the associated TestCase

Response

The updated test on the master branch

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

enabledboolean

If test is enabled to execute

namestring

The display name of the test

descriptionstring

Brief description the test

defaultboolean

Whether this test is a default test generated for all customers from a template

datatablesstring[]

Array of datatable IDs for datatables that satisfy the parameter requirements of the test

export_variablesboolean

Whether this test should export variables

source_control_tagsobject

(deprecated, use versionTags) mapping of source control tags to version numbers the tag is currently applied to

ref_idstring

Reference id to this test in another system

test_type'api' | 'browser' | 'performance' | 'mobile'

Type of test

test_source'mabl_cloud' | 'external' | 'mabl_local' | 'mabl_agent'

Where the test lives

send_mabl_headerboolean

Controls whether or not the x-mabl-agent header is sent on requests

execution_runner_size'x1' | 'x2' | 'x3' | 'x4' | 'x5' | 'x6' | 'small' | 'medium' | 'large' | 'inherit'

available runner sizes

mobile_platform'android' | 'ios'

The mobile platform associated with this object

intentstring

The intent of the test as natural language

test_case_idstring

Unique identifier of the associated TestCase