Testopia:Documentation:XMLRPC:TestPlan: Difference between revisions

Jump to navigation Jump to search
no edit summary
No edit summary
No edit summary
Line 15: Line 15:
| '''Attribute''' || '''Data Type''' || '''Comments'''  
| '''Attribute''' || '''Data Type''' || '''Comments'''  
|-
|-
| author || string ||
| author_id || integer ||
|-
|-
| editor || string ||
| editor_id || integer ||
|-
|-
| default_product_version || string ||
| default_product_version || string ||
Line 29: Line 29:
| plan_id || integer ||
| plan_id || integer ||
|-
|-
| product || string ||
| product_id || integer ||
|-
|-
| type || string ||
| type_id || integer ||
|-
|-
|}
|}
Line 122: Line 122:
=====Result=====
=====Result=====
The integer value, 0, on success or a hash map containing values for the keys, "faultcode" and "faultstring".
The integer value, 0, on success or a hash map containing values for the keys, "faultcode" and "faultstring".
----
====get_categories - Get A List of Categories For An Existing Test Plan====
----
=====Usage=====
TestPlan.get_categories
=====Parameters=====
{| border=1 cellpadding=4
| '''Parameter''' || '''Data Type''' || '''Comments'''
|-
| plan_id || integer ||
|-
|}
=====Result=====
An array of Category objects on success or a hash map containing values for the keys, "faultcode" and "faultstring".
----
====get_test_cases - Get A List of Test Cases For An Existing Test Plan====
----
=====Usage=====
TestPlan.get_test_cases
=====Parameters=====
{| border=1 cellpadding=4
| '''Parameter''' || '''Data Type''' || '''Comments'''
|-
| plan_id || integer ||
|-
|}
=====Result=====
An array of TestCase objects on success or a hash map containing values for the keys, "faultcode" and "faultstring".
----
====get_test_runs - Get A List of Test Runs For An Existing Test Plan====
----
=====Usage=====
TestPlan.get_test_runs
=====Parameters=====
{| border=1 cellpadding=4
| '''Parameter''' || '''Data Type''' || '''Comments'''
|-
| plan_id || integer ||
|-
|}
=====Result=====
An array of TestRun objects on success or a hash map containing values for the keys, "faultcode" and "faultstring".
----
====lookup_type_id_by_name - Lookup A Test Plan Type ID By Its Name====
----
=====Usage=====
testPlan.lookup_type_id_by_name
=====Parameters=====
{| border=1 cellpadding=4
| '''Parameter''' || '''Data Type''' || '''Comments'''
|-
| name || string || Cannot be null or empty string
|-
|}
=====Result=====
The TestPlan type id for the respective name or 0 if an error occurs.
=====Example=====
<b>Perl</b>
$proxy->call('TestPlan.lookup_type_id_by_name', 'Unit');
----
====lookup_type_name_by_id - Lookup A Test Plan Type Name By Its ID====
----
=====Usage=====
TestPlan.lookup_type_name_by_id
=====Parameters=====
{| border=1 cellpadding=4
| '''Parameter''' || '''Data Type''' || '''Comments'''
|-
| id || integer || Cannot be 0
|-
|}
=====Result=====
The TestPlan type name for the respective id or empty string if an error occurs.
=====Example=====
<b>Perl</b>
$proxy->call('TestPlan.lookup_type_name_by_id', 1);






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

edits

Navigation menu