See all operations
GET: projects/{project_id}/requirements/{requirement_id}
Description
Retrieves a single requirement in the system
How to Execute
To access this REST web service, you need to use the following URL:
https://api.inflectra.com/Spira/Services/v4_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
|
|
IndentLevel
|
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.)
|
|
StatusId
|
The id of the requirement's status
If no value is provided, the default status is used
|
|
AuthorId
|
The id of the user that wrote the requirement
If no value is provided, the authenticated user is used instead
|
|
OwnerId
|
The id of the user that the requirement is assigned-to
|
|
ImportanceId
|
The id of the importance of the requirement
|
|
ReleaseId
|
The id of the release the requirement is scheduled to implemented in
|
|
Name
|
The name of the requirement
|
|
Description
|
The description of the requirement
|
|
CreationDate
|
The date/time the requirement was originally created
|
|
LastUpdateDate
|
The date/time the requirement was last modified
|
|
Summary
|
Is this a summary requirement or not
|
|
CoverageCountTotal
|
How many test cases cover this requirement
|
|
CoverageCountPassed
|
How many of the test cases that cover this requirement have passed
|
|
CoverageCountFailed
|
How many of the test cases that cover this requirement have failed
|
|
CoverageCountCaution
|
How many of the test cases that cover this requirement have been marked as caution
|
|
CoverageCountBlocked
|
How many of the test cases that cover this requirement have blocked
|
|
PlannedEffort
|
What was the original top-down level of effort estimated for this requirement
|
|
TaskEstimatedEffort
|
What is the bottom-up estimated effort for all the tasks associated with this requirement
|
|
TaskActualEffort
|
What is the bottom-up actual effort for all the tasks associated with this requirement
|
|
TaskCount
|
How many tasks are associated with this requirement
|
|
ReleaseVersionNumber
|
The version number string of the release that the requirement is scheduled for
|
|
AuthorName
|
The display name of the user that wrote this requirement
|
|
OwnerName
|
The display name of the user that this requirement is assigned-to
|
|
StatusName
|
The display name of the status the requirement is in
|
|
ImportanceName
|
The display name of the importance that the requirement is in
|
|
ProjectName
|
The display name of the project that the requirement is associated with
|
|
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 (read-only)
|
|
ConcurrencyDate
|
The datetime used to track optimistic concurrency to prevent edit conflicts
|
|
CustomProperties
|
The list of associated custom properties/fields for this artifact
|
<RemoteRequirement xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v4_0.DataObjects">
<ArtifactTypeId>0</ArtifactTypeId>
<ConcurrencyDate>0001-01-01T00:00:00</ConcurrencyDate>
<CustomProperties i:nil="true" />
<ProjectId i:nil="true" />
<AuthorId i:nil="true" />
<AuthorName i:nil="true" />
<CoverageCountBlocked i:nil="true" />
<CoverageCountCaution i:nil="true" />
<CoverageCountFailed i:nil="true" />
<CoverageCountPassed i:nil="true" />
<CoverageCountTotal i:nil="true" />
<CreationDate>0001-01-01T00:00:00</CreationDate>
<Description i:nil="true" />
<ImportanceId i:nil="true" />
<ImportanceName i:nil="true" />
<IndentLevel i:nil="true" />
<LastUpdateDate>0001-01-01T00:00:00</LastUpdateDate>
<Name i:nil="true" />
<OwnerId i:nil="true" />
<OwnerName i:nil="true" />
<PlannedEffort i:nil="true" />
<ProjectName i:nil="true" />
<ReleaseId i:nil="true" />
<ReleaseVersionNumber i:nil="true" />
<RequirementId i:nil="true" />
<StatusId i:nil="true" />
<StatusName i:nil="true" />
<Summary>false</Summary>
<TaskActualEffort i:nil="true" />
<TaskCount i:nil="true" />
<TaskEstimatedEffort i:nil="true" />
</RemoteRequirement>
{"ArtifactTypeId":0,
"ConcurrencyDate":"\/Date(-62135578800000-0500)\/",
"CustomProperties":null,
"ProjectId":null,
"AuthorId":null,
"AuthorName":null,
"CoverageCountBlocked":null,
"CoverageCountCaution":null,
"CoverageCountFailed":null,
"CoverageCountPassed":null,
"CoverageCountTotal":null,
"CreationDate":"\/Date(-62135578800000-0500)\/",
"Description":null,
"ImportanceId":null,
"ImportanceName":null,
"IndentLevel":null,
"LastUpdateDate":"\/Date(-62135578800000-0500)\/",
"Name":null,
"OwnerId":null,
"OwnerName":null,
"PlannedEffort":null,
"ProjectName":null,
"ReleaseId":null,
"ReleaseVersionNumber":null,
"RequirementId":null,
"StatusId":null,
"StatusName":null,
"Summary":false,
"TaskActualEffort":null,
"TaskCount":null,
"TaskEstimatedEffort":null}��������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������������