Test

Retrieve test with additional context

Changed on

Used to retrieve an existing test with supplemental context information

get/test/journey/{id}/context

Request

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

Path parameters

idstring required

The test ID or test invariant ID to retrieve. Invariant ID returns latest version.

Query parameters

sourceControlTagstring

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

include_screenshot_infoboolean

Include step-level details with screenshot GCS URIs from most recent passing test run

Response

The test that was retrieved

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

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

manual_stepsstring

Test steps outline, used for manual tests

flowsstring[]

Array of flow IDs for flows to execute during test

flow_configurationobject

Configuration for specific flow instances

iterationsobject

Iteration configurations keyed by flow index (as string)

api_urlstring

the API URL associated with the test

urlstring

the URL used when creating the test version

credentials_idstring

the id of the credentials used when creating the test version

application_idstring

the id of the application used when creating the test version

environment_idstring

the id of the environment used when creating the test version

datatable_row_idstring

the id of the DataTable row used when creating the test version

training_session_idstring

the id of the training session used when creating the test version

agent_session_idstring

the id of the agent session that authored this test 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.

annotated_step_descriptionsstring

Detailed description of the steps in this test

Changes

  • e0444c72fafcRevision changes
    • info

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

    • info

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

  • ae5dd2361d4aRevision changes
    • info

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