See all operations
POST: projects/{project_id}/incidents/search?start_row={start_row}&number_rows={number_rows}&sort_by={sort_by}
Description
Searches the list of incidents in the project. This operation allows you to specify a list of filters, the sort column and the pagination range
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}/incidents/search?start_row={start_row}&number_rows={number_rows}&sort_by={sort_by}
Request Parameters
Name
|
Description
|
project_id
|
The id of the project
|
start_row
|
The starting row (1-based)
|
number_rows
|
The number of rows to return
|
sort_by
|
The column to sort on
|
Request Body
<ArrayOfRemoteFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v4_0.DataObjects">
<RemoteFilter>
<DateRangeValue i:nil="true" />
<IntValue i:nil="true" />
<MultiValue i:nil="true" />
<PropertyName i:nil="true" />
<StringValue i:nil="true" />
</RemoteFilter>
</ArrayOfRemoteFilter>
[{"DateRangeValue":null,
"IntValue":null,
"MultiValue":null,
"PropertyName":null,
"StringValue":null}]
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.
<ArrayOfRemoteIncident xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v4_0.DataObjects">
<RemoteIncident>
<ArtifactTypeId>0</ArtifactTypeId>
<ConcurrencyDate>0001-01-01T00:00:00</ConcurrencyDate>
<CustomProperties i:nil="true" />
<ProjectId i:nil="true" />
<ActualEffort i:nil="true" />
<ClosedDate i:nil="true" />
<CompletionPercent>0</CompletionPercent>
<CreationDate i:nil="true" />
<Description i:nil="true" />
<DetectedReleaseId i:nil="true" />
<DetectedReleaseVersionNumber i:nil="true" />
<EstimatedEffort i:nil="true" />
<FixedBuildId i:nil="true" />
<FixedBuildName i:nil="true" />
<IncidentId i:nil="true" />
<IncidentStatusId i:nil="true" />
<IncidentStatusName i:nil="true" />
<IncidentStatusOpenStatus i:nil="true" />
<IncidentTypeId i:nil="true" />
<IncidentTypeName i:nil="true" />
<LastUpdateDate>0001-01-01T00:00:00</LastUpdateDate>
<Name i:nil="true" />
<OpenerId i:nil="true" />
<OpenerName i:nil="true" />
<OwnerId i:nil="true" />
<OwnerName i:nil="true" />
<PriorityId i:nil="true" />
<PriorityName i:nil="true" />
<ProjectName i:nil="true" />
<ProjectedEffort i:nil="true" />
<RemainingEffort i:nil="true" />
<ResolvedReleaseId i:nil="true" />
<ResolvedReleaseVersionNumber i:nil="true" />
<SeverityId i:nil="true" />
<SeverityName i:nil="true" />
<StartDate i:nil="true" />
<TestRunStepId i:nil="true" />
<VerifiedReleaseId i:nil="true" />
<VerifiedReleaseVersionNumber i:nil="true" />
</RemoteIncident>
</ArrayOfRemoteIncident>
[{"ArtifactTypeId":0,
"ConcurrencyDate":"\/Date(-62135578800000-0500)\/",
"CustomProperties":null,
"ProjectId":null,
"ActualEffort":null,
"ClosedDate":null,
"CompletionPercent":0,
"CreationDate":null,
"Description":null,
"DetectedReleaseId":null,
"DetectedReleaseVersionNumber":null,
"EstimatedEffort":null,
"FixedBuildId":null,
"FixedBuildName":null,
"IncidentId":null,
"IncidentStatusId":null,
"IncidentStatusName":null,
"IncidentStatusOpenStatus":null,
"IncidentTypeId":null,
"IncidentTypeName":null,
"LastUpdateDate":"\/Date(-62135578800000-0500)\/",
"Name":null,
"OpenerId":null,
"OpenerName":null,
"OwnerId":null,
"OwnerName":null,
"PriorityId":null,
"PriorityName":null,
"ProjectName":null,
"ProjectedEffort":null,
"RemainingEffort":null,
"ResolvedReleaseId":null,
"ResolvedReleaseVersionNumber":null,
"SeverityId":null,
"SeverityName":null,
"StartDate":null,
"TestRunStepId":null,
"VerifiedReleaseId":null,
"VerifiedReleaseVersionNumber":null}]