|
|
| (One intermediate revision by the same user not shown) |
| Line 1: |
Line 1: |
| __NOEDITSECTION__
| | see http://landfill.bugzilla.org/testopia2/docs/html/api/Bugzilla/WebService/Testopia/TestCase.html |
| Back to [[Testopia:Documentation:XMLRPC |Testopia XML-RPC API]]
| |
| | |
| ==TestCase==
| |
| | |
| ===Description===
| |
| Each test case must be linked to one or more test plans.
| |
| | |
| ===Hiearchy===
| |
| Bugzilla::WebService::Testopia::TestCase
| |
| | |
| ===Attributes===
| |
| | |
| {| border=1 cellpadding=4
| |
| | '''Attribute''' || '''Data Type''' || '''Comments'''
| |
| |-
| |
| | alias || string ||
| |
| |-
| |
| | arguments || string ||
| |
| |-
| |
| | author || string ||
| |
| |-
| |
| | case_id || integer ||
| |
| |-
| |
| | case_status || string ||
| |
| |-
| |
| | category || string ||
| |
| |-
| |
| | creation_date || string || Format: yyyy-mm-dd hh:mm:ss
| |
| |-
| |
| | default_tester || string ||
| |
| |-
| |
| | isautomated || integer ||
| |
| |-
| |
| | priority || string ||
| |
| |-
| |
| | requirement || string ||
| |
| |-
| |
| | script || string ||
| |
| |-
| |
| | summary || string ||
| |
| |-
| |
| | sortkey || string ||
| |
| |-
| |
| |}
| |
| | |
| | |
| ===Methods===
| |
| | |
| ----
| |
| ====get - Get A TestCase by ID====
| |
| ----
| |
| | |
| =====Usage=====
| |
| TestCase.get
| |
| | |
| =====Parameters=====
| |
| {| border=1 cellpadding=4
| |
| | '''Parameter''' || '''Data Type''' || '''Comments'''
| |
| |-
| |
| | case_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".
| |
| | |
| | |
| | |
| ----
| |
| | |
| ====list - Get A List of TestCases Based on A Query====
| |
| ----
| |
| | |
| =====Usage=====
| |
| TestCase.list
| |
| | |
| =====Parameters=====
| |
| {| border=1 cellpadding=4
| |
| | '''Parameter''' || '''Data Type''' || '''Comments'''
| |
| |-
| |
| | query || string || Can not be null or an empty string. See [[Bugzilla_XML-RPC_API_Query_Examples |Query Examples]].
| |
| |-
| |
| |}
| |
| | |
| | |
| =====Result=====
| |
| An array of TestCase hash maps or a hash map containing values for the keys, "faultcode" and "faultstring".
| |
| | |
| | |
| ----
| |
| ====create - Create A New TestCase====
| |
| ----
| |
| | |
| =====Usage=====
| |
| TestCase.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: author, case_status, category, and isautomated.
| |
| | |
| | |
| =====Result=====
| |
| An integer value representing the new case_id or a hash map containing values for the keys, "faultcode" and "faultstring".
| |
| | |
| | |
| | |
| ----
| |
| ====update - Update An Existing TestCase====
| |
| ----
| |
| | |
| =====Usage=====
| |
| TestCase.update
| |
| | |
| =====Parameters=====
| |
| {| border=1 cellpadding=4
| |
| | '''Parameter''' || '''Data Type''' || '''Comments'''
| |
| |-
| |
| | case_id || integer ||
| |
| |-
| |
| | new_values || hashmap || case_id can not be modified.
| |
| |-
| |
| |}
| |
| | |
| | |
| =====Result=====
| |
| The integer value, 0, on success or a hash map containing values for the keys, "faultcode" and "faultstring".
| |
| | |
| | |
| | |
| ----
| |
| ====get_text - Get TestCase's Current Action/Effect Document====
| |
| ----
| |
| | |
| =====Usage=====
| |
| TestCase.get_text
| |
| | |
| =====Parameters=====
| |
| {| border=1 cellpadding=4
| |
| | '''Parameter''' || '''Data Type''' || '''Comments'''
| |
| |-
| |
| | case_id || integer ||
| |
| |-
| |
| |}
| |
| | |
| | |
| =====Result=====
| |
| A hash map of key/value pairs for the attributes of a TestCase document or a hash map containing values for the keys, "faultcode" and "faultstring".
| |
| | |
| Attributes of a TestCase document are action, author, effect, and version.
| |
| | |
| | |
| | |
| ----
| |
| ====set_text - Add A New TestCase Action/Effect Document====
| |
| ----
| |
| | |
| =====Usage=====
| |
| TestCase.set_text | |
| | |
| =====Parameters=====
| |
| {| border=1 cellpadding=4
| |
| | '''Parameter''' || '''Data Type''' || '''Comments'''
| |
| |-
| |
| | case_id || integer ||
| |
| |-
| |
| | author || string ||
| |
| |-
| |
| | action || string ||
| |
| |-
| |
| | effect || string ||
| |
| |-
| |
| |}
| |
| | |
| | |
| =====Result=====
| |
| The new document version on success or a hash map containing values for the keys, "faultcode" and "faultstring".
| |
| | |
| | |
| | |
| <br>Back to the [[Testopia |Testopia Main Page]]
| |