TestCase Object

Applies to QAComplete 12.71 SaaS, last modified on January 19, 2021
This topic relates to the legacy Test Cases screen that provided basic test management functionality and was replaced with Test Management.
Starting from release 9.7.0, this functionality is obsolete and is supported only for backward compatibility.

A TestCase object represents a test case in QAComplete. Using QAComplete SOAP API, you can add, enumerate, update, and delete test cases.

Some string property values (for example, StatusCode) are based on choice lists defined in your QAComplete project. You can find these values in Test Management > Test Cases > Actions > Manage Choice Lists.

Note: The choice list of the StatusCode property requires the Passed and Failed values.

Requirements

To manage test cases, the web service user must be in a security group that has the corresponding privileges – Read, Add, Update, or Delete – for Test Cases. You can view or set these privileges in  > Setup > Security > Security Groups > Manage Security Rights > select user group.

Properties

Custom1 … Custom10  :  string (max 8000 chars)

Values of custom fields 1 to 10.

Custom11 … Custom90  :  string (max 100 chars)

Values of custom fields 11 to 90.

CustomFieldName1 … CustomFieldName90  :  string (max 30 chars)

The names of custom fields.

CustomFields  :  array of strings

An array of custom field values.

CustomFieldNames  :  array of strings

An array of custom field names.

TestCaseId  :  integer

The unique identifier of the test case.

Title  :  string (max 100 chars)

The test case title (subject).

XML entities in the title are double encoded:

& – &

< – &amp;#60;

> – &amp;#62;

StatusCode  :  string (max 100 chars)

The test case status based on a choice list.

FunctSpecId  :  integer

The ID of the linked requirement.

Grouping  :  string (max 50 chars)

The name of the group that contains the test case based on a choice list.

SubGrouping  :  string (max 50 chars)

The name of the group that contains the test case based on a choice list.

Keywords  :  string (max 200 chars)

Keywords that associated with the test case.

Steps  :  string

Steps to be performed in the test case. Can include an HTML markup.

ExpectedResults  :  string

The description of the expected results after performing the steps. Can include an HTML markup.

OwnerUserId  :  integer

The ID of the user who owns the test case.

AssigneeUserId  :  integer

The ID of the user the test case is assigned to, or 0 if the test case is not assigned to anyone.

FolderId  :  integer

The ID of the folder containing the test case, or 0 if the test case is not in any folder.

EstHrs  :  decimal

Estimated hours for completing the test case. Default: 0.

EstStart  :  dateTime

The estimated start date of performing the test case.

EstFinish  :  dateTime

The estimated finish date of performing the test case.

PctComplete  :  integer

The percentage complete of performing test case. Default: 0.

ActHrs  :  decimal

Actual hours spent on performing the test case. Default: 0.

ActualStart  :  dateTime

The actual start date of performing the test case.

ActFinish  :  dateTime

The actual date when the test case was finished.

EstHrsRemaining  :  decimal

Estimated remaining hours for finishing test case. Default: 0.

AutomationScriptUNC  :  string (max 255 chars)

The UNC address of the test script to automate the test case.

ActualResults  :  string

Actual results of the test case steps performing as compared to the expected results. Can include an HTML markup. Default value: empty string.

AssignedToName  :  string (max 78 chars)

The name of the user assigned to the test case, in the Lastname, Firstname format.

DateCreated  :  dateTime

The date and time the test case was created.

DateUpdated  :  dateTime

The date and time the test case was last updated.

FolderName  :  string (max 511 chars)

The name of the folder containing the test case, in the ParentFolder/Subfolder/Subfolder format.

null if the test case is not in a folder.

FunctSpecTitle  :  string (max 100 chars)

Requirement name.

ImportId  :  integer

For importing: the import batch number. Default: 0.

NbrFiles  :  integer

The number of files attached to the test case. Default: 0.

NbrNotes  :  integer

The number of notes attached to the test case. Default: 0.

NbrTasks  :  integer

The number of tasks attached to the test case. Default: 0.

NotesDescription  :  string (max 255 chars)

The latest note attached to the test case. Can include an HTML markup.

OwnerName  :  string (max 78 chars)

The name of the user who owns the test case, in the Lastname, Firstname format.

ProjId  :  integer

The ID of the QAComplete project that contains the test case.

UpdateUserId  :  integer (max 4 chars)

The ID of the user who last updated the test case.

UserName  :  string (max 78 chars)

The name of the user who last updated the test case, in the Lastname, Firstname format.

Relevant Operations

Example

XML

<TestCase>
<TestCaseId>156</TestCaseId>
<Title>Test internal text editor</Title>
<StatusCode>Active</StatusCode>
<Steps><![CDATA[<ol><li>Click Tools > Notepad.</li><li>Enter "Test text".</li><li>Close the Notepad dialog.</li></ol>]]></Steps>
<ExpectedResults>Offer to save the text must be shown.</ExpectedResults>
<OwnerUserId>27572</OwnerUserId>
<AssigneeUserId>27942</AssigneeUserId>
<EstHrs>0.083</EstHrs>
<EstStart>2014-06-10T10:00:00</EstStart>
<EstFinish>2014-06-10T10:05:00</EstFinish>
<PctComplete>00</PctComplete>
<ActHrs>0.000</ActHrs>
<ActualStart>0001-01-01T00:00:00</ActualStart>
<ActFinish>0001-01-01T00:00:00</ActFinish>
<EstHrsRemaining>0.000</EstHrsRemaining>
<AssignedToName>Doe, John</AssignedToName>
<DateCreated>2014-05-30T14:01:51.057</DateCreated>
<DateUpdated>2014-05-30T14:01:51.057</DateUpdated>
<FolderName>FamilyAlbum/Release 1.1/Iteration 1</FolderName>
<ImportId>0</ImportId>
<NbrFiles>0</NbrFiles>
<NbrNotes>0</NbrNotes>
<NbrTasks>0</NbrTasks>
<OwnerName>Davis, Eugeny</OwnerName>
<ProjId>17823</ProjId>
<UpdateUserId>27534</UpdateUserId>
<UserName>Fry, Alex</UserName>
</TestCase>

See Also

TestCases_Add Operation
TestCases_Load Operation
Test Cases Operations (Releases 9.6.0 and Earlier)

Highlight search results