SpiraPlan: SoapService SOAP Web Service
See all operations
RemoteRelease
Represents a single Release or Iteration artifact in the system
Although the fields refer to Release, they are the same fields for an Iteration
Base Classes
This class extends the following base classes:
Properties
The following properties are provided directly by this class:
| Name | Type | Description | Required |
|---|---|---|---|
| Active | boolean | Is this release active for the project | Yes |
| AvailableEffort | int? | How much effort is still available in the release for planning | |
| CountBlocked | int | The count of blocked test cases in this release | Yes |
| CountCaution | int | The count of caution test cases in this release | Yes |
| CountFailed | int | The count of failed test cases in this release | Yes |
| CountNotApplicable | int | The count of N/A test cases in this release | Yes |
| CountNotRun | int | The count of not run test cases in this release | Yes |
| CountPassed | int | The count of passed test cases in this release | Yes |
| CreationDate | dateTime | The date the release was originally created | Yes |
| CreatorId | int? | The id of the user that created the release | |
| CreatorName | string? | What is the full display name of the person who created this release | |
| DaysNonWorking | decimal | How many non-working days are associated with the release | Yes |
| Description | string? | The description of the release | |
| EndDate | dateTime | What is the end date for the release | Yes |
| FullName | string? | The full name and version number of the release combined | |
| IndentLevel | string? | 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.) ) | |
| LastUpdateDate | dateTime | The date the release was last modified | Yes |
| MilestoneId | int? | The id of any program milestones that this release is associated with | |
| Name | string? | The name of the release | |
| OwnerId | int? | The id of the user that the release is assigned to | |
| OwnerName | string? | The name of the user that the release is assigned to | |
| PercentComplete | int | The percentage complete of the project/sprint | Yes |
| PlannedEffort | int? | What is the estimated planned effort associated with the release | |
| ReleaseId | int? | The id of the release | |
| ReleaseStatusId | int | The status of the release ( Planned = 1, InProgress = 2, Completed = 3, Closed = 4, Deferred = 5, Cancelled = 6 ) | Yes |
| ReleaseStatusName | string? | The display name for the release status | |
| ReleaseTypeId | int | The type of the release ( MajorRelease = 1, MinorRelease = 2, Iteration = 3, Phase = 4 ) | Yes |
| ReleaseTypeName | string? | The display name for the release type | |
| ResourceCount | decimal | How many people are working on the release | Yes |
| StartDate | dateTime | What is the start date for the release | Yes |
| Summary | boolean | Is this release a summary one (i.e. does it have child releases) | Yes |
| TaskActualEffort | int? | How much effort was actually expended for all the tasks scheduled for this release | |
| TaskCount | int? | How many tasks are scheduled for this release | |
| TaskEstimatedEffort | int? | How much effort was estimated for all the tasks scheduled for this release | |
| VersionNumber | string? | The version number string of the release |