Applies to QAComplete 12.21 SaaS, last modified on July 15, 2019

Finds a release, iteration, or build by ID and replaces its data with that of the specified Release object.

You usually use the Releases_Load operation to get a Release by ID, change some of its properties, and pass the updated object to the Release_Update operation. All uninitialized properties will be cleared.

Requirements

The authenticating user must belong to a security group that has the Update privilege for Releases.

Parameters

The operation uses the following parameters:

AuthenticationData  :  AuthenticationData, required

An AuthenticationData object containing the login information and the project ID that contains the items.

Release  :  Release, required

A Release object that contains the new information for the release, iteration, or build.

SendEmailAlert  :  string, required

Y means send an email alert to the subscribed users after updating the release.

Any other value (for example, N or empty string) means do not send e-mail alerts.

Result

None.

Remarks

The Release 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#

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

// Specifying the release object to be updated
int Id = 26;

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;

// Preparing the release object
Release release = new Release();

// Loading all existing data of the release
release = service.Releases_Load(authData, Id);

// Specifying new values of the release properties
release.StatusCode = "In progress";
release.IsActive = "Y";

// Updating the release
service.Releases_Update(authData, release, "");

Java

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

// Specifying the ID of the release to be updated
int Id = 26;

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

// Preparing the release object
Release release = new Release();

// Loading all existing data of the release
release = service.releasesLoad(authData, Id);

// Specifying new values of the release properties
release.setStatusCode("In progress");
release.setIsActive("Y");

// Updating the release
service.releasesUpdate(authData, release, "");

Sample Request XML

POST /psws/psws.asmx HTTP/1.1
Host: myteam.mysite.com
Content-Type: text/xml; charset=utf-8
Content-Length: 1298 {Insert an appropriate value here}
SOAPAction: "http://www.pragmaticsw.com/Releases_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>
    <Releases_Update xmlns="http://www.pragmaticsw.com/">
      <AuthenticationData>
        <AppCode>agSP</AppCode>
        <DeptId>7154</DeptId>
        <ProjId>1032</ProjId>
        <UserId>25315</UserId>
        <PassCode>p@ssword</PassCode>
      </AuthenticationData>
      <Release>
        <Id>14</Id>
        <ProjId>10372</ProjId>
        <FullReleaseName>Release 1.0</FullReleaseName>
        <ReleaseType>Release</ReleaseType>
        <Title>Release 1.0</Title>
        <Description>The initial product release.</Description>
        <OwnerUserId>27572</OwnerUserId>
        <AssigneeUserId>27942</AssigneeUserId>
        <IsAutoAdjustEstDates>N</IsAutoAdjustEstDates>
        <DateCreated>2014-07-09T22:41:37.17</DateCreated>
        <CreateUserId>27572</CreateUserId>
        <StatusCode>In Progress</StatusCode>
        <SeqNum>1</SeqNum>
        <IsActive>Y</IsActive>
        <EstStartDate>2014-07-02T10:00:00</EstStartDate>
        <EstFinishDate>2014-08-01T00:00:00</EstFinishDate>
        <AssignedToName>Doe, John</AssignedToName>
        <OwnerName>Davis, Eugeny</OwnerName>
        <ActStart>2014-07-02T12:00:00</ActStart>
        <PctComplete>10</PctComplete>
        <NbrIterations>1</NbrIterations>
        <NbrBuilds>26</NbrBuilds>
      </Release>
      <SendEmailAlert>N</SendEmailAlert>
    </Releases_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: 1306 {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>
    <Releases_Update xmlns="http://www.pragmaticsw.com/">
      <AuthenticationData>
        <AppCode>agSP</AppCode>
        <DeptId>7154</DeptId>
        <ProjId>1032</ProjId>
        <UserId>25315</UserId>
        <PassCode>p@ssword</PassCode>
      </AuthenticationData>
      <Release>
        <Id>14</Id>
        <ProjId>10372</ProjId>
        <FullReleaseName>Release 1.0</FullReleaseName>
        <ReleaseType>Release</ReleaseType>
        <Title>Release 1.0</Title>
        <Description>The initial product release.</Description>
        <OwnerUserId>27572</OwnerUserId>
        <AssigneeUserId>27942</AssigneeUserId>
        <IsAutoAdjustEstDates>N</IsAutoAdjustEstDates>
        <DateCreated>2014-07-09T22:41:37.17</DateCreated>
        <CreateUserId>27572</CreateUserId>
        <StatusCode>In Progress</StatusCode>
        <SeqNum>1</SeqNum>
        <IsActive>Y</IsActive>
        <EstStartDate>2014-07-02T10:00:00</EstStartDate>
        <EstFinishDate>2014-08-01T00:00:00</EstFinishDate>
        <AssignedToName>Doe, John</AssignedToName>
        <OwnerName>Davis, Eugeny</OwnerName>
        <ActStart>2014-07-02T12:00:00</ActStart>
        <PctComplete>10</PctComplete>
        <NbrIterations>1</NbrIterations>
        <NbrBuilds>26</NbrBuilds>
      </Release>
      <SendEmailAlert>N</SendEmailAlert>
    </Releases_Update>
  </soap12:Body>
</soap12:Envelope>

Sample Response XML

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

See Also

Releases_Add
Releases_Delete
Releases_Load
Releases_LoadByCriteria
Releases Operations
SOAP API Reference

Highlight search results