Testopia:Documentation:XMLRPC:Product: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
No edit summary
 
No edit summary
Line 2: Line 2:
Back to [[Testopia:Documentation:XMLRPC]]
Back to [[Testopia:Documentation:XMLRPC]]


==Product==
==Component==


===Description===
===Description===
An object representing a Testopia product.
Each test case must be linked to one or more test plans.


===Hiearchy===
===Hiearchy===
Bugzilla::WebService::Testopia::Product
Bugzilla::WebService::Component


===Attributes===
===Attributes===


{| border=1 cellpadding=4
{| border=1 cellpadding=4
| '''Attribute''' || '''Data Type''' || '''Comments'''  
| '''Attribute''' || '''Data Type''' || '''Comments''' || '''Create''' || '''Read''' || '''Update'''
|-
|-
| id || integer ||
| description || string || || || X ||
|-
|-
| name || string ||
| id || integer || || || X ||
|-
|-
| description || string ||
| initialowner || integer || || || X ||
|-
|-
| milestone_url || string ||
| initialqacontact || integer || || || X ||
|-
|-
| disallow_new || integer ||
| name || String || || || X ||
|-
| votes_per_user || integer ||
|-
| max_votes_per_bug || integer ||
|-
| votes_to_confirm || integer ||
|-
| default_milestone || string ||
|-
| classification_id || integer ||
|-
|-
| product_id || integer || || || X ||
|}
|}


Line 41: Line 32:


----
----
====lookup_id_by_name - Lookup A Product ID By Its Name====
====get - Get A Component by ID====
----
 
=====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>
$proxy->call('Product.lookup_id_by_name', 'First Product');
 
 
 
----
====lookup_name_by_id - Lookup A Product Name By Its ID====
----
----


=====Usage=====
=====Usage=====
Product.lookup_name_by_id
Component.get


=====Parameters=====
=====Parameters=====
Line 76: Line 42:
| '''Parameter''' || '''Data Type''' || '''Comments'''  
| '''Parameter''' || '''Data Type''' || '''Comments'''  
|-
|-
| id || integer || Cannot be 0
| component_id || integer || Must be greater than 0.
|-
|-
|}
|}
Line 82: Line 48:


=====Result=====
=====Result=====
The product name for the respective id or empty string if an error occurs.
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=====
=====Example=====
<b>Perl</b>
<b>Perl</b>
  $proxy->call('Product.lookup_name_by_id', 1);
  my $component_id = 1;
 
my $result = $proxy->call('Component.get', $component_id);
 
 


<br>Back to [[Testopia]]
<br>Back to [[Testopia]]

Revision as of 20:45, 25 September 2007

Back to Testopia:Documentation:XMLRPC

Component

Description

Each test case must be linked to one or more test plans.

Hiearchy

Bugzilla::WebService::Component

Attributes

Attribute Data Type Comments Create Read Update
description string X
id integer X
initialowner integer X
initialqacontact integer X
name String X
product_id integer X


Methods


get - Get A Component by ID


Usage

Component.get

Parameters
Parameter Data Type Comments
component_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

Perl

my $component_id = 1;
my $result = $proxy->call('Component.get', $component_id);


Back to Testopia