TestSetItems_Update Operation

Applies to QAComplete�14.4, last modified on June 20, 2024

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

Note: The method does not update the properties of the appropriate test to which the test item corresponds. To update properties of a desired test, use the Tests_Update method.

Requirements

The user must belong to a security group that has the following privileges:

  • The Read privilege for Test Library.

  • The Update privilege for Test Management > Test Sets.

Parameters

The operation uses the following parameters:

AuthenticationData  :  object, required

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

TestSetItem  :  , required

An updated TestSetItem object.

SendEMailAlert  :  string, required

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

Result

None.

Remarks

The TestSetItem object has matching Id and Name properties, for example, FolderId and FolderName. To set them, specify the value only for the Id property. The corresponding Name property will be set automatically.

Example

Sample Code
C#
Java

C#

string login = "[email protected]";
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 TestSetItem object
TestSetItem item = new TestSetItem();

// Get the existing test set item to update
int itemId = 1;

item = service.TestSetItems_Load(authData, itemId);

// Specify new values for the item properties
item.Seq = 2;
item.IsStoppedOnFail = "Y";

// Update the test set item
service.TestSetItems_Update(authData, item, "N");

Java

String login = "[email protected]";
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 TestSetItem object
TestSetItem item = new TestSetItem();

// Get the existing test set item to update
int itemId = 1;

item = service.testSetItemsLoad(authData, itemId);

// Specify new values for item properties
item.setSeq(2);
item.setIsStoppedOnFail("Y");

// Update the test set item
service.testSetItemsUpdate(authData, item, "N");

Sample Request XML
SOAP 1.1
SOAP 1.2

POST /psws/psws.asmx HTTP/1.1
Host: myteam.mysite.com
Content-Type: text/xml; charset=utf-8
Content-Length: 2210 {Insert an appropriate value here}
SOAPAction: "http://www.pragmaticsw.com/TestSetItems_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>
    <TestSetItems_Update xmlns="http://www.pragmaticsw.com/">
      <AuthenticationData>
      </AuthenticationData>
      <TestSetItem>
        <TestSetItemId>1</TestSetItemId>
        <TestSetId>1</TestSetId>
        <TestId>1</TestId>
        <Seq>1</Seq>
        <IsActive>Y</IsActive>
        <IsStoppedOnFail>Y</IsStoppedOnFail>
        <DateCreated>2014-07-17T08:30:28</DateCreated>
        <DateUpdated>2014-07-20T10:53:07</DateUpdated>
        <CreateUserId>24661</CreateUserId>
        <UpdateUserId>24661</UpdateUserId>
        <FolderName>Regression Tests</FolderName>
        <AssignedToName>Doe, John</AssignedToName>
        <UserName>Doe, John</UserName>
        <OwnerName>Doe, John</OwnerName>
        <LastRunByName>Doe, John</LastRunByName>
        <Version>2</Version>
        <ProjId>11873</ProjId>
        <FolderId>12</FolderId>
        <Title>Test input data</Title>
        <TestIsActive>Y</TestIsActive>
        <StatusCode>Approved</StatusCode>
        <ExecutionType>Manual</ExecutionType>
        <TestType>Regression</TestType>
        <Priority>2-Medium</Priority>
        <TestDateCreated>2014-07-17T08:30:28</TestDateCreated>
        <TestDateUpdated>2014-07-20T10:53:07</TestDateUpdated>
        <TestCreateUserId>24661</TestCreateUserId>
        <TestUpdateUserId>24661</TestUpdateUserId>
        <AssigneeUserId>24661</AssigneeUserId>
        <OwnerUserId>24661</OwnerUserId>
        <OriginalId>0</OriginalId>
        <ImportId>0</ImportId>
        <ScriptSourceId>0</ScriptSourceId>
        <NbrFailStatus>2</NbrFailStatus>
        <NbrPassStatus>4</NbrPassStatus>
        <AvgRunTime>375</AvgRunTime>
        <AvgRunTimeFormated>00:06:15</AvgRunTimeFormated>
        <NbrTimesRun>6</NbrTimesRun>
        <LastRunByUserId>24661</LastRunByUserId>
        <LastRunTestSet>2</LastRunTestSet>
        <LastRunTestSetTitle>Regression Tests - Build 3.1.0</LastRunTestSetTitle>
        <LastRunDate>2014-07-20T10:53:07</LastRunDate>
        <LastRunStatus>Passed</LastRunStatus>
        <NbrSteps>10</NbrSteps>
        <NbrEscalations>0</NbrEscalations>
        <DateLastEscalated>0001-01-01T00:00:00</DateLastEscalated>
        <LastEscalationRuleId>0</LastEscalationRuleId>
        <NbrFilesNotSecured>0</NbrFilesNotSecured>
        <NbrFiles>0</NbrFiles>
        <NbrNotes>0</NbrNotes>
        <NbrEvents>0</NbrEvents>
        <ScriptName></ScriptName>
      </TestSetItem>
      <SendEMailAlert>Y</SendEMailAlert>
    </TestSetItems_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: 2218 {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>
    <TestSetItems_Update xmlns="http://www.pragmaticsw.com/">
      <AuthenticationData>
      </AuthenticationData>
      <TestSetItem>
        <TestSetItemId>1</TestSetItemId>
        <TestSetId>1</TestSetId>
        <TestId>1</TestId>
        <Seq>1</Seq>
        <IsActive>Y</IsActive>
        <IsStoppedOnFail>Y</IsStoppedOnFail>
        <DateCreated>2014-07-17T08:30:28</DateCreated>
        <DateUpdated>2014-07-20T10:53:07</DateUpdated>
        <CreateUserId>24661</CreateUserId>
        <UpdateUserId>24661</UpdateUserId>
        <FolderName>Regression Tests</FolderName>
        <AssignedToName>Doe, John</AssignedToName>
        <UserName>Doe, John</UserName>
        <OwnerName>Doe, John</OwnerName>
        <LastRunByName>Doe, John</LastRunByName>
        <Version>2</Version>
        <ProjId>11873</ProjId>
        <FolderId>12</FolderId>
        <Title>Test input data</Title>
        <TestIsActive>Y</TestIsActive>
        <StatusCode>Approved</StatusCode>
        <ExecutionType>Manual</ExecutionType>
        <TestType>Regression</TestType>
        <Priority>2-Medium</Priority>
        <TestDateCreated>2014-07-17T08:30:28</TestDateCreated>
        <TestDateUpdated>2014-07-20T10:53:07</TestDateUpdated>
        <TestCreateUserId>24661</TestCreateUserId>
        <TestUpdateUserId>24661</TestUpdateUserId>
        <AssigneeUserId>24661</AssigneeUserId>
        <OwnerUserId>24661</OwnerUserId>
        <OriginalId>0</OriginalId>
        <ImportId>0</ImportId>
        <ScriptSourceId>0</ScriptSourceId>
        <NbrFailStatus>2</NbrFailStatus>
        <NbrPassStatus>4</NbrPassStatus>
        <AvgRunTime>375</AvgRunTime>
        <AvgRunTimeFormated>00:06:15</AvgRunTimeFormated>
        <NbrTimesRun>6</NbrTimesRun>
        <LastRunByUserId>24661</LastRunByUserId>
        <LastRunTestSet>2</LastRunTestSet>
        <LastRunTestSetTitle>Regression Tests - Build 3.1.0</LastRunTestSetTitle>
        <LastRunDate>2014-07-20T10:53:07</LastRunDate>
        <LastRunStatus>Passed</LastRunStatus>
        <NbrSteps>10</NbrSteps>
        <NbrEscalations>0</NbrEscalations>
        <DateLastEscalated>0001-01-01T00:00:00</DateLastEscalated>
        <LastEscalationRuleId>0</LastEscalationRuleId>
        <NbrFilesNotSecured>0</NbrFilesNotSecured>
        <NbrFiles>0</NbrFiles>
        <NbrNotes>0</NbrNotes>
        <NbrEvents>0</NbrEvents>
        <ScriptName></ScriptName>
      </TestSetItem>
      <SendEMailAlert>Y</SendEMailAlert>
    </TestSetItems_Update>
  </soap12:Body>
</soap12:Envelope>

Sample Response XML
SOAP 1.1
SOAP 1.2

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

See Also

TestSetItems_Add
TestSetItems_Delete
TestSetItems_Load
TestSetItems_LoadByCriteria
Test Management Operations
Test Set Items Operations
SOAP API Reference

Highlight search results