See all operations
GET: projects/{project_id}/requirements?starting_row={starting_row}&number_of_rows={number_of_rows}
Description
Retrieves a list of requirements 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?starting_row={starting_row}&number_of_rows={number_of_rows}
Request Parameters
Name
|
Description
|
project_id
|
|
starting_row
|
|
number_of_rows
|
|
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.
<ArrayOfRemoteRequirement xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v4_0.DataObjects">
<RemoteRequirement>
<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>
</ArrayOfRemoteRequirement>
[{"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}]