AutomationTestItems_Load Operation

Applies to QAComplete 12.80 SaaS, last modified on April 20, 2021
This functionality is provided by the automated testing bridge that allows obtaining TestComplete test results to the QAComplete Automation screen.
Starting from the release 9.9.0, this functionality is obsolete and is supported only for backward compatibility.

Returns an automation test item by its ID.

To specify a project that contains the test item, use the ProjId value in the AuthenticationData object in the request body. To search for the test item in several projects, use the ProjIds value to specify the list of projects IDs in the AuthenticationData object.

To get several or all automation test items, use AutomationTestItems_LoadByCriteria. Also, you can use AutomationTestItems_LoadByHostName to load all test items that use specific host.

Requirements

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

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 automation test item.

AutomationTestItemId  :  integer, required

Unique identifier of the desired automation test item.

Result

An AutomationTestItem object that represents the desired automation test item.

Example

Sample Code

C#

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

// Specifying the desired automation test item
int ID = 5;

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;

// Loading the automation test item
AutomationTestItem automationTestItem = service.AutomationTestItems_Load(authData, ID);
Console.WriteLine("Loaded automation test item: {0}", automationTestItem.TestName);

Java

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

// Specifying the desired automation test item
int ID = 5;

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);

// Loading the automation test item
AutomationTestItem automationTestItem = service.automationTestItemsLoad(authData, ID);
System.out.format("Loaded automation test item: %s%n", automationTestItem.getTestName());

Sample Request XML

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

<?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>
    <AutomationTestItems_Load xmlns="http://www.pragmaticsw.com/">
      <AuthenticationData>
        <AppCode>agSP</AppCode>
        <DeptId>7154</DeptId>
        <ProjId>1032</ProjId>
        <UserId>25315</UserId>
        <PassCode>p@ssword</PassCode>
      </AuthenticationData>
      <AutomationTestItemId>5</AutomationTestItemId>
    </AutomationTestItems_Load>
  </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: 546 {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>
    <AutomationTestItems_Load xmlns="http://www.pragmaticsw.com/">
      <AuthenticationData>
        <AppCode>agSP</AppCode>
        <DeptId>7154</DeptId>
        <ProjId>1032</ProjId>
        <UserId>25315</UserId>
        <PassCode>p@ssword</PassCode>
      </AuthenticationData>
      <AutomationTestItemId>5</AutomationTestItemId>
    </AutomationTestItems_Load>
  </soap12:Body>
</soap12:Envelope>

Sample Response XML

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: 1381 {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>
    <AutomationTestItems_LoadResponse xmlns="http://www.pragmaticsw.com/">
      <AutomationTestItems_LoadResult>
        <AutomationTestItemId>5</AutomationTestItemId>
        <AutomationHostId>1</AutomationHostId>
        <AutomationHostName>Test-WinXPx86</AutomationHostName>
        <TestName>Test input controls</TestName>
        <TestType>Automation Tests</TestType>
        <FullPath>\\Test-WinXPx86\Work\Tests\Release\Project.pjs</FullPath>
        <Description>Test input controls and data</Description>
        <AutomationType>TestComplete</AutomationType>
        <ProjId>10372</ProjId>
        <CreateUserId>24661</CreateUserId>
        <UpdateUserId>24661</UpdateUserId>
        <DateCreated>2014-07-29T13:24:18:027</DateCreated>
        <DateUpdated>2014-07-29T13:24:18:027</DateUpdated>
      </AutomationTestItems_LoadResult>
      <AuthenticationData>
        <AppCode>agSP</AppCode>
        <DeptId>7154</DeptId>
        <ProjId>1032</ProjId>
        <UserId>25315</UserId>
        <PassCode>p@ssword</PassCode>
      </AuthenticationData>
    </AutomationTestItems_LoadResponse>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: 1389 {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>
    <AutomationTestItems_LoadResponse xmlns="http://www.pragmaticsw.com/">
      <AutomationTestItems_LoadResult>
        <AutomationTestItemId>5</AutomationTestItemId>
        <AutomationHostId>1</AutomationHostId>
        <AutomationHostName>Test-WinXPx86</AutomationHostName>
        <TestName>Test input controls</TestName>
        <TestType>Automation Tests</TestType>
        <FullPath>\\Test-WinXPx86\Work\Tests\Release\Project.pjs</FullPath>
        <Description>Test input controls and data</Description>
        <AutomationType>TestComplete</AutomationType>
        <ProjId>10372</ProjId>
        <CreateUserId>24661</CreateUserId>
        <UpdateUserId>24661</UpdateUserId>
        <DateCreated>2014-07-29T13:24:18:027</DateCreated>
        <DateUpdated>2014-07-29T13:24:18:027</DateUpdated>
      </AutomationTestItems_LoadResult>
      <AuthenticationData>
        <AppCode>agSP</AppCode>
        <DeptId>7154</DeptId>
        <ProjId>1032</ProjId>
        <UserId>25315</UserId>
        <PassCode>p@ssword</PassCode>
      </AuthenticationData>
    </AutomationTestItems_LoadResponse>
  </soap12:Body>
</soap12:Envelope>

See Also

AutomationTestItems_Add
AutomationTestItems_Delete
AutomationTestItems_LoadByCriteria
AutomationTestItems_LoadByHostName
AutomationTestItems_Update
Automated Testing Bridge Operations
SOAP API Reference

Highlight search results