Testopia:Documentation:XMLRPC:TestPlan: Difference between revisions

Jump to navigation Jump to search

Testopia:Documentation:XMLRPC:TestPlan (view source)

Revision as of 20:54, 25 September 2007

4,414 bytes added ,  25 September 2007
no edit summary
No edit summary
No edit summary
Line 13: Line 13:


{| border=1 cellpadding=4
{| border=1 cellpadding=4
| '''Attribute''' || '''Data Type''' || '''Comments'''  
| '''Attribute''' || '''Data Type''' || '''Comments''' || '''Create''' || '''Read''' || '''Update'''  
|-
|-
| author_id || integer ||
| author_id || integer || || Required || X ||
|-
|-
| editor_id || integer ||
| default_product_version || string || || Required || X || X
|-
|-
| default_product_version || string ||
| creation_date || string || Format: yyyy-mm-dd hh:mm:ss || || X ||
|-
|-
| creation_date || string || Format: yyyy-mm-dd hh:mm:ss
| isactive || integer || || Optional || X || X
|-
|-
| isactive || integer ||
| name || string || || Required || X || X
|-
|-
| name || string ||
| plan_id || integer || || || X ||
|-
|-
| plan_id || integer ||
| product_id || integer || || Required || X || X
|-
| product_id || integer ||
|-
|-
| type_id || integer ||
| type_id || integer || || Required || X || X
|-
|-
|}
|}
Line 54: Line 52:


=====Result=====
=====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".
A hash map of key/value pairs for the attributes listed above or a hash map containing values for the keys, "faultCode" and "faultString".


=====Example=====
<b>Java</b>
ArrayList<Object> params = new ArrayList<Object>();
params.add(plan_id);
Object[] result = (Object[]) client.execute("TestPlan.get", params);


<b>Perl</b>
my $plan_id = 1;
my $result = $proxy->call("TestPlan.get", $plan_id);


----
----
Line 70: Line 76:
| '''Parameter''' || '''Data Type''' || '''Comments'''  
| '''Parameter''' || '''Data Type''' || '''Comments'''  
|-
|-
| query || string || Can not be null or an empty string.  See [[Bugzilla_XML-RPC_API_Query_Examples |Query Examples]].
| query || hashmap || Can not be null.  See [[Bugzilla_XML-RPC_API_Query_Examples |Query Examples]].
|-
|-
|}
|}
Line 76: Line 82:


=====Result=====
=====Result=====
An array of TestPlan hash maps or a hash map containing values for the keys, "faultcode" and "faultstring".
An array of TestPlan hash maps or a hash map containing values for the keys, "faultCode" and "faultString".
 
=====Example=====
<b>Perl</b>
my $result = $proxy->call("TestPlan.list", {"author_id" => 1, "product_id" => 1});




Line 94: Line 104:
|}
|}


<sup>1</sup> Required attributes: author, editor, product, default_product_version, type, and name.
<sup>1</sup> Required attributes: author_id, product_id, default_product_version, type_id, and name.




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


=====Example=====
<b>Perl</b>
my $result = $proxy->call("TestPlan.create", {name => "New Plan", product_id => 1, author_id => 2, type_id => 2, default_product_version => "1.0"});


----
----
Line 115: Line 127:
| plan_id || integer ||
| plan_id || integer ||
|-
|-
| new_values || hashmap || plan_id can not be modified.
| new_values || hashmap || plan_id, author_id, and creation_date can not be modified.
|-
|-
|}
|}
Line 121: Line 133:


=====Result=====
=====Result=====
The integer value, 0, on success or a hash map containing values for the keys, "faultcode" and "faultstring".
The modified TestPlan on success or a hash map containing values for the keys, "faultCode" and "faultString".
 


=====Example=====
<b>Perl</b>
my $plan_id = 2;
my $result = $proxy->call("TestPlan.update", $plan_id, {name => "Updated Plan Name", isactive => 1});


----
----
Line 142: Line 157:


=====Result=====
=====Result=====
An array of Category objects on success or a hash map containing values for the keys, "faultcode" and "faultstring".
An array of Category objects on success or a hash map containing values for the keys, "faultCode" and "faultString".


=====Example=====
<b>Perl</b>
my $plan_id = 2;
my $result = $proxy->call("TestPlan.get_categories", $plan_id);
----
====get_builds - Get A List of Builds For An Existing Test Plan====
----
=====Usage=====
TestPlan.get_builds
=====Parameters=====
{| border=1 cellpadding=4
| '''Parameter''' || '''Data Type''' || '''Comments'''
|-
| plan_id || integer ||
|-
|}
=====Result=====
An array of Build objects on success or a hash map containing values for the keys, "faultCode" and "faultString".
=====Example=====
<b>Java</b>
ArrayList<Object> params = new ArrayList<Object>();
params.add(PlanID);
Object[] result = (Object[]) client.execute("TestPlan.get_builds", params);
<b>Perl</b>
my $plan_id = 2;
my $result = $proxy->call("TestPlan.get_builds", $plan_id);
----
====get_components - Get A List of Components For An Existing Test Plan====
----
=====Usage=====
TestPlan.get_components
=====Parameters=====
{| border=1 cellpadding=4
| '''Parameter''' || '''Data Type''' || '''Comments'''
|-
| plan_id || integer ||
|-
|}
=====Result=====
An array of Component objects on success or a hash map containing values for the keys, "faultCode" and "faultString".
=====Example=====
<b>Java</b>
ArrayList<Object> params = new ArrayList<Object>();
params.add(plan_id);
Object[] result = (Object[]) client.execute("TestPlan.get_components", params);
<b>Perl</b>
my $plan_id = 2;
my $result = $proxy->call("TestPlan.get_components", $plan_id);




Line 163: Line 242:


=====Result=====
=====Result=====
An array of TestCase objects on success or a hash map containing values for the keys, "faultcode" and "faultstring".
An array of TestCase objects on success or a hash map containing values for the keys, "faultCode" and "faultString".


=====Example=====
<b>Perl</b>
my $plan_id = 2;
my $result = $proxy->call("TestPlan.get_test_cases", $plan_id);




Line 184: Line 267:


=====Result=====
=====Result=====
An array of TestRun objects on success or a hash map containing values for the keys, "faultcode" and "faultstring".
An array of TestRun objects on success or a hash map containing values for the keys, "faultCode" and "faultString".
 
=====Example=====
<b>Perl</b>
my $plan_id = 2;
my $result = $proxy->call("TestPlan.get_test_runs", $plan_id);
 
----
====add_tag - Add a tag to the given TestPlan====
----
 
=====Usage=====
TestPlan.add_tag
 
=====Parameters=====
{| border=1 cellpadding=4
| '''Parameter''' || '''Data Type''' || '''Comments'''
|-
| plan_id || integer ||
|-
| tag_name || string || Creates tag if it does not exist
|-
|}
 
 
=====Result=====
The integer , 0, on success or a hash map containing values for the keys, "faultCode" and "faultString".


=====Example=====
<b>Java</b>
ArrayList<Object> params = new ArrayList<Object>();
params.add(testPlan_id);
params.add(tag_name);
Integer result = (Integer)client.execute("TestPlan.add_tag", params);


<b>Perl</b>
my $plan_id = 2;
my $tag_name = "New Tag Name";
my $result = $proxy->call("TestPlan.add_tag", $plan_id, $tag_name);


----
----
====lookup_type_id_by_name - Lookup A Test Plan Type ID By Its Name====
====remove_tag - Remove a tag from the given TestPlan====
----
----


=====Usage=====
=====Usage=====
testPlan.lookup_type_id_by_name
TestPlan.remove_tag
 
=====Parameters=====
{| border=1 cellpadding=4
| '''Parameter''' || '''Data Type''' || '''Comments'''
|-
| plan_id || integer ||
|-
| tag_name || string ||
|-
|}
 
 
=====Result=====
The integer , 0, on success or a hash map containing values for the keys, "faultCode" and "faultString".
 
=====Example=====
<b>Perl</b>
my $plan_id = 2;
my $tag_name = "Tag Name";
my $result = $proxy->call("TestPlan.remove_tag", $plan_id, $tag_name);
 
----
====get_tags - Get a list of tags for the given TestPlan====
----
 
=====Usage=====
TestPlan.get_tags
 
=====Parameters=====
{| border=1 cellpadding=4
| '''Parameter''' || '''Data Type''' || '''Comments'''
|-
| plan_id || integer ||
|-
|}
 
 
=====Result=====
An array of Tag hash maps or a hash map containing values for the keys, "faultCode" and "faultString".
 
=====Example=====
<b>Perl</b>
my $plan_id = 2;
my $result = $proxy->call("TestPlan.get_tags", $plan_id);
 
----
====lookup_type_id_by_name - Lookup A TestPlan Type ID By Its Name====
----
 
=====Usage=====
TestPlan.lookup_type_id_by_name


=====Parameters=====
=====Parameters=====
Line 209: Line 379:
=====Example=====
=====Example=====
<b>Perl</b>
<b>Perl</b>
  $proxy->call('TestPlan.lookup_type_id_by_name', 'Unit');
  my $type_name = "Unit";
 
my $result = $proxy->call('TestPlan.lookup_type_id_by_name', $type_name);
 


----
----
====lookup_type_name_by_id - Lookup A Test Plan Type Name By Its ID====
====lookup_type_name_by_id - Lookup A TestPlan Type Name By Its ID====
----
----


Line 234: Line 403:
=====Example=====
=====Example=====
<b>Perl</b>
<b>Perl</b>
  $proxy->call('TestPlan.lookup_type_name_by_id', 1);
  my $type_id = 1;
my $result = $proxy->call('TestPlan.lookup_type_name_by_id', $type_id);






<br>Back to the [[Testopia |Testopia Main Page]]
<br>Back to the [[Testopia |Testopia Main Page]]
Ghendricks
141

edits

Retrieved from "https://wiki.mozilla.org/Special:MobileDiff/69460"

Navigation menu