See all operations

GET: requirements

Description

Retrieves all requirements owned by the currently authenticated user

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/v6_0/RestService.svc/requirements

Request Body

Nothing Expected

Nothing Expected

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

<ArrayOfRemoteRequirement xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v6_0.DataObjects">
  <RemoteRequirement>
    <ArtifactTypeId>0</ArtifactTypeId>
    <ConcurrencyDate>0001-01-01T00:00:00</ConcurrencyDate>
    <CustomProperties i:nil="true" />
    <IsAttachments>false</IsAttachments>
    <ProjectId>0</ProjectId>
    <Tags i:nil="true" />
    <AuthorId i:nil="true" />
    <AuthorName i:nil="true" />
    <ComponentId 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" />
    <EndDate i:nil="true" />
    <EstimatePoints i:nil="true" />
    <EstimatedEffort i:nil="true" />
    <GoalId 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" />
    <PercentComplete i:nil="true" />
    <ProjectName i:nil="true" />
    <ReleaseId i:nil="true" />
    <ReleaseVersionNumber i:nil="true" />
    <RequirementId i:nil="true" />
    <RequirementTypeId i:nil="true" />
    <RequirementTypeName i:nil="true" />
    <StartDate i:nil="true" />
    <StatusId i:nil="true" />
    <StatusName i:nil="true" />
    <Steps i:nil="true" />
    <Summary>false</Summary>
    <TaskActualEffort i:nil="true" />
    <TaskCount i:nil="true" />
    <TaskEstimatedEffort i:nil="true" />
    <ThemeId i:nil="true" />
  </RemoteRequirement>
</ArrayOfRemoteRequirement>

[{"RequirementId":null,
"IndentLevel":null,
"StatusId":null,
"RequirementTypeId":null,
"AuthorId":null,
"OwnerId":null,
"ImportanceId":null,
"ReleaseId":null,
"ComponentId":null,
"Name":null,
"Description":null,
"CreationDate":"0001-01-01T00:00:00",
"LastUpdateDate":"0001-01-01T00:00:00",
"Summary":false,
"CoverageCountTotal":null,
"CoverageCountPassed":null,
"CoverageCountFailed":null,
"CoverageCountCaution":null,
"CoverageCountBlocked":null,
"EstimatePoints":null,
"EstimatedEffort":null,
"TaskEstimatedEffort":null,
"TaskActualEffort":null,
"TaskCount":null,
"ReleaseVersionNumber":null,
"AuthorName":null,
"OwnerName":null,
"StatusName":null,
"ImportanceName":null,
"ProjectName":null,
"RequirementTypeName":null,
"Steps":null,
"StartDate":null,
"EndDate":null,
"PercentComplete":null,
"ThemeId":null,
"GoalId":null,
"ProjectId":0,
"ArtifactTypeId":0,
"ConcurrencyDate":"0001-01-01T00:00:00",
"CustomProperties":null,
"IsAttachments":false,
"Tags":null}]