Run

Overview

Fields

Name	Type	Description	Request Methods
blockedCount	Int	The amount of tests in the test run marked as blocked	TODO
completedOn	Timestamp	The date/time when the test run was closed (as UNIX timestamp)	TODO
config	String	The configuration of the test run as string (if part of a test plan)	TODO
configIds	List<Int>	The array of IDs of the configurations of the test run (if part of a test plan)	TODO
createdBy	Int	The ID of the user who created the test run	TODO
createdOn	Timestamp	The date/time when the test run was created (as UNIX timestamp)	TODO
customStatus1Count	Int	The amount of tests in the test run with the respective custom status	TODO
customStatus2Count	Int	The amount of tests in the test run with the respective custom status	TODO
customStatus3Count	Int	The amount of tests in the test run with the respective custom status	TODO
customStatus4Count	Int	The amount of tests in the test run with the respective custom status	TODO
customStatus5Count	Int	The amount of tests in the test run with the respective custom status	TODO
customStatus6Count	Int	The amount of tests in the test run with the respective custom status	TODO
customStatus7Count	Int	The amount of tests in the test run with the respective custom status	TODO
failedCount	Int	The amount of tests in the test run marked as failed	TODO
id	Int	The unique ID of the test run	TODO
isCompleted	Boolean	True if the test run was closed and false otherwise	TODO
planId	Int	The ID of the test plan this test run belongs to	TODO
passedCount	Int	The amount of tests in the test run marked as passed	TODO
projectId	Int	The ID of the project this test run belongs to	TODO
retestCount	Int	The amount of tests in the test run marked as retest
TODO
untestedCount	Int	The amount of tests in the test run marked as untested	TODO
url	String	The address/URL of the test run in the user interface	TODO
suiteId	Int	The ID of the test suite this test run is derived from	TODO
assignedToId	Int	The ID of the user the entire test run is assigned to	TODO
name	String	The name of the test run	TODO
description	String	The description of the test run	TODO
milestoneId	Int	The ID of the milestone this test run belongs to	TODO
includeAll	Boolean	True if the test run includes all test cases and false otherwise	TODO
caseIds	List<Int>	An array of case IDs for the custom case selection	TODO

Methods

GET Requests:

---

1. getRun

Description:

Returns an existing test run. Please see get_tests for the list of included tests in this run.

Parameters:

Name	Type	Description	Required
runId	Int	The ID of the test run	Yes

Returns:

• Run

Example:

 

2. getRuns

Description:

Returns a list of test runs for a project. Only returns those test runs that are not part of a test plan

Parameters:

Name	Type	Description	Required
projectId	Int	The ID of the project	Yes
createdAfter	Timestamp	Only return test runs created after this date (as UNIX timestamp).	No
createdBefore	Timestamp	Only return test runs created before this date (as UNIX timestamp).	No
createdBy	List<Int>	A comma-separated list of creators (user IDs) to filter by.	No
isCompleted	Boolean	True to return completed test runs only. False to return active test runs only.	No
limit	Int	Limit the result to limit test runs.	No
offset	Int	Use offset to skip records.	No
milestoneId	List<Int>	A comma-separated list of milestone IDs to filter by.	No
suiteId	List<Int>	A comma-separated list of test suite IDs to filter by.	No

Returns:

• List<Run>

Example:

 

POST Requests:

---

1. addRun

Description:

Creates a new test run.

Required Parameters:

• projectId
• suiteId (optional if the project is operating in single suite mode, required otherwise)

Returns:

• Run

Example:

 

2. updateRun

Description:

Updates an existing test run (partial updates are supported, i.e. you can submit and update specific fields only).

Required Parameters:

• runId

Returns:

• Run

Example:

 

3. closeRun

Description:

Closes an existing test run and archives its tests & results.

Required Parameters:

• runId

Returns:

• Run

Example:

 

4. deleteRun

Description:

Deletes an existing test run.

Required Parameters:

• runId

Example: