SpiraTeam: REST Web Service (v5.0)

See all operations

GET: projects/{project_id}/incidents/{incident_id}

Description

Retrieves a single incident in the system

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):

http://api.inflectra.com/Spira/Services/v5_0/RestService.svc/projects/{project_id}/incidents/{incident_id}

Request Parameters

Name Description
project_id The id of the project
incident_id The id of the incident

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
IncidentId The id of the incident (integer)
PriorityId The id of the priority of the incident (integer)
SeverityId The id of the severity of the incident (integer)
IncidentStatusId The id of the status of the incident (integer) If no value is provided, the default status for the workflow is used
IncidentTypeId The id of the type of the incident (integer) If no value is provided, the default type for the project is used
OpenerId The id of the user who detected the incident (integer) If a value is not provided, the authenticated user is used
OwnerId The id of the user to the incident is assigned-to (integer)
TestRunStepIds The id of the test run steps that the incident relates to (integer)
DetectedReleaseId The id of the release/iteration that the incident was detected in (integer)
ResolvedReleaseId The id of the release/iteration that the incident will be fixed in (integer)
VerifiedReleaseId The id of the release/iteration that the incident was retested in (integer)
ComponentIds The list of components that this incident belongs to (array of integers)
Name The name of the incident (string)
Description The description of the incident (string)
CreationDate The date/time that the incident was originally created If no value is provided, the current date/time on the server is used (date-time)
StartDate The date that work started on the incident (date-time)
ClosedDate The date that the incident was closed (date-time)
CompletionPercent The completion percentage (value = 0-100) of the incident as calculated in the system from the remaining effort vs. the original estimated effort. (integer) Read-Only
EstimatedEffort The estimated effort (in minutes) to resolve the incident (integer)
ActualEffort The actual effort (in minutes) it took to resolve the incident (integer)
RemainingEffort The effort remaining as reported by the developer
ProjectedEffort The projected actual effort of the incident when it is completed (integer) Read-Only
LastUpdateDate The date/time that the incident was last modified (date-time)
PriorityName The display name of the priority of the incident (string)
SeverityName The display name of the severity of the incident (string)
IncidentStatusName The display name of the status of the incident (string)
IncidentTypeName The display name of the type of the incident (string)
OpenerName The display name of the user that detected the incident (string)
OwnerName The display name of the user that the incident is assigned to (string)
ProjectName The display name of the project the incident belongs to (string)
DetectedReleaseVersionNumber The version number of the release/iteration that the incident was detected in (string)
ResolvedReleaseVersionNumber The version number of the release/iteration that the incident will be resolved in (string)
VerifiedReleaseVersionNumber The version number of the release/iteration that the incident was retested in (string)
IncidentStatusOpenStatus Is the incident in an 'open' status or not?
FixedBuildId The id of the build that the incident was fixed in (integer)
FixedBuildName The name of the build that the incident was fixed in (string)
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
ConcurrencyDate The datetime used to track optimistic concurrency to prevent edit conflicts
CustomProperties The list of associated custom properties/fields for this artifact
IsAttachments Does this artifact have any attachments?