Test Runs and Results

Execution is split between two services: AutoRunner executes automated runs, and Test Management records manual execution results against test plans.

note

There is no test-sessions resource. Earlier versions of this page described one; use the endpoints below instead.

AutoRunner test runs

Base path: https://api.rabbitqa.com/autorunner/api/v1/test-runs

Starting and stopping

Method	Path	Purpose
POST	/test-runs	Create a run
POST	/test-runs/start	Start a run
POST	/test-runs/start/scenario	Start a single scenario
POST	/test-runs/start/bulk	Start several runs together
POST	/test-runs/stop	Stop a running test
DELETE	/test-runs/{id}	Delete a run

Reading runs

Method	Path	Purpose
GET	/test-runs	List runs
GET	/test-runs/summary	Summary rows for listing screens
GET	/test-runs/active	Runs currently executing
GET	/test-runs/status	Status overview
GET	/test-runs/{id}	Full run detail
GET	/test-runs/{id}/lite	Lightweight run detail
GET	/test-runs/{id}/collection	The collection the run executed
GET	/test-runs/{id}/environment	Environment used by the run
POST	/test-runs/search	Search with a filter body
GET	/test-runs/compare	Compare two runs
GET	/test-runs/export	Export runs as CSV

Results

Method	Path	Purpose
GET	/test-runs/{id}/results	All results for a run
GET	/test-runs/{id}/results/{resultId}	One result
GET	/test-runs/{id}/scenarios/{scenarioId}/attempts	Retry attempts for a scenario
POST	/test-runs/{id}/results	Report a result

Controlling a scenario mid-run

An AI-driven scenario can be paused, resumed and instructed while it is executing.

Method	Path	Purpose
POST	/test-runs/{id}/scenarios/{scenarioId}/pause	Pause
POST	/test-runs/{id}/scenarios/{scenarioId}/resume	Resume
POST	/test-runs/{id}/scenarios/{scenarioId}/instruct	Send an instruction
GET	/test-runs/{id}/scenarios/{scenarioId}/agent-questions	Questions the agent is waiting on
GET	/test-runs/{id}/scenarios/{scenarioId}/conversation	The agent conversation

Related AutoRunner resources

• /autorunner/api/v1/test-suites — plans, called test suites in the API
• /autorunner/api/v1/scenarios — scenario definitions
• /autorunner/api/v1/test-schedulers — scheduled runs
• /autorunner/api/v1/test-run-report, /test-run-content, /test-reports — reporting

warning

AutoRunner traffic is rate limited. See Rate Limits.

Test plans and manual results

Base path: https://api.rabbitqa.com/tmt/company/api/v1

Test plans group the runs a team executes manually.

Method	Path	Purpose
GET	/testPlans	List test plans
POST	/testPlans	Create a plan
GET	/testPlans/{id}	Retrieve a plan
PUT	/testPlans/{id}	Update a plan
PUT	/testPlans/{id}/archive	Archive a plan
DELETE	/testPlans/{id}	Delete a plan
GET	/testPlans/{id}/testCases	Cases in the plan
GET	/testPlans/{id}/testRuns	Runs under the plan
GET	/testPlans/{id}/testRuns/summary	Run summary for the plan
PUT	/testPlans/{id}/testRuns/{runId}	Update a run
DELETE	/testPlans/{id}/testRuns/{runId}	Delete a run

Results

Method	Path	Purpose
GET	/testResults	List results
POST	/testResults/search	Search with a filter body
POST	/testResults	Record a result
PUT	/testResults	Update a result
PUT	/testResults/batch	Update several results
GET	/testResults/{testResultId}	Retrieve one
PUT	/testResults/{testResultId}	Update one
DELETE	/testResults/{testResultId}	Delete one
GET	/testResults/{testResultId}/audits	Change history
GET	/testResults/filter-options	Values available to filter on

See also

• Test Cases
• Projects