SpiraPlan: ImportExport SOAP Web Service
See all operations
RemoteRequirement
Represents a single Requirement artifact in the system
Base Classes
This class extends the following base classes:
Properties
The following properties are provided directly by this class:
| Name | Type | Description | Required |
|---|---|---|---|
| AuthorId | int? | The id of the user that wrote the requirement ( If no value is provided, the authenticated user is used instead ) | |
| AuthorName | string? | The display name of the user that wrote this requirement | |
| CoverageCountBlocked | int? | How many of the test cases that cover this requirement have blocked | |
| CoverageCountCaution | int? | How many of the test cases that cover this requirement have been marked as caution | |
| CoverageCountFailed | int? | How many of the test cases that cover this requirement have failed | |
| CoverageCountPassed | int? | How many of the test cases that cover this requirement have passed | |
| CoverageCountTotal | int? | How many test cases cover this requirement | |
| CreationDate | dateTime | The date/time the requirement was originally created | Yes |
| Description | string? | The description of the requirement | |
| ImportanceId | int? | The id of the importance of the requirement | |
| ImportanceName | string? | The display name of the importance that the requirement is in | |
| 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/time the requirement was last modified | Yes |
| Name | string? | The name of the requirement | |
| OwnerId | int? | The id of the user that the requirement is assigned-to | |
| OwnerName | string? | The display name of the user that this requirement is assigned-to | |
| PlannedEffort | int? | What was the original top-down level of effort estimated for this requirement | |
| ProjectId | int? | The id of the project the requirement belongs to ( The current project is always used for Insert operations for security reasons ) | |
| ProjectName | string? | The display name of the project that the requirement is associated with | |
| ReleaseId | int? | The id of the release the requirement is scheduled to implemented in | |
| ReleaseVersionNumber | string? | The version number string of the release that the requirement is scheduled for | |
| RequirementId | int? | The id of the requirement | |
| StatusId | int? | The id of the requirement's status ( If no value is provided, the default status is used ) | |
| StatusName | string? | The display name of the status the requirement is in | |
| Summary | boolean | Is this a summary requirement or not | Yes |
| TaskActualEffort | int? | What is the bottom-up actual effort for all the tasks associated with this requirement | |
| TaskCount | int? | How many tasks are associated with this requirement | |
| TaskEstimatedEffort | int? | What is the bottom-up estimated effort for all the tasks associated with this requirement |