SpiraPlan: REST Web Service (v5.0)

See all operations

GET: projects/{project_id}/requirements/{requirement_id}

Description

Retrieves a single requirement in the system

Includes any steps

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):

https://api.inflectra.com/Spira/Services/v5_0/RestService.svc/projects/{project_id}/requirements/{requirement_id}

Request Parameters

Name Description
project_id
requirement_id

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
RequirementId The id of the requirement (integer)
IndentLevel 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.)
StatusId 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.
RequirementTypeId The type of requirement (integer). Relevant values: Package -1; Need 1; Feature 2; Use Case 3; User Story 4; Quality 5; Design Element 6
AuthorId The id of the user that wrote the requirement (integer) If no value is provided, the authenticated user is used instead
OwnerId The id of the user that the requirement is assigned-to (integer)
ImportanceId The id of the importance of the requirement (integer) Relevant values: 1 - Critical 1; 2 - High 2; 3 - Medium 3; 4 - Low 4
ReleaseId The id of the release the requirement is scheduled to implemented in (integer)
ComponentId The id of the component the requirement is a part of (integer - these are created on a per project user by an administrator)
Name The name of the requirement (string - required for POST)
Description The description of the requirement (string)
CreationDate The date/time the requirement was originally created (date-time)
LastUpdateDate The date/time the requirement was last modified (date-time)
Summary Is this a summary requirement or not (boolean)
CoverageCountTotal How many test cases cover this requirement (integer)
CoverageCountPassed How many of the test cases that cover this requirement have passed (integer)
CoverageCountFailed How many of the test cases that cover this requirement have failed (integer)
CoverageCountCaution How many of the test cases that cover this requirement have been marked as caution (integer)
CoverageCountBlocked How many of the test cases that cover this requirement have blocked (integer)
EstimatePoints The estimate of the requirement (decimal - in story points)
EstimatedEffort What was the original top-down level of effort estimated for this requirement, calculated from the points estimate (integer)
TaskEstimatedEffort What is the bottom-up estimated effort for all the tasks associated with this requirement (integer)
TaskActualEffort What is the bottom-up actual effort for all the tasks associated with this requirement (integer)
TaskCount How many tasks are associated with this requirement (integer)
ReleaseVersionNumber The version number string of the release that the requirement is scheduled for (string)
AuthorName The display name of the user that wrote this requirement (string)
OwnerName The display name of the user that this requirement is assigned-to (string)
StatusName The display name of the status the requirement is in (string)
ImportanceName The display name of the importance that the requirement is in (string)
ProjectName The display name of the project that the requirement is associated with (string)
RequirementTypeName The display name of the type of requirement (string)
Steps The list of scenarios steps (array - only available for Use Case requirement types)
ProjectId The id of the project that the artifact belongs to The current project is always used for Insert operations for security reasons
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?