Testopia:Documentation:XMLRPC:TestRun

Back to Testopia XML-RPC API

TestRun

Description

A test run is the place where most of the work of testing is done.

A run is associated with a single test plan and multiple test cases through the test case-runs.

Hiearchy

Bugzilla::WebService::Testopia::TestRun

Attributes

Attribute	Data Type	Comments
build_id	integer
environment	string
manager	string
notes	string
plan_id	integer
plan_text_version	string
product_version	string
run_id	integer
start_date	string	Format: yyyy-mm-dd hh:mm:ss
stop_date	string	Format: yyyy-mm-dd hh:mm:ss
summary	string

Methods

---

get - Get A TestRun by ID

---

Usage

TestRun.get

Parameters

Parameter	Data Type	Comments
run_id	integer	Must be greater than 0.

Result

A hash map of key/value pairs for the attributes listed above or a hash map containing values for the keys, "faultcode" and "faultstring".

---

list - Get A List of TestRuns Based on A Query

---

Usage

TestRun.list

Parameters

Parameter	Data Type	Comments
query	string	Can not be null or an empty string. See Query Examples.

Result

An array of TestRun hash maps or a hash map containing values for the keys, "faultcode" and "faultstring".

---

create - Create A New TestRun

---

Usage

TestRun.create

Parameters

Parameter	Data Type	Comments
new_values	hashmap	See required attributes list1 below.

¹ Required attributes: build_id, environment, manager, plan_id, plan_text_version, and summary.

Result

An integer value representing the new run_id or a hash map containing values for the keys, "faultcode" and "faultstring".

---

update - Update An Existing TestRun

---

Usage

TestRun.update

Parameters

Parameter	Data Type	Comments
run_id	integer
new_values	hashmap	plan_id can not be modified.

Result

The integer value, 0, on success or a hash map containing values for the keys, "faultcode" and "faultstring".

Back to the Testopia Main Page