See all operations
POST: projects/{project_id}/releases/{parent_release_id}
Description
Creates a new release in the system under a specified parent release
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/{parent_release_id}
Request Parameters
|
Name
|
Description
|
|
project_id
|
The id of the current project
|
|
parent_release_id
|
The id of the parent release we want to insert it under
|
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
|
|
ProjectId
|
The id of the project that the artifact belongs to
|
|
ProjectGuid
|
The guid 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
|
|
Guid
|
The unique identifier for the artifact
|
<RemoteRelease xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v7_0.DataObjects">
<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>
{"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}
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
|
|
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
|
|
CreatorGuid
|
The guid of the creator.
|
|
OwnerGuid
|
The guid of the owner.
|
|
OwnerName
|
The name 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)
|
|
Active
|
Is this release active for the project
|
|
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
|
|
CreatorName
|
What is the full display name of the person who created this release
|
|
FullName
|
The full name and version number of the release combined
|
|
ReleaseStatusName
|
The display name for the release status
|
|
ReleaseTypeName
|
The display name for the release type
|
|
CountBlocked
|
The count of blocked test cases in this release
|
|
CountCaution
|
The count of caution test cases in this release
|
|
CountFailed
|
The count of failed test cases in this release
|
|
CountNotApplicable
|
The count of N/A test cases in this release
|
|
CountNotRun
|
The count of not run test cases in this release
|
|
CountPassed
|
The count of passed test cases in this release
|
|
PercentComplete
|
The percentage complete of the project/sprint
|
|
RequirementCount
|
Number of requirements assigned to this release
|
|
RequirementPoints
|
Number of effort points assigned to the requirements of this release
|
|
ProjectId
|
The id of the project that the artifact belongs to
|
|
ProjectGuid
|
The guid of the project that the artifact belongs to
|
|
ArtifactTypeId
|
The type of artifact that we have
|
|
ConcurrencyDate
|
The datetime used to track optimistic concurrency to prevent edit conflicts
|
|
CustomProperties
|
The list of associated custom properties/fields for this artifact
|
|
IsAttachments
|
Does this artifact have any attachments?
|
|
Tags
|
The list of meta-tags that should be associated with the artifact
|
|
Guid
|
The unique identifier for the artifact
|
<RemoteRelease xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v7_0.DataObjects">
<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>
{"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}