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

Adds a new release, iteration, or build and returns the ID of the created item.

Requirements

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

Parameters

The operation uses the following parameters:

AuthenticationData  :  AuthenticationData, required

An AuthenticationData object containing the login information and the project ID where you want to create the item.

Release  :  Release, required

A Release object that contains the release, iteration, or build data.

SendEmailAlert  :  string, required

If you want to send an email alert, send Y, otherwise send N.

NewNotes  :  string

New note attached to the release. Default value: empty string.

Result

The ID of the added release, iteration, or build.

Remarks

The Release object you pass in must have all property values required by your QAComplete instance. To view and manage the required properties for releases, select  > Setup > System Configuration > Screen Layouts > Releases > Required Fields.

Do not specify the following properties, they are set automatically:

  • DateCreated are DateUpdated are set to the current date and time.

  • If IsAutoAdjustEstDates is set to Y, then EstStartDate and EstFinishDate are set automatically.

  • UpdateUserId, UserName, and CreateUserId are set to the authenticating user.

  • EstStart and EstFinished are not used now. They are always 0001-01-01T00:00:00

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

To view sample code that demonstrates how to use the Releases_Add operation to create a release, see Add Releases, Iterations (Sprints), and Builds.

Sample Request XML

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

<?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_Add xmlns="http://www.pragmaticsw.com/">
      <AuthenticationData>
        <AppCode>agSP</AppCode>
        <DeptId>7154</DeptId>
        <ProjId>1032</ProjId>
        <UserId>25315</UserId>
        <PassCode>p@ssword</PassCode>
      </AuthenticationData>
      <Release>
        <ProjId>10372</ProjId>
        <ReleaseType>Release</ReleaseType>
        <Title>Release 1.0</Title>
        <Description>The initial product release.</Description>
        <IsAutoAdjustEstDates>N</IsAutoAdjustEstDates>
        <StatusCode>In Progress</StatusCode>
        <IsActive>Y</IsActive>
        <EstFinishDate>2014-08-01T00:00:00</EstFinishDate>
      </Release>
      <SendEmailAlert>N</SendEmailAlert>
    </Releases_Add>
  </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: 820 {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_Add xmlns="http://www.pragmaticsw.com/">
      <AuthenticationData>
        <AppCode>agSP</AppCode>
        <DeptId>7154</DeptId>
        <ProjId>1032</ProjId>
        <UserId>25315</UserId>
        <PassCode>p@ssword</PassCode>
      </AuthenticationData>
      <Release>
        <ProjId>10372</ProjId>
        <ReleaseType>Release</ReleaseType>
        <Title>Release 1.0</Title>
        <Description>The initial product release.</Description>
        <IsAutoAdjustEstDates>N</IsAutoAdjustEstDates>
        <StatusCode>In Progress</StatusCode>
        <IsActive>Y</IsActive>
        <EstFinishDate>2014-08-01T00:00:00</EstFinishDate>
      </Release>
      <SendEmailAlert>N</SendEmailAlert>
    </Releases_Add>
  </soap12:Body>
</soap12:Envelope>

Sample Response XML

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

SOAP 1.2

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

See Also

Releases_Delete
Releases_Load
Releases_LoadByCriteria
Releases_Update
Releases Operations
SOAP API Reference

Highlight search results