SpiraTeam: 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
AuthorIdint? The id of the user that wrote the requirement (integer) ( If no value is provided, the authenticated user is used instead )
AuthorNamestring? The display name of the user that wrote this requirement (string)
ComponentIdint? The id of the component the requirement is a part of (integer - these are created on a per project user by an administrator)
CoverageCountBlockedint? How many of the test cases that cover this requirement have blocked (integer)
CoverageCountCautionint? How many of the test cases that cover this requirement have been marked as caution (integer)
CoverageCountFailedint? How many of the test cases that cover this requirement have failed (integer)
CoverageCountPassedint? How many of the test cases that cover this requirement have passed (integer)
CoverageCountTotalint? How many test cases cover this requirement (integer)
CreationDatedateTime The date/time the requirement was originally created (date-time) Yes
Descriptionstring? The description of the requirement (string)
EstimatePointsdecimal? The estimate of the requirement (decimal - in story points)
EstimatedEffortint? What was the original top-down level of effort estimated for this requirement, calculated from the points estimate (integer)
ImportanceIdint? The id of the importance of the requirement (integer) ( Relevant values: 1 - Critical 1; 2 - High 2; 3 - Medium 3; 4 - Low 4 )
ImportanceNamestring? The display name of the importance that the requirement is in (string)
IndentLevelstring? 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.) )
LastUpdateDatedateTime The date/time the requirement was last modified (date-time) Yes
Namestring? The name of the requirement (string - required for POST)
OwnerIdint? The id of the user that the requirement is assigned-to (integer)
OwnerNamestring? The display name of the user that this requirement is assigned-to (string)
ProjectNamestring? The display name of the project that the requirement is associated with (string)
ReleaseIdint? The id of the release the requirement is scheduled to implemented in (integer)
ReleaseVersionNumberstring? The version number string of the release that the requirement is scheduled for (string)
RequirementIdint? The id of the requirement (integer)
RequirementTypeIdint The type of requirement (integer). ( Relevant values: Package -1; Need 1; Feature 2; Use Case 3; User Story 4; Quality 5; Design Element 6 ) Yes
RequirementTypeNamestring? The display name of the type of requirement (string)
StatusIdint? 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. )
StatusNamestring? The display name of the status the requirement is in (string)
StepsArrayOfRemoteRequirementStep? The list of scenarios steps (array - only available for Use Case requirement types)
Summaryboolean Is this a summary requirement or not (boolean) Yes
TaskActualEffortint? What is the bottom-up actual effort for all the tasks associated with this requirement (integer)
TaskCountint? How many tasks are associated with this requirement (integer)
TaskEstimatedEffortint? What is the bottom-up estimated effort for all the tasks associated with this requirement (integer)