Testopia:Documentation:XMLRPC:Product: 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/Product.html http://landfill.bugzilla.org/testopia2/docs/html/api/Bugzilla/WebService/Te...')
 
Line 1: Line 1:
__NOEDITSECTION__
see [http://landfill.bugzilla.org/testopia2/docs/html/api/Bugzilla/WebService/Testopia/Product.html http://landfill.bugzilla.org/testopia2/docs/html/api/Bugzilla/WebService/Testopia/Product.html]
Back to [[Testopia:Documentation:XMLRPC]]
 
==Product==
 
===Description===
An object representing a Testopia product.
 
===Hiearchy===
Bugzilla::WebService::Testopia::Product
 
===Attributes===
 
{| border=1 cellpadding=4
| '''Attribute''' || '''Data Type''' || '''Comments'''
|-
| id || integer ||
|-
| name || string ||
|-
| description || string ||
|-
| milestone_url || string ||
|-
| disallow_new || integer ||
|-
| votes_per_user || integer ||
|-
| max_votes_per_bug || integer ||
|-
| votes_to_confirm || integer ||
|-
| default_milestone || string ||
|-
| classification_id || integer ||
|-
|}
 
 
===Methods===
 
----
====lookup_id_by_name - Lookup A Product ID By Its Name====
----
 
=====Usage=====
Product.lookup_id_by_name
 
=====Parameters=====
{| border=1 cellpadding=4
| '''Parameter''' || '''Data Type''' || '''Comments'''
|-
| name || string || Cannot be null or empty string
|-
|}
 
 
=====Result=====
The product id for the respective name or 0 if an error occurs.
 
=====Example=====
<b>Perl</b>
my $product_name = 'Product Name';
$proxy->call('Product.lookup_id_by_name', 'Product Name');
 
 
 
----
====lookup_name_by_id - Lookup A Product Name By Its ID====
----
 
=====Usage=====
Product.lookup_name_by_id
 
=====Parameters=====
{| border=1 cellpadding=4
| '''Parameter''' || '''Data Type''' || '''Comments'''
|-
| id || integer || Cannot be 0
|-
|}
 
 
=====Result=====
The product name for the respective id or empty string if an error occurs.
 
=====Example=====
<b>Perl</b>
my $product_id = 1;
$proxy->call('Product.lookup_name_by_id', $product_id);
 
 
 
----
====get_milestones - Get a list of milestones for the given Product====
----
 
=====Usage=====
Product.get_milestones
 
=====Parameters=====
{| border=1 cellpadding=4
| '''Parameter''' || '''Data Type''' || '''Comments'''
|-
| product_id || integer ||
|-
|}
 
 
=====Result=====
An array of Milestone hash maps or a hash map containing values for the keys, "faultcode" and "faultstring".
 
=====Example=====
<b>Perl</b>
my $product_id = 1;
$proxy->call('Product.lookup_name_by_id', $product_id);
 
<br>Back to [[Testopia]]

Latest revision as of 17:05, 23 June 2008

see http://landfill.bugzilla.org/testopia2/docs/html/api/Bugzilla/WebService/Testopia/Product.html
Retrieved from "https://wiki.mozilla.org/index.php?title=Testopia:Documentation:XMLRPC:Product&oldid=97323"