TestSteps_Update Operation

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

Gets a test step by its ID and updates its properties with specified values. All unspecified properties are cleared.

Requirements

The user must belong to a security group that has the Update privilege for Test Library.

Parameters

The operation uses the following parameters:

AuthenticationData  :  object, required

An AuthenticationData object containing the login information and the ID of the project that contains the test whose step you want to update.

TestStep  :  , required

An updated TestStep object.

SendEMailAlert  :  string, required

Y if you want to send an email alert; N otherwise.

Result

None.

Example

Sample Code

C#

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

ServiceSoapClient service = new ServiceSoapClient();

// Prepare 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 = loginInfo.ProjId;

// Prepare the TestStep object
TestStep step = new TestStep();

// Specify the step object to update
int Id = 10;

// Load existing step data
step = service.TestSteps_Load(authData, Id);

// Specify new values of the step properties
step.Step = "Select Tools from the application's main menu.";
step.ExpectedResult = "The Tools dialog opens";
step.Seq = 10;
step.IsStoppedOnFail = "Y";
// Update the step
service.TestSteps_Update(authData, step, "Y");

Java

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

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

// Prepare 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(loginInfo.getProjId());

// Prepare the TestStep object
TestStep step = new TestStep();

// Specify the step to update
int Id = 10;

// Load existing step data
step = service.testStepsLoad(authData, Id);

// Specify new values of the step properties
step.setStep("Select Tools from the application's main menu.");
step.setExpectedResult("The Tools dialog opens");
step.setSeq(10);
step.setIsStoppedOnFail("Y");
// Update the step
service.testStepsUpdate(authData, step, "Y");

Sample Request XML

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

<?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>
    <Tests_Update xmlns="http://www.pragmaticsw.com/">
      <AuthenticationData>
      </AuthenticationData>
      <TestStep>
        <TestId>1</TestId>
        <TestStepId>10</TestStepId>
        <Title>Test Tools dialog</Title>
        <Seq>4</Seq>
        <IsStoppedOnFail>Y</IsStoppedOnFail>
        <Step>Select Tools from the application's main menu.</Step>
        <ExpectedResults>The Tools dialog opens.</ExpectedResults>
        <DateCreated>2014-07-18T08:00:00</DateCreated>
        <DateUpdated>2014-07-21T10:30:00</DateUpdated>
        <CreateUserId>24661</CreateUserId>
        <UpdateUserId>26641</UpdateUserId>
        <ScriptName></ScriptName>
        <NbrFiles>0</NbrFiles>
        <ScriptSourceId>0</ScriptSourceId>
      </TestStep>
      <SendEMailAlert>Y</SendEMailAlert>
    </Tests_Update>
  </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: 898 {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>
    <Tests_Update xmlns="http://www.pragmaticsw.com/">
      <AuthenticationData>
      </AuthenticationData>
      <TestStep>
        <TestId>1</TestId>
        <TestStepId>10</TestStepId>
        <Title>Test Tools dialog</Title>
        <Seq>4</Seq>
        <IsStoppedOnFail>Y</IsStoppedOnFail>
        <Step>Select Tools from the application's main menu.</Step>
        <ExpectedResults>The Tools dialog opens.</ExpectedResults>
        <DateCreated>2014-07-18T08:00:00</DateCreated>
        <DateUpdated>2014-07-21T10:30:00</DateUpdated>
        <CreateUserId>24661</CreateUserId>
        <UpdateUserId>26641</UpdateUserId>
        <ScriptName></ScriptName>
        <NbrFiles>0</NbrFiles>
        <ScriptSourceId>0</ScriptSourceId>
      </TestStep>
      <SendEMailAlert>Y</SendEMailAlert>
    </Tests_Update>
  </soap12:Body>
</soap12:Envelope>

Sample Response XML

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: 306 {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>
    <Tests_UpdateResponse xmlns="http://www.pragmaticsw.com/" />
  </soap:Body>
</soap:Envelope>

SOAP 1.2

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: 316 {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>
    <Tests_UpdateResponse xmlns="http://www.pragmaticsw.com/" />
  </soap12:Body>
</soap12:Envelope>

See Also

TestSteps_Add
TestSteps_Delete
TestSteps_Load
TestSteps_LoadByCriteria
Test Management Operations
Test Step Operations
SOAP API Reference

Highlight search results