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_id | integer | |
| editor_id | integer | |
| default_product_version | string | |
| creation_date | string | Format: yyyy-mm-dd hh:mm:ss |
| isactive | integer | |
| name | string | |
| plan_id | integer | |
| product_id | integer | |
| type_id | integer |
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. |
1 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".
get_categories - Get A List of Categories For An Existing Test Plan
Usage
TestPlan.get_categories
Parameters
| Parameter | Data Type | Comments |
| plan_id | integer |
Result
An array of Category objects on success or a hash map containing values for the keys, "faultcode" and "faultstring".
get_test_cases - Get A List of Test Cases For An Existing Test Plan
Usage
TestPlan.get_test_cases
Parameters
| Parameter | Data Type | Comments |
| plan_id | integer |
Result
An array of TestCase objects on success or a hash map containing values for the keys, "faultcode" and "faultstring".
get_test_runs - Get A List of Test Runs For An Existing Test Plan
Usage
TestPlan.get_test_runs
Parameters
| Parameter | Data Type | Comments |
| plan_id | integer |
Result
An array of TestRun objects on success or a hash map containing values for the keys, "faultcode" and "faultstring".
lookup_type_id_by_name - Lookup A Test Plan Type ID By Its Name
Usage
testPlan.lookup_type_id_by_name
Parameters
| Parameter | Data Type | Comments |
| name | string | Cannot be null or empty string |
Result
The TestPlan type id for the respective name or 0 if an error occurs.
Example
Perl
$proxy->call('TestPlan.lookup_type_id_by_name', 'Unit');
lookup_type_name_by_id - Lookup A Test Plan Type Name By Its ID
Usage
TestPlan.lookup_type_name_by_id
Parameters
| Parameter | Data Type | Comments |
| id | integer | Cannot be 0 |
Result
The TestPlan type name for the respective id or empty string if an error occurs.
Example
Perl
$proxy->call('TestPlan.lookup_type_name_by_id', 1);
Back to the Testopia Main Page