Testopia:Documentation:XMLRPC:TestPlan: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
No edit summary
(Replacing page with 'see http://landfill.bugzilla.org/testopia2/docs/html/api/Bugzilla/WebService/Testopia/TestPlan.html')
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
__NOEDITSECTION__
see http://landfill.bugzilla.org/testopia2/docs/html/api/Bugzilla/WebService/Testopia/TestPlan.html
Back to [[Bugzilla_XML-RPC_API |Bugzilla 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===
 
{| border=1 cellpadding=4
| '''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=====
{| border=1 cellpadding=4
| '''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=====
{| border=1 cellpadding=4
| '''Parameter''' || '''Data Type''' || '''Comments'''
|-
| query || string || Can not be null or an empty string.  See [[Bugzilla_XML-RPC_API_Query_Examples |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=====
{| border=1 cellpadding=4
| '''Parameter''' || '''Data Type''' || '''Comments'''
|-
| new_values || hashmap || See required attributes list<sup>1</sup> below.
|-
|}
 
<sup>1</sup> 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=====
{| border=1 cellpadding=4
| '''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".
 
 
 
<br>Back to the [[Wiki_Main_Page#IS&T |Wiki Main Page]]

Latest revision as of 17:08, 23 June 2008

see http://landfill.bugzilla.org/testopia2/docs/html/api/Bugzilla/WebService/Testopia/TestPlan.html

Retrieved from "https://wiki.mozilla.org/index.php?title=Testopia:Documentation:XMLRPC:TestPlan&oldid=97327"