SpiraPlan: SoapService 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 (integer) ( If no value is provided, the authenticated user is used instead ) | |
| AuthorName | string? | The display name of the user that wrote this requirement (string) | |
| ComponentId | int? | The id of the component the requirement is a part of (integer - these are created on a per project user by an administrator) | |
| CoverageCountBlocked | int? | How many of the test cases that cover this requirement have blocked (integer) | |
| CoverageCountCaution | int? | How many of the test cases that cover this requirement have been marked as caution (integer) | |
| CoverageCountFailed | int? | How many of the test cases that cover this requirement have failed (integer) | |
| CoverageCountPassed | int? | How many of the test cases that cover this requirement have passed (integer) | |
| CoverageCountTotal | int? | How many test cases cover this requirement (integer) | |
| CreationDate | dateTime | The date/time the requirement was originally created (date-time) | Yes |
| Description | string? | The description of the requirement (string) | |
| EndDate | dateTime? | The end date of the requirement for planning purposes | |
| EstimatePoints | decimal? | The estimate of the requirement (decimal - in story points) | |
| EstimatedEffort | int? | What was the original top-down level of effort estimated for this requirement, calculated from the points estimate (integer) | |
| GoalId | int? | The id of the goal that the requirement belongs to | |
| ImportanceId | int? | The id of the importance of the requirement (integer) ( Relevant values: 1 - Critical 1; 2 - High 2; 3 - Medium 3; 4 - Low 4 ) | |
| ImportanceName | string? | The display name of the importance that the requirement is in (string) | |
| IndentLevel | string? | The indentation level of the artifact (string) ( 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 (date-time) | Yes |
| Name | string? | The name of the requirement (string - required for POST) | |
| OwnerId | int? | The id of the user that the requirement is assigned-to (integer) | |
| OwnerName | string? | The display name of the user that this requirement is assigned-to (string) | |
| PercentComplete | int? | The percentage complete of the requirement | |
| ProjectName | string? | The display name of the project that the requirement is associated with (string) | |
| ReleaseId | int? | The id of the release the requirement is scheduled to implemented in (integer) | |
| ReleaseVersionNumber | string? | The version number string of the release that the requirement is scheduled for (string) | |
| RequirementId | int? | The id of the requirement (integer) | |
| RequirementTypeId | int? | The type of requirement (integer). ( Relevant values: Package -1; Need 1; Feature 2; Use Case 3; User Story 4; Quality 5; Design Element 6 Null can be passed when created if using the default type ) | |
| RequirementTypeName | string? | The display name of the type of requirement (string) | |
| StartDate | dateTime? | The start date of the requirement for planning purposes | |
| StatusId | int? | The id of the requirement's status (integer). ( If no value is provided, the default status is used Relevant values: Accepted 5; Completed 10; Developed 4; Evaluated 7; In Progress 3; Obsolete 8; Planned 2; Rejected 6; Requested 1; Tested 9. ) | |
| StatusName | string? | The display name of the status the requirement is in (string) | |
| Steps | ArrayOfRemoteRequirementStep? | The list of scenarios steps (array - only available for Use Case requirement types) | |
| Summary | boolean | Is this a summary requirement or not (boolean) | Yes |
| TaskActualEffort | int? | What is the bottom-up actual effort for all the tasks associated with this requirement (integer) | |
| TaskCount | int? | How many tasks are associated with this requirement (integer) | |
| TaskEstimatedEffort | int? | What is the bottom-up estimated effort for all the tasks associated with this requirement (integer) | |
| ThemeId | int? | The Id of the program theme that the requirement belongs to |