AutomationSchedules_Load Operation

Applies to QAComplete 12.70 SaaS, last modified on January 11, 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 schedule by its ID.

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

To get several or all automation schedules, use AutomationSchedules_LoadByCriteria. Also, you can use AutomationSchedules_LoadTestsByTimeSpan to load all schedules in the specified time span.

Requirements

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

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 schedule.

AutomationScheduleId  :  integer, required

Unique identifier of the desired automation schedule.

Result

An AutomationSchedule object that represents the desired automation schedule.

Example

Sample Code

C#

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

// Specifying the desired automation schedule
int ID = 4;

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 schedule
AutomationSchedule automationSchedule = service.AutomationSchedules_Load(authData, ID);
Console.WriteLine("{0} test is scheduled from {1} to {2} at ", automationSchedule.AutomationType, automationSchedule.DateBegin, automationSchedule.DateEnd, automationSchedule.TimeRun);

Java

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

// Specifying the automation schedule
int ID = 4;

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 schedule
AutomationSchedule automationSchedule = service.automationSchedulesLoad(authData, ID);
System.out.format("%s test is scheduled from %s to %s at %s%n", automationSchedule.getAutomationType(), automationSchedule.getDateBegin(), automationSchedule.getDateEnd(), automationSchedule.getTimeRun());

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/AutomationSchedules_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>
    <AutomationSchedules_Load xmlns="http://www.pragmaticsw.com/">
      <AuthenticationData>
        <AppCode>agSP</AppCode>
        <DeptId>7154</DeptId>
        <ProjId>1032</ProjId>
        <UserId>25315</UserId>
        <PassCode>p@ssword</PassCode>
      </AuthenticationData>
      <AutomationScheduleId>4</AutomationScheduleId>
    </AutomationSchedules_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>
    <AutomationSchedules_Load xmlns="http://www.pragmaticsw.com/">
      <AuthenticationData>
        <AppCode>agSP</AppCode>
        <DeptId>7154</DeptId>
        <ProjId>1032</ProjId>
        <UserId>25315</UserId>
        <PassCode>p@ssword</PassCode>
      </AuthenticationData>
      <AutomationScheduleId>4</AutomationScheduleId>
    </AutomationSchedules_Load>
  </soap12:Body>
</soap12:Envelope>

Sample Response XML

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: 1011 {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>
    <AutomationSchedules_LoadResponse xmlns="http://www.pragmaticsw.com/">
      <AutomationSchedules_LoadResult>
        <AutomationScheduleId>4</AutomationScheduleId>
        <AutomationTestItemId>5</AutomationTestItemId>
        <DateBegin>2014-08-10T00:00:00</DateBegin>
        <DateEnd>2014-08-15T00:00:00</DateEnd>
        <DaysRun>5</DaysRun>
        <TimeRun>10:00 AM</TimeRun>
        <Status>Pending</Status>
        <ProjId>10372</ProjId>
        <CreateUserId>24661</CreateUserId>
        <UpdateUserId>24661</UpdateUserId>
        <DateCreated>2014-08-04T21:12:13:024</DateCreated>
        <DateUpdated>2014-08-04T21:12:13:024</DateUpdated>
        <RunASAP>false</RunASAP>
        <TestType>pjs</TestType>
        <AutomationType>TestComplete</AutomationType>
        <SuitePath>\\Test-WinXPx86\Work\Tests\Release\Project.pjs</SuitePath>
      </AutomationSchedules_LoadResult>
    </AutomationSchedules_LoadResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: 1021 {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>
    <AutomationSchedules_LoadResponse xmlns="http://www.pragmaticsw.com/">
      <AutomationSchedules_LoadResult>
        <AutomationScheduleId>4</AutomationScheduleId>
        <AutomationTestItemId>5</AutomationTestItemId>
        <DateBegin>2014-08-10T00:00:00</DateBegin>
        <DateEnd>2014-08-15T00:00:00</DateEnd>
        <DaysRun>5</DaysRun>
        <TimeRun>10:00 AM</TimeRun>
        <Status>Pending</Status>
        <ProjId>10372</ProjId>
        <CreateUserId>24661</CreateUserId>
        <UpdateUserId>24661</UpdateUserId>
        <DateCreated>2014-08-04T21:12:13:024</DateCreated>
        <DateUpdated>2014-08-04T21:12:13:024</DateUpdated>
        <RunASAP>false</RunASAP>
        <TestType>pjs</TestType>
        <AutomationType>TestComplete</AutomationType>
        <SuitePath>\\Test-WinXPx86\Work\Tests\Release\Project.pjs</SuitePath>
      </AutomationSchedules_LoadResult>
    </AutomationSchedules_LoadResponse>
  </soap12:Body>
</soap12:Envelope>

See Also

AutomationSchedules_Add
AutomationSchedules_Delete
AutomationSchedules_IsTestsByTimeSpanExist
AutomationSchedules_LoadByCriteria
AutomationSchedules_LoadTestsByTimeSpan
AutomationSchedules_Update
Automated Testing Bridge Operations
SOAP API Reference

Highlight search results