See all operations

GET: projects/{project_id}/releases?active_only={active_only}

Description

Retrieves all the releases belonging to the current project

Does not include iterations

How to Execute

To access this REST web service, you need to use the following URL (make sure to replace any parameters (eg {project_id}) with the relevant value (eg 1):

https://api.inflectra.com/spira/services/v7_0/RestService.svc/projects/{project_id}/releases?active_only={active_only}

Request Parameters

Name	Description
project_id	The id of the project
active_only	Do we only want the active releases?

Request Body

Nothing Expected

Nothing Expected

Return Data

The JSON and XML examples below show the shape of one entry that will be returned. It does not show an example of how that entry will be populated.

Property	Description

<ArrayOfRemoteRelease xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v7_0.DataObjects">
  <RemoteRelease>
    <ArtifactTypeId>0</ArtifactTypeId>
    <ConcurrencyDate>0001-01-01T00:00:00</ConcurrencyDate>
    <CustomProperties i:nil="true" />
    <Guid i:nil="true" />
    <IsAttachments>false</IsAttachments>
    <ProjectGuid i:nil="true" />
    <ProjectId>0</ProjectId>
    <Tags i:nil="true" />
    <Active>false</Active>
    <AvailableEffort i:nil="true" />
    <CountBlocked>0</CountBlocked>
    <CountCaution>0</CountCaution>
    <CountFailed>0</CountFailed>
    <CountNotApplicable>0</CountNotApplicable>
    <CountNotRun>0</CountNotRun>
    <CountPassed>0</CountPassed>
    <CreationDate>0001-01-01T00:00:00</CreationDate>
    <CreatorGuid i:nil="true" />
    <CreatorId i:nil="true" />
    <CreatorName i:nil="true" />
    <DaysNonWorking>0</DaysNonWorking>
    <Description i:nil="true" />
    <EndDate>0001-01-01T00:00:00</EndDate>
    <FullName i:nil="true" />
    <IndentLevel i:nil="true" />
    <LastUpdateDate>0001-01-01T00:00:00</LastUpdateDate>
    <Name i:nil="true" />
    <OwnerGuid i:nil="true" />
    <OwnerId i:nil="true" />
    <OwnerName i:nil="true" />
    <PercentComplete>0</PercentComplete>
    <PlannedEffort i:nil="true" />
    <ReleaseId i:nil="true" />
    <ReleaseStatusId>0</ReleaseStatusId>
    <ReleaseStatusName i:nil="true" />
    <ReleaseTypeId>0</ReleaseTypeId>
    <ReleaseTypeName i:nil="true" />
    <RequirementCount>0</RequirementCount>
    <RequirementPoints i:nil="true" />
    <ResourceCount>0</ResourceCount>
    <StartDate>0001-01-01T00:00:00</StartDate>
    <Summary>false</Summary>
    <TaskActualEffort i:nil="true" />
    <TaskCount i:nil="true" />
    <TaskEstimatedEffort i:nil="true" />
    <VersionNumber i:nil="true" />
  </RemoteRelease>
</ArrayOfRemoteRelease>

[{"ReleaseId":null,
"CreatorId":null,
"OwnerId":null,
"CreatorGuid":null,
"OwnerGuid":null,
"OwnerName":null,
"IndentLevel":null,
"Name":null,
"Description":null,
"VersionNumber":null,
"CreationDate":"0001-01-01T00:00:00",
"LastUpdateDate":"0001-01-01T00:00:00",
"Summary":false,
"Active":false,
"ReleaseStatusId":0,
"ReleaseTypeId":0,
"StartDate":"0001-01-01T00:00:00",
"EndDate":"0001-01-01T00:00:00",
"ResourceCount":0.0,
"DaysNonWorking":0.0,
"PlannedEffort":null,
"AvailableEffort":null,
"TaskEstimatedEffort":null,
"TaskActualEffort":null,
"TaskCount":null,
"CreatorName":null,
"FullName":null,
"ReleaseStatusName":null,
"ReleaseTypeName":null,
"CountBlocked":0,
"CountCaution":0,
"CountFailed":0,
"CountNotApplicable":0,
"CountNotRun":0,
"CountPassed":0,
"PercentComplete":0,
"RequirementCount":0,
"RequirementPoints":null,
"ProjectId":0,
"ProjectGuid":null,
"ArtifactTypeId":0,
"ConcurrencyDate":"0001-01-01T00:00:00",
"CustomProperties":null,
"IsAttachments":false,
"Tags":null,
"Guid":null}]