Testopia:Documentation:XMLRPC:TestCase
Back to Testopia XML-RPC API
TestCase
Description
Each test case must be linked to one or more test plans.
Hiearchy
Bugzilla::WebService::Testopia::TestCase
Attributes
| 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
| 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
| Parameter | Data Type | Comments |
| query | string | Can not be null or an empty string. See 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
| Parameter | Data Type | Comments |
| new_values | hashmap | See required attributes list1 below. |
1 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
| 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
| 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
| 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".
Back to the Testopia Main Page