See all operations

GET: projects/{project_id}/incidents/search-by-test-step/{test_step_id}

Description

Retrieves a list of incidents in the system that are linked to a specific test step (either directly or indirectly through test runs)

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/projects/{project_id}/incidents/search-by-test-step/{test_step_id}

Request Parameters

Name	Description
project_id	The id of the project
test_step_id	The id of the test step

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

<ArrayOfRemoteIncident xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v6_0.DataObjects">
  <RemoteIncident>
    <ArtifactTypeId>0</ArtifactTypeId>
    <ConcurrencyDate>0001-01-01T00:00:00</ConcurrencyDate>
    <CustomProperties i:nil="true" />
    <IsAttachments>false</IsAttachments>
    <ProjectId>0</ProjectId>
    <Tags i:nil="true" />
    <ActualEffort i:nil="true" />
    <ClosedDate i:nil="true" />
    <CompletionPercent>0</CompletionPercent>
    <ComponentIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <CreationDate i:nil="true" />
    <Description i:nil="true" />
    <DetectedBuildId i:nil="true" />
    <DetectedBuildName i:nil="true" />
    <DetectedReleaseId i:nil="true" />
    <DetectedReleaseVersionNumber i:nil="true" />
    <EndDate 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" />
    <TestRunStepIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <VerifiedReleaseId i:nil="true" />
    <VerifiedReleaseVersionNumber i:nil="true" />
  </RemoteIncident>
</ArrayOfRemoteIncident>

[{"IncidentId":null,
"PriorityId":null,
"SeverityId":null,
"IncidentStatusId":null,
"IncidentTypeId":null,
"OpenerId":null,
"OwnerId":null,
"TestRunStepIds":null,
"DetectedReleaseId":null,
"ResolvedReleaseId":null,
"VerifiedReleaseId":null,
"ComponentIds":null,
"Name":null,
"Description":null,
"CreationDate":null,
"StartDate":null,
"EndDate":null,
"ClosedDate":null,
"CompletionPercent":0,
"EstimatedEffort":null,
"ActualEffort":null,
"RemainingEffort":null,
"ProjectedEffort":null,
"LastUpdateDate":"0001-01-01T00:00:00",
"PriorityName":null,
"SeverityName":null,
"IncidentStatusName":null,
"IncidentTypeName":null,
"OpenerName":null,
"OwnerName":null,
"ProjectName":null,
"DetectedReleaseVersionNumber":null,
"ResolvedReleaseVersionNumber":null,
"VerifiedReleaseVersionNumber":null,
"IncidentStatusOpenStatus":null,
"FixedBuildId":null,
"FixedBuildName":null,
"DetectedBuildId":null,
"DetectedBuildName":null,
"ProjectId":0,
"ArtifactTypeId":0,
"ConcurrencyDate":"0001-01-01T00:00:00",
"CustomProperties":null,
"IsAttachments":false,
"Tags":null}]