Testopia:Documentation:XMLRPC:Build: 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/Build.html http://landfill.bugzilla.org/testopia2/docs/html/api/Bugzilla/WebService/Test...')
 
Line 1: Line 1:
__NOEDITSECTION__
see [http://landfill.bugzilla.org/testopia2/docs/html/api/Bugzilla/WebService/Testopia/Build.html http://landfill.bugzilla.org/testopia2/docs/html/api/Bugzilla/WebService/Testopia/Build.html]
Back to [[Testopia:Documentation:XMLRPC]]
 
==Build==
 
===Description===
An object representing a Testopia build number.
 
===Hiearchy===
Bugzilla::WebService::Testopia::Build
 
===Attributes===
 
{| border=1 cellpadding=4
| '''Attribute''' || '''Data Type''' || '''Comments''' || '''Create''' || '''Read''' || '''Update'''
|-
| build_id || integer || ||  || X || 
|-
| product_id || integer || || Required || X || X
|-
| name || string || || Required || X || X
|-
| description || string || || Optional || X || X
|-
| milestone || string || || Optional || X || X
|-
| isactive || boolean || || Optional || X || X
|-
|}
 
 
===Methods===
 
----
====get - Get A Build by ID====
----
 
=====Usage=====
Build.get
 
=====Parameters=====
{| border=1 cellpadding=4
| '''Parameter''' || '''Data Type''' || '''Comments'''
|-
| build_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".
 
=====Example=====
<b>Perl</b>
my $build_id = 1;
my $result = $proxy->call('Build.get', $build_id);
 
----
====create - Create A New Build====
----
 
=====Usage=====
Build.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: name and product_id.
 
 
=====Result=====
An integer value representing the new build_id or a hash map containing values for the keys, "faultcode" and "faultstring".
 
=====Example=====
<b>Perl</b>
my $result = $proxy->call('Build.create', {'product_id' => 1, 'name' => 'New Build'});
 
 
----
====update - Update An Existing Build====
----
 
=====Usage=====
Build.update
 
=====Parameters=====
{| border=1 cellpadding=4
| '''Parameter''' || '''Data Type''' || '''Comments'''
|-
| buld_id || integer ||
|-
| new_values || hashmap || build_id and product_id can not be modified.
|-
|}
 
 
=====Result=====
The modified Build on success or a hash map containing values for the keys, "faultcode" and "faultstring".
 
=====Example=====
<b>Perl</b>
my $build_id = 1;
my $result = $proxy->call('Build.update', $build_id, {'name' => 'New Build'});
 
 
----
====lookup_id_by_name - Lookup A Build ID By Its Name====
----
 
=====Usage=====
Build.lookup_id_by_name
 
=====Parameters=====
{| border=1 cellpadding=4
| '''Parameter''' || '''Data Type''' || '''Comments'''
|-
| name || string || Cannot be null or empty string
|-
|}
 
 
=====Result=====
The build id for the respective name or 0 if an error occurs.
 
=====Example=====
<b>Perl</b>
my $build_name = 'Build Name';
my $result = $proxy->call('Build.lookup_id_by_name', $build_name);
 
 
 
----
====lookup_name_by_id - Lookup A Build Name By Its ID====
----
 
=====Usage=====
Build.lookup_name_by_id
 
=====Parameters=====
{| border=1 cellpadding=4
| '''Parameter''' || '''Data Type''' || '''Comments'''
|-
| id || integer || Cannot be 0
|-
|}
 
 
=====Result=====
The build name for the respective id or empty string if an error occurs.
 
=====Example=====
<b>Perl</b>
my $build_id = 1;
my $result = $proxy->call('Build.lookup_name_by_id', $build_id);
 
 
 
 
<br>Back to  [[Testopia]]

Latest revision as of 17:04, 23 June 2008

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