Create Test Suite Run | Vellum

1 from vellum import ( 2 TestSuiteRunDeploymentReleaseTagExecConfigDataRequest, 3 TestSuiteRunDeploymentReleaseTagExecConfigRequest, 4 Vellum, 5 ) 6 7 client = Vellum( 8 api_key="YOUR_API_KEY", 9 ) 10 client.test_suite_runs.create( 11 exec_config=TestSuiteRunDeploymentReleaseTagExecConfigRequest( 12 data=TestSuiteRunDeploymentReleaseTagExecConfigDataRequest( 13 deployment_id="deployment_id", 14 ), 15 ), 16 )

1 { 2 "id": "foo", 3 "created": "foo", 4 "test_suite": { 5 "id": "foo", 6 "history_item_id": "foo", 7 "label": "foo" 8 }, 9 "state": "QUEUED", 10 "exec_config": { 11 "type": "DEPLOYMENT_RELEASE_TAG", 12 "data": { 13 "deployment_id": "foo", 14 "tag": "LATEST" 15 }, 16 "test_case_ids": [ 17 "foo" 18 ] 19 }, 20 "progress": { 21 "number_of_requested_test_cases": 42, 22 "number_of_completed_test_cases": 42 23 } 24 }

Trigger a Test Suite and create a new Test Suite Run

Request

This endpoint expects an object.

exec_configobjectRequired

Configuration that defines how the Test Suite should be run

test_suite_idstringOptionalformat: "uuid"

The ID of the Test Suite to run. Must provide either this or test_suite_id.

test_suite_namestringOptional>=1 character

The name of the Test Suite to run. Must provide either this or test_suite_id.

Response

idstringformat: "uuid"

createdstringformat: "date-time"

test_suiteobject

stateenum

The current state of this run

QUEUED - Queued
RUNNING - Running
COMPLETE - Complete
FAILED - Failed
CANCELLED - Cancelled

Allowed values:

exec_configobject or null

Configuration that defines how the Test Suite should be run

progressobject or null

Headers

Request

Response