See all operations

PUT: projects/{project_id}/releases

Description

Updates a release in the system

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/v6_0/RestService.svc/projects/{project_id}/releases

Request Parameters

Name	Description
project_id	The id of the current project

Request Body

Property	Description
ReleaseId	The id of the release
CreatorId	The id of the user that created the release
OwnerId	The id of the user that the release is assigned to
IndentLevel	The indentation level of the artifact The system uses a set of three-letter segments to denote indent (e.g. AAA followed by AAB, etc.)
Name	The name of the release
Description	The description of the release
VersionNumber	The version number string of the release
CreationDate	The date the release was originally created
LastUpdateDate	The date the release was last modified
Summary	Is this release a summary one (i.e. does it have child releases)
ReleaseStatusId	The status of the release Planned = 1, InProgress = 2, Completed = 3, Closed = 4, Deferred = 5, Cancelled = 6
ReleaseTypeId	The type of the release MajorRelease = 1, MinorRelease = 2, Iteration = 3, Phase = 4
StartDate	What is the start date for the release
EndDate	What is the end date for the release
ResourceCount	How many people are working on the release
DaysNonWorking	How many non-working days are associated with the release
PlannedEffort	What is the estimated planned effort associated with the release
AvailableEffort	How much effort is still available in the release for planning
TaskEstimatedEffort	How much effort was estimated for all the tasks scheduled for this release
TaskActualEffort	How much effort was actually expended for all the tasks scheduled for this release
TaskCount	How many tasks are scheduled for this release
PercentComplete	The percentage complete of the project/sprint
MilestoneId	The id of any program milestones that this release is associated with
ProjectId	The id of the project that the artifact belongs to
ConcurrencyDate	The datetime used to track optimistic concurrency to prevent edit conflicts
CustomProperties	The list of associated custom properties/fields for this artifact
Tags	The list of meta-tags that should be associated with the artifact

<RemoteRelease xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v6_0.DataObjects">
  <ArtifactTypeId>0</ArtifactTypeId>
  <ConcurrencyDate>0001-01-01T00:00:00</ConcurrencyDate>
  <CustomProperties i:nil="true" />
  <IsAttachments>false</IsAttachments>
  <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>
  <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>
  <MilestoneId i:nil="true" />
  <Name 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" />
  <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>

{"ReleaseId":null,
"CreatorId":null,
"OwnerId":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,
"MilestoneId":null,
"ProjectId":0,
"ArtifactTypeId":0,
"ConcurrencyDate":"0001-01-01T00:00:00",
"CustomProperties":null,
"IsAttachments":false,
"Tags":null}

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.

Nothing Returned

Nothing Returned