TestConfigurations_Load Operation

Applies to QAComplete 12.84 SaaS, last modified on July 19, 2021

Returns a test configuration by its ID.

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

To get several or all test configurations, use TestConfigurations_LoadByCriteria.

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) hat contains the configuration.

TestConfigurationId  :  integer, required

The test configuration ID.

Result

A TestConfiguration object that represents the desired test configuration.

Example

Sample Code

C#

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

// Specifying the desired test configuration
int ID = 158;

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 test configuration
TestConfiguration testConfig = service.TestConfigurations_Load(authData, ID);
Console.WriteLine("Loaded test configuration: {0} (Active: {1})", testConfig.ConfigurationName, testConfig.IsActive);

Java

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

// Specifying the desired test configuration
int ID = 158;

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 test configuration
TestConfiguration testConfig = service.testConfigurationsLoad(authData, ID);
System.out.format("Loaded test configuration: %s (Active: %s)%n", testConfig.getConfigurationName(), testConfig.getIsActive());

Sample Request XML

POST /psws/psws.asmx HTTP/1.1
Host: myteam.mysite.com
Content-Type: text/xml; charset=utf-8
Content-Length: 536 {Insert an appropriate value here}
SOAPAction: "http://www.pragmaticsw.com/TestConfigurations_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>
    <TestConfigurations_Load xmlns="http://www.pragmaticsw.com/">
      <AuthenticationData>
        <AppCode>agSP</AppCode>
        <DeptId>7154</DeptId>
        <ProjId>1032</ProjId>
        <UserId>25315</UserId>
        <PassCode>p@ssword</PassCode>
      </AuthenticationData>
      <TestConfigurationId>158</TestConfigurationId>
    </TestConfigurations_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: 544 {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>
    <TestConfigurations_Load xmlns="http://www.pragmaticsw.com/">
      <AuthenticationData>
        <AppCode>agSP</AppCode>
        <DeptId>7154</DeptId>
        <ProjId>1032</ProjId>
        <UserId>25315</UserId>
        <PassCode>p@ssword</PassCode>
      </AuthenticationData>
      <TestConfigurationId>158</TestConfigurationId>
    </TestConfigurations_Load>
  </soap12:Body>
</soap12:Envelope>

Sample Response XML

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: 969 {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>
    <TestConfigurations_LoadResponse xmlns="http://www.pragmaticsw.com/">
      <TestConfigurations_LoadResult>
        <ConfigId>254</ConfigId>
        <ProjId>10372</ProjId>
        <ConfigurationName>Windows 7 (32-bit)</ConfigurationName>
        <Description>Standard Windows 7 (32-bit) system environment.</Description>
        <IsActive>Y</IsActive>
        <CreateUserId>27572</CreateUserId>
        <UpdateUserId>27942</UpdateUserId>
        <DateCreated>2014-07-24T09:12:08.037</DateCreated>
        <DateUpdated>2014-07-30T13:50:24.017</DateUpdated>
        <OwnerUserId>27572</OwnerUserId>
        <OriginalId>0</OriginalId>
        <ImportId>0</ImportId>
        <OwnerName>Davis, Eugeny</OwnerName>
        <UserName>Doe, John</UserName>
        <NbrFiles>0</NbrFiles>
        <NbrNotes>0</NbrNotes>
      </TestConfigurations_LoadResult>
    </TestConfigurations_LoadResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: 979 {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>
    <TestConfigurations_LoadResponse xmlns="http://www.pragmaticsw.com/">
      <TestConfigurations_LoadResult>
        <ConfigId>254</ConfigId>
        <ProjId>10372</ProjId>
        <ConfigurationName>Windows 7 (32-bit)</ConfigurationName>
        <Description>Standard Windows 7 (32-bit) system environment.</Description>
        <IsActive>Y</IsActive>
        <CreateUserId>27572</CreateUserId>
        <UpdateUserId>27942</UpdateUserId>
        <DateCreated>2014-07-24T09:12:08.037</DateCreated>
        <DateUpdated>2014-07-30T13:50:24.017</DateUpdated>
        <OwnerUserId>27572</OwnerUserId>
        <OriginalId>0</OriginalId>
        <ImportId>0</ImportId>
        <OwnerName>Davis, Eugeny</OwnerName>
        <UserName>Doe, John</UserName>
        <NbrFiles>0</NbrFiles>
        <NbrNotes>0</NbrNotes>
      </TestConfigurations_LoadResult>
    </TestConfigurations_LoadResponse>
  </soap12:Body>
</soap12:Envelope>

See Also

TestConfigurations_Add
TestConfigurations_Delete
TestConfigurations_LoadByCriteria
TestConfigurations_Update
Test Management Operations
Test Configuration Operations
SOAP API Reference

Highlight search results