SpiraPlan: REST Web Service (v6.0)

See all operations

GET: projects/{project_id}/releases/{release_id}


Retrieves a single 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):


Request Parameters

Name Description
project_id The id of the current project
release_id The id of the release

Request Body

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
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
MilestoneId The id of any program milestones that this release is associated with
ProjectId The id 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