TestRunResults_LoadByCriteria Operation

Applies to QAComplete 12.93 SaaS, last modified on November 01, 2021

Use the TestRunResults_LoadByCriteria operation to:

  • Get test run results that match a specific condition. For example, that relate to the specific step or have the specific status.

  • Get all test run results in QAComplete projects (if no condition is specified).

The operation can get test run results from one or several projects. To specify a project to get test run results from, use the ProjId value in the AuthenticationData object in the request body. To get test run results from several projects, use the ProjIds value in the AuthenticationData object to specify the list of project IDs.

LoadByCriteria returns results in pages (subsets of data) rather than all at once. Pagination is controlled by the PageSize and PageNumber parameters. For information about working with paginated results, see LoadByCriteria Operations.

You can use the Sorting parameter to sort the test run results before returning them from QAComplete.

To get just one result, use TestRunResults_Load.

Requirements

The authenticating user must belong to a user group that has the Read privilege for Test Library.

Parameters

The operation uses the following parameters:

AuthenticationData  :  AuthenticationData, required

An AuthenticationData object with the login information and the ID of the project (or the list of project IDs) that contains the related tests.

Condition  :  string (max 65536 chars)

An XML-formatted string that describes the test run results you want to get. For the syntax and examples, see Condition Syntax.

If you create SOAP requests manually, place the condition string inside CDATA.

To get all test run results, use an empty string or a null value.

Sorting  :  string (max 512 chars)

The order to sort the results before returning them from the web service. For example, by the identifier of the related step or by the ordinal number. The format is:

Property1 [ASC | DESC ][, Property2 [ASC | DESC ]] [, ...]]]

where property names are those of the TestRunResult object. If you omit ASC or DESC after a property name, test run results are sorted in ascending order.

Example values:

TestRunResultId
TestRunItem, Seq
StatusCode DESC

To keep the default sort order, use an empty string or a null value.

PageSize  :  integer, required

Limits the number of test run results to return in one page. Possible values: 1..200.

The last page may have less items than PageSize. This means the end of the result set.

PageNumber  :  integer, required

A number starting from 1 that specifies the data page to return in the response. To get all pages, send several requests with increasing PageNumber values. For example, if PageSize is 100, PageNumber of 1 will return test run results 1..100, PageNumber of 2 – test run results 101..200 and so on.

If PageNumber exceeds the range, an empty array is returned. If PageNumber is the last page, this page may have less items than PageSize.

Result

An array of TestRunResult objects that contain information about test steps results.

Example

Sample Code

This example loads all test run results of the specified test run item.

C#

string login = "john.doe@example.com";
string password = "p@ssword";
int projID = 10372;

// Specifying the condition
string condition =
@"<Conditions xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
              xmlns:xsd='http://www.w3.org/2001/XMLSchema'
              Operation='opEQU'>
  <Items Type='tField'>
    <Value xsi:type='xsd:string'>TestRunItemId</Value>
  </Items>
  <Items Type='tString'>
    <Value xsi:type='xsd:string'>1354</Value>
  </Items>
</Conditions>";
string Sorting = "";
int pageSize = 200;

ServiceSoapClient service = new ServiceSoapClient();

// Preparing AuthenticationData
LoginInfo loginInfo = service.GetLoginInfo("", login, password);
AuthenticationData authData = new AuthenticationData();
authData.AppCode = loginInfo.AppCode;
authData.UserId = loginInfo.UserId;
authData.PassCode = password;
authData.DeptId = loginInfo.DeptId;
authData.ProjId = projID;

TestRunResult[] testRunResults = new TestRunResult[0];
int pageNumber = 1;
do
{
  // Loading test run results
  testRunResults = service.TestRunResults_LoadByCriteria(authData, condition, Sorting, pageSize, pageNumber);
  foreach (TestRunResult testRunResult in testRunResults)
  {
    Console.WriteLine("Run of the test step {0} is (1} with actual results: {2}", testRunResult.Step, testRunResult.StatusCode, testRunResult.ActualResult);
    }
} while (testRunResults.Length == pageSize);

Java

String login = "john.doe@example.com";
String password = "p@ssword";
int projID = 10372;

// Specifying the desired condition
String condition =
"<Conditions xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' \n" +
"            xmlns:xsd='http://www.w3.org/2001/XMLSchema'\n" +
"            Operation='opEQU'>\n" +
"  <Items Type='tField'>\n" +
"    <Value xsi:type='xsd:string'>TestRunItemId</Value>\n" +
"  </Items>\n" +
"  <Items Type='tString'>\n" +
"    <Value xsi:type='xsd:string'>1354</Value>\n" +
"  </Items>\n" +
"</Conditions>\n";

int pageSize = 200;
String sorting = "";

ServiceSoap service = new Service().getServiceSoap12();

// Preparing AuthenticationData
LoginInfo loginInfo = service.getLoginInfo("", login, password);
AuthenticationData authData = new AuthenticationData();
authData.setAppCode(loginInfo.getAppCode());
authData.setUserId(loginInfo.getUserId());
authData.setPassCode(password);
authData.setDeptId(loginInfo.getDeptId());
authData.setProjId(projID);

// Preparing TestRunResult objects
List<TestRunResult> testRunResults;
int pageNumber = 1;

do
{
  // Loading test run results
  testRunResults = service.testRunResultsLoadByCriteria(authData, condition, sorting, pageSize, pageNumber).getTestRunResult();
  for (TestRunResult testRunResult : testRunResults)
  {
    System.out.format("Run of the test step %s is %s with actual results: %s%n", TestRunResult.getStep(), TestRunResult.getStatusCode(), TestRunResult.getActualResult());
  }
  pageNumber++;
} while (testRunResults.size() == pageSize);

Sample Request XML

POST /psws/psws.asmx HTTP/1.1
Host: myteam.mysite.com
Content-Type: text/xml; charset=utf-8
Content-Length: 1040 {Insert an appropriate value here}
SOAPAction: "http://www.pragmaticsw.com/TestRunResults_LoadByCriteria"
 

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <TestRunResults_LoadByCriteria xmlns="http://www.pragmaticsw.com/">
      <AuthenticationData>
        <AppCode>agSP</AppCode>
        <DeptId>7154</DeptId>
        <ProjId>1032</ProjId>
        <UserId>25315</UserId>
        <PassCode>p@ssword</PassCode>
      </AuthenticationData>
      <Condition>
        <![CDATA[<Conditions xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
                             xmlns:xsd='http://www.w3.org/2001/XMLSchema'
                             Operation='opEQU'>
          <Items Type='tField'>
            <Value xsi:type='xsd:string'>TestRunItemId</Value>
          </Items>
          <Items Type='tString'>
            <Value xsi:type='xsd:string'>1354</Value>
          </Items>
        </Conditions>]]>
      
</Condition>
      <Sorting></Sorting>
      <PageSize>200</PageSize>
      <PageNumber>1</PageNumber>
    </TestRunResults_LoadByCriteria>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

POST /psws/psws.asmx HTTP/1.1
Host: myteam.mysite.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: 1048 {Insert an appropriate value here}
 

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <TestRunResults_LoadByCriteria xmlns="http://www.pragmaticsw.com/">
      <AuthenticationData>
        <AppCode>agSP</AppCode>
        <DeptId>7154</DeptId>
        <ProjId>1032</ProjId>
        <UserId>25315</UserId>
        <PassCode>p@ssword</PassCode>
      </AuthenticationData>
      <Condition>
        <![CDATA[<Conditions xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
                             xmlns:xsd='http://www.w3.org/2001/XMLSchema'
                             Operation='opEQU'>
          <Items Type='tField'>
            <Value xsi:type='xsd:string'>TestRunItemId</Value>
          </Items>
          <Items Type='tString'>
            <Value xsi:type='xsd:string'>1354</Value>
          </Items>
        </Conditions>]]>
      
</Condition>
      <Sorting></Sorting>
      <PageSize>200</PageSize>
      <PageNumber>1</PageNumber>
    </TestRunResults_LoadByCriteria>
  </soap12:Body>
</soap12:Envelope>

Sample Response XML

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: 1198 {The server returns an appropriate value here}
 

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <TestRunResults_LoadByCriteriaResponse xmlns="http://www.pragmaticsw.com/">
      <TestRunResults_LoadByCriteriaResult>
        <TestRunResult>
          <TestRunResultId>2157</TestRunResultId>
          <TestRunItemId>1354</TestRunItemId>
          <Seq>1</Seq>
          <StatusCode>Failed</StatusCode>
          <Step>Select Tools from the application's main menu.</Step>
          <ExpectedResults>The Tools dialog opens.</ExpectedResults>
          <ActualResults>An error occurred when you click <b>Tools</b>.</ActualResults>
          <TestStepId>10</TestStepId>
          <ProjId>10372</ProjId>
        </TestRunResult>
        <TestRunResult>
          <TestRunResultId>2158</TestRunResultId>
          <TestRunItemId>1354</TestRunItemId>
          <Seq>2</Seq>
          <StatusCode>Blocked</StatusCode>
          <Step>Switch to the Java tabbed page.</Step>
          <ExpectedResults>The Java tab shows the path to the Java Virtual machine module.</ExpectedResults>
          <ActualResults></ActualResults>
          <TestStepId>11</TestStepId>
          <ProjId>10372</ProjId>
        </TestRunResult>
      </TestRunResults_LoadByCriteriaResult>
    </TestRunResults_LoadByCriteriaResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: 1208 {The server returns an appropriate value here}
 

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <TestRunResults_LoadByCriteriaResponse xmlns="http://www.pragmaticsw.com/">
      <TestRunResults_LoadByCriteriaResult>
        <TestRunResult>
          <TestRunResultId>2157</TestRunResultId>
          <TestRunItemId>1354</TestRunItemId>
          <Seq>1</Seq>
          <StatusCode>Failed</StatusCode>
          <Step>Select Tools from the application's main menu.</Step>
          <ExpectedResults>The Tools dialog opens.</ExpectedResults>
          <ActualResults>An error occurred when you click <b>Tools</b>.</ActualResults>
          <TestStepId>10</TestStepId>
          <ProjId>10372</ProjId>
        </TestRunResult>
        <TestRunResult>
          <TestRunResultId>2158</TestRunResultId>
          <TestRunItemId>1354</TestRunItemId>
          <Seq>2</Seq>
          <StatusCode>Blocked</StatusCode>
          <Step>Switch to the Java tabbed page.</Step>
          <ExpectedResults>The Java tab shows the path to the Java Virtual machine module.</ExpectedResults>
          <ActualResults></ActualResults>
          <TestStepId>11</TestStepId>
          <ProjId>10372</ProjId>
        </TestRunResult>
      </TestRunResults_LoadByCriteriaResult>
    </TestRunResults_LoadByCriteriaResponse>
  </soap12:Body>
</soap12:Envelope>

See Also

TestRunResults_Load
TestRunResults_Update
Test Management Operations
Test Run Results Operations
SOAP API Reference

Highlight search results