Returns a release, iteration, or build by ID.
Requirements
The authenticating user must belong to a security group that has the Read privilege for Releases.
To specify a project that contains the release, use the ProjId value in the AuthenticationData object in the request body. To search for the release in several projects, use the ProjIds value to specify the list of projects IDs in the AuthenticationData object.
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 item.
ReleaseId : integer, required
The ID of the release, iteration, or build.
Result
A Release object that contains the release, iteration, or build data.
Example
Sample Code
C#
string login = "[email protected]";
string password = "p@ssword";
int projId = 10372;
// Specifying the ID of the desired release
int Id = 14;
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;
// Getting the release
Release release = service.Releases_Load(authData, Id);
Console.WriteLine(release.Title);
Java
String login = "[email protected]";
String password = "p@ssword";
int projId = 10372;
// Specifying the ID of the release, iteration or build
int Id = 14;
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);
Release release = new Release();
release = service.releasesLoad(authData, Id);
System.out.println(release.getTitle());
Sample Request XML
POST /psws/psws.asmx HTTP/1.1
Host: myteam.mysite.com
Content-Type: text/xml; charset=utf-8
Content-Length: 495 {Insert an appropriate value here}
SOAPAction: "http://www.pragmaticsw.com/Releases_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>
<Releases_Load xmlns="http://www.pragmaticsw.com/">
<AuthenticationData>
<AppCode>agSP</AppCode>
<DeptId>7154</DeptId>
<ProjId>1032</ProjId>
<UserId>25315</UserId>
<PassCode>p@ssword</PassCode>
</AuthenticationData>
<ReleaseId>14</ReleaseId>
</Releases_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: 503 {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_Load xmlns="http://www.pragmaticsw.com/">
<AuthenticationData>
<AppCode>agSP</AppCode>
<DeptId>7154</DeptId>
<ProjId>1032</ProjId>
<UserId>25315</UserId>
<PassCode>p@ssword</PassCode>
</AuthenticationData>
<ReleaseId>14</ReleaseId>
</Releases_Load>
</soap12:Body>
</soap12:Envelope>
Sample Response XML
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: 2055 {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_LoadResponse xmlns="http://www.pragmaticsw.com/">
<Releases_LoadResult>
<Id>14</Id>
<ProjId>10372</ProjId>
<FolderId>0</FolderId>
<ReleaseId></ReleaseId>
<FullReleaseName>Release 1.0</FullReleaseName>
<ReleaseName></ReleaseName>
<ParentId>0</ParentId>
<ParentName></ParentName>
<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>
<DateUpdated>2014-07-14T22:26:47</DateUpdated>
<CreateUserId>27572</CreateUserId>
<UpdateUserId>27942</UpdateUserId>
<StatusCode>In Progress</StatusCode>
<SeqNum>1</SeqNum>
<ParentSeqNum>0</ParentSeqNum>
<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>
<UserName>Doe, John</UserName>
<NbrNotes>0</NbrNotes>
<NbrFiles>0</NbrFiles>
<NotesDescription>0</NotesDescription>
<NbrEscalations>0</NbrEscalations>
<DateLastEscalated>0001-01-01T00:00:00</DateLastEscalated>
<LastEscalationRuleId>0</LastEscalationRuleId>
<NbrProjectPlans>0</NbrProjectPlans>
<NbrProjectPlanTasks>0</NbrProjectPlanTasks>
<NbrQuickTasks>0</NbrQuickTasks>
<NbrTests>0</NbrTests>
<NbrTestCases>0</NbrTestCases>
<NbrDefects>0</NbrDefects>
<EstStart>0001-01-01T00:00:00</EstStart>
<EstFinish>0001-01-01T00:00:00</EstFinish>
<ActStart>2014-07-02T12:00:00</ActStart>
<ActFinish>0001-01-01T00:00:00</ActFinish>
<PctComplete>10</PctComplete>
<ProjectVarianceHrs>236</ProjectVarianceHrs>
<EstHrs>250</EstHrs>
<ActHrs>14</ActHrs>
<EstHrsRemaining>0</EstHrsRemaining>
<NbrIterations>1</NbrIterations>
<NbrBuilds>26</NbrBuilds>
</Releases_LoadResult>
</Releases_LoadResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: 2065 {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_LoadResponse xmlns="http://www.pragmaticsw.com/">
<Releases_LoadResult>
<Id>14</Id>
<ProjId>10372</ProjId>
<FolderId>0</FolderId>
<ReleaseId></ReleaseId>
<FullReleaseName>Release 1.0</FullReleaseName>
<ReleaseName></ReleaseName>
<ParentId>0</ParentId>
<ParentName></ParentName>
<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>
<DateUpdated>2014-07-14T22:26:47</DateUpdated>
<CreateUserId>27572</CreateUserId>
<UpdateUserId>27942</UpdateUserId>
<StatusCode>In Progress</StatusCode>
<SeqNum>1</SeqNum>
<ParentSeqNum>0</ParentSeqNum>
<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>
<UserName>Doe, John</UserName>
<NbrNotes>0</NbrNotes>
<NbrFiles>0</NbrFiles>
<NotesDescription>0</NotesDescription>
<NbrEscalations>0</NbrEscalations>
<DateLastEscalated>0001-01-01T00:00:00</DateLastEscalated>
<LastEscalationRuleId>0</LastEscalationRuleId>
<NbrProjectPlans>0</NbrProjectPlans>
<NbrProjectPlanTasks>0</NbrProjectPlanTasks>
<NbrQuickTasks>0</NbrQuickTasks>
<NbrTests>0</NbrTests>
<NbrTestCases>0</NbrTestCases>
<NbrDefects>0</NbrDefects>
<EstStart>0001-01-01T00:00:00</EstStart>
<EstFinish>0001-01-01T00:00:00</EstFinish>
<ActStart>2014-07-02T12:00:00</ActStart>
<ActFinish>0001-01-01T00:00:00</ActFinish>
<PctComplete>10</PctComplete>
<ProjectVarianceHrs>236</ProjectVarianceHrs>
<EstHrs>250</EstHrs>
<ActHrs>14</ActHrs>
<EstHrsRemaining>0</EstHrsRemaining>
<NbrIterations>1</NbrIterations>
<NbrBuilds>26</NbrBuilds>
</Releases_LoadResult>
</Releases_LoadResponse>
</soap12:Body>
</soap12:Envelope>
See Also
Releases_Add
Releases_Delete
Releases_LoadByCriteria
Releases_Update
Releases Operations
SOAP API Reference