StarterTemplate ASP.NET Host

<back to all web services

RequestReleaseGet

Releases service

The following routes are available for this service:
GET/service/api/v1/projects/{ProjectId}/releasesReturns the list of releases in a projectThe authenticating user must have the Read privilege for Releases.
Parameters:
NameParameterData TypeRequiredDescription
OffsetqueryintNoThe number of releases to skip before counting the returned releases
LimitqueryintNoThe maximum number of releases to return in the response
FilterquerystringNoThe filter expression to apply to the list of releases
ProjectIdpathintYesThe ID of the project that contains releases

To override the Content-type in your clients HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/RequestReleaseGet HTTP/1.1 
Host: rest.qacomplete.smartbear.com 
Content-Type: application/xml
Content-Length: length

<RequestReleaseGet xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SwpStack.Service.Entity.Releases">
  <ProjectId>0</ProjectId>
  <Filter>String</Filter>
  <Limit>0</Limit>
  <Offset>0</Offset>
</RequestReleaseGet>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResponseReleasesCollection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SwpStack.Service.Entity.Releases">
  <Metadata i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/SwpStack.Service.Entity.Common" />
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/SwpStack.Service.Entity.Releases" xmlns="http://schemas.datacontract.org/2004/07/SwpStack.Service.Entity.Common">
    <d2p1:ResponseReleaseSingle>
      <d2p1:AssigneeUserId>0</d2p1:AssigneeUserId>
      <d2p1:CreateUserId>0</d2p1:CreateUserId>
      <d2p1:CreatedUserName>String</d2p1:CreatedUserName>
      <d2p1:CustomFields i:nil="true" />
      <d2p1:DateCreated>0001-01-01T00:00:00</d2p1:DateCreated>
      <d2p1:DateUpdated>0001-01-01T00:00:00</d2p1:DateUpdated>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:EstFinishDate>0001-01-01T00:00:00</d2p1:EstFinishDate>
      <d2p1:EstStartDate>0001-01-01T00:00:00</d2p1:EstStartDate>
      <d2p1:FolderId>0</d2p1:FolderId>
      <d2p1:FolderName>String</d2p1:FolderName>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:ImportId>0</d2p1:ImportId>
      <d2p1:IsActive>false</d2p1:IsActive>
      <d2p1:IsAutoAdjustEstDates>false</d2p1:IsAutoAdjustEstDates>
      <d2p1:NbrFiles>0</d2p1:NbrFiles>
      <d2p1:NbrNotes>0</d2p1:NbrNotes>
      <d2p1:OwnerUserId>0</d2p1:OwnerUserId>
      <d2p1:ParentId>0</d2p1:ParentId>
      <d2p1:ParentName>String</d2p1:ParentName>
      <d2p1:ProjectId>0</d2p1:ProjectId>
      <d2p1:ReleaseId>0</d2p1:ReleaseId>
      <d2p1:ReleaseType>String</d2p1:ReleaseType>
      <d2p1:SeqNum>0</d2p1:SeqNum>
      <d2p1:StatusCode>String</d2p1:StatusCode>
      <d2p1:Title>String</d2p1:Title>
      <d2p1:UpdateUserId>0</d2p1:UpdateUserId>
      <d2p1:UpdatedUserName>String</d2p1:UpdatedUserName>
      <d2p1:__permissions>
        <Acl>0</Acl>
      </d2p1:__permissions>
    </d2p1:ResponseReleaseSingle>
  </Results>
</ResponseReleasesCollection>