TestRuns_LoadByCriteria Operation

Applies to QAComplete 12.75 SaaS, last modified on April 01, 2021

Use the TestRuns_LoadByCriteria operation to:

  • Get test runs that match a specific condition. For example, run by a specific user or have the specific status.

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

The operation can get test runs from one or several projects. To specify a project to get test runs from, use the ProjId value in the AuthenticationData object in the request body. To get test runs 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 runs before returning them from QAComplete.

To get just one test run, use TestRuns_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 test runs.

Condition  :  string (max 65536 chars)

An XML-formatted string that describes the test runs 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 runs, 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 test run ID or number of failed tests. The format is:

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

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

Example values:

TestRunId
NbrFailed, TestRunId
DateStarted DESC

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

PageSize  :  integer, required

Limits the number of test runs 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 runs 1..100, PageNumber of 2 – test runs 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 TestRun objects that contain information about test runs.

Example

Sample Code

This example loads all runs of the specified test set.

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'>TestSetId</Value>
  </Items>
  <Items Type='tString'>
    <Value xsi:type='xsd:string'>254</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;

TestRun[] testRuns = new TestRun[0];
int pageNumber = 1;
do
{
  testRuns = service.TestRuns_LoadByCriteria(authData, condition, Sorting, pageSize, pageNumber);
  foreach (TestRun testRun in testRuns)
  {
    Console.WriteLine("Run of a {0} test set at {1} was {2}", testRun.TestSetName, testRun.DateStarted, testRun.StatusCode);
    }
} while (testRuns.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'>TestSetId</Value>\n" +
"  </Items>\n" +
"  <Items Type='tString'>\n" +
"    <Value xsi:type='xsd:string'>254</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 TestRun objects
List<TestRun> testRuns;
int pageNumber = 1;

do
{
  testRuns = service.testRunsLoadByCriteria(authData, condition, sorting, pageSize, pageNumber).getTestRun();
  for (TestRun testRun : testRuns)
  {
    System.out.format("Run of a %s test set at %s was %s%n", testRun.getTestSetName(), testRun.getDateStarted(), testRun.getStatusCode());
  }
  pageNumber++;
} while (testRuns.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: 1023 {Insert an appropriate value here}
SOAPAction: "http://www.pragmaticsw.com/TestRuns_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>
    <TestRuns_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'>TestSetId</Value>
          </Items>
          <Items Type='tString'>
            <Value xsi:type='xsd:string'>254</Value>
          </Items>
        </Conditions>]]>
      
</Condition>
      <Sorting></Sorting>
      <PageSize>200</PageSize>
      <PageNumber>1</PageNumber>
    </TestRuns_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: 1031 {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>
    <TestRuns_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'>TestSetId</Value>
          </Items>
          <Items Type='tString'>
            <Value xsi:type='xsd:string'>254</Value>
          </Items>
        </Conditions>]]>
      
</Condition>
      <Sorting></Sorting>
      <PageSize>200</PageSize>
      <PageNumber>1</PageNumber>
    </TestRuns_LoadByCriteria>
  </soap12:Body>
</soap12:Envelope>

Sample Response XML

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: 1835 {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>
    <TestRuns_LoadByCriteriaResponse xmlns="http://www.pragmaticsw.com/">
      <TestRuns_LoadByCriteriaResult>
        <TestRun>
          <TestRunId>358</TestRunId>
          <TestSetId>0</TestSetId>
          <TestConfigId>24</TestConfigId>
          <ConfigurationName>Windows 7 (32-bit)</ConfigurationName>
          <ReleaseId>14</ReleaseId>
          <ProjId>10372</ProjId>
          <RunByUserId>27942</RunByUserId>
          <RunByUserName>Doe, John</RunByUserName>
          <IsSequential>N</IsSequential>
          <StatusCode>Awaiting Run</StatusCode>
          <ExecutionType>Manual</ExecutionType>
          <DateStarted>2014-07-29T13:24:18:027</DateStarted>
          <DateFinished>0001-01-01T00:00:00</DateFinished>
          <NbrTests>1</NbrTests>
          <NbrPassed>0</NbrPassed>
          <NbrFailed>0</NbrFailed>
          <NbrBlocked>0</NbrBlocked>
          <NbrAwaitingRun>1</NbrAwaitingRun>
          <RunTime>0</RunTime>
          <RunTimeFormated>00:00:00</RunTimeFormated>
          <TestId>2112</TestId>
          <HostId>167</HostId>
        </TestRun>
        <TestRun>
          <TestRunId>484</TestRunId>
          <TestSetId>0</TestSetId>
          <TestConfigId>38</TestConfigId>
          <ConfigurationName>Windows 8 (64-bit)</ConfigurationName>
          <ReleaseId>14</ReleaseId>
          <ProjId>10372</ProjId>
          <RunByUserId>27942</RunByUserId>
          <RunByUserName>Doe, John</RunByUserName>
          <IsSequential>N</IsSequential>
          <StatusCode>Failed</StatusCode>
          <ExecutionType>Manual</ExecutionType>
          <DateStarted>2014-07-27T17:18:24:014</DateStarted>
          <DateFinished>2014-07-27T17:18:24:014</DateFinished>
          <NbrTests>1</NbrTests>
          <NbrPassed>0</NbrPassed>
          <NbrFailed>1</NbrFailed>
          <NbrBlocked>0</NbrBlocked>
          <NbrAwaitingRun>0</NbrAwaitingRun>
          <RunTime>14</RunTime>
          <RunTimeFormated>00:00:14</RunTimeFormated>
          <TestId>2113</TestId>
          <HostId>168</HostId>
        </TestRun>
      </TestRuns_LoadByCriteriaResult>
    </TestRuns_LoadByCriteriaResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: 1845 {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>
    <TestRuns_LoadByCriteriaResponse xmlns="http://www.pragmaticsw.com/">
      <TestRuns_LoadByCriteriaResult>
        <TestRun>
          <TestRunId>358</TestRunId>
          <TestSetId>0</TestSetId>
          <TestConfigId>24</TestConfigId>
          <ConfigurationName>Windows 7 (32-bit)</ConfigurationName>
          <ReleaseId>14</ReleaseId>
          <ProjId>10372</ProjId>
          <RunByUserId>27942</RunByUserId>
          <RunByUserName>Doe, John</RunByUserName>
          <IsSequential>N</IsSequential>
          <StatusCode>Awaiting Run</StatusCode>
          <ExecutionType>Manual</ExecutionType>
          <DateStarted>2014-07-29T13:24:18:027</DateStarted>
          <DateFinished>0001-01-01T00:00:00</DateFinished>
          <NbrTests>1</NbrTests>
          <NbrPassed>0</NbrPassed>
          <NbrFailed>0</NbrFailed>
          <NbrBlocked>0</NbrBlocked>
          <NbrAwaitingRun>1</NbrAwaitingRun>
          <RunTime>0</RunTime>
          <RunTimeFormated>00:00:00</RunTimeFormated>
          <TestId>2112</TestId>
          <HostId>167</HostId>
        </TestRun>
        <TestRun>
          <TestRunId>484</TestRunId>
          <TestSetId>0</TestSetId>
          <TestConfigId>38</TestConfigId>
          <ConfigurationName>Windows 8 (64-bit)</ConfigurationName>
          <ReleaseId>14</ReleaseId>
          <ProjId>10372</ProjId>
          <RunByUserId>27942</RunByUserId>
          <RunByUserName>Doe, John</RunByUserName>
          <IsSequential>N</IsSequential>
          <StatusCode>Failed</StatusCode>
          <ExecutionType>Manual</ExecutionType>
          <DateStarted>2014-07-27T17:18:24:014</DateStarted>
          <DateFinished>2014-07-27T17:18:24:014</DateFinished>
          <NbrTests>1</NbrTests>
          <NbrPassed>0</NbrPassed>
          <NbrFailed>1</NbrFailed>
          <NbrBlocked>0</NbrBlocked>
          <NbrAwaitingRun>0</NbrAwaitingRun>
          <RunTime>14</RunTime>
          <RunTimeFormated>00:00:14</RunTimeFormated>
          <TestId>2113</TestId>
          <HostId>168</HostId>
        </TestRun>
      </TestRuns_LoadByCriteriaResult>
    </TestRuns_LoadByCriteriaResponse>
  </soap12:Body>
</soap12:Envelope>

See Also

TestRuns_Add
TestRuns_Load
TestRuns_Update
Test Management Operations
Test Run Operations
SOAP API Reference

Highlight search results