Testopia:Documentation:XMLRPC:TestPlan

Back to Testopia XML-RPC API

TestPlan

Description

The test plan is the glue of Testopia. Virtually all other objects associate to a plan.

Hiearchy

Bugzilla::WebService::Testopia::TestPlan

Attributes

Attribute	Data Type	Comments
author	string
editor	string
default_product_version	string
creation_date	string	Format: yyyy-mm-dd hh:mm:ss
isactive	integer
name	string
plan_id	integer
product	string
type	string

Methods

---

get - Get A TestPlan by ID

---

Usage

TestPlan.get

Parameters

Parameter	Data Type	Comments
plan_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 TestPlans Based on A Query

---

Usage

TestPlan.list

Parameters

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

Result

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

---

create - Create A New TestPlan

---

Usage

TestPlan.create

Parameters

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

¹ Required attributes: author, editor, product, default_product_version, type, and name.

Result

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

---

update - Update An Existing TestPlan

---

Usage

TestPlan.update

Parameters

Parameter	Data Type	Comments
plan_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