SpiraPlan: REST Web Service (v5.0)

See all operations

GET: projects/{project_id}/test-runs/{test_run_id}


Retrieves a single test run in the system. Only returns the generic information that is applicable for both automated and manual tests. Consider using TestRun_RetrieveAutomatedById or TestRun_RetrieveManualById if you need the automation/manual specific data for the test run

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


Request Parameters

Name Description
project_id The id of the current project
test_run_id The id of the test run

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
TestRunId The id of the test run
Name The name of the test run (usually the same as the test case)
TestCaseId The id of the test case that the test run is an instance of
TestRunTypeId The id of the type of test run (automated vs. manual)
TesterId The id of the user that executed the test The authenticated user is used if no value is provided
ExecutionStatusId The id of overall execution status for the test run Failed = 1; Passed = 2; NotRun = 3; NotApplicable = 4; Blocked = 5; Caution = 6;
ReleaseId The id of the release that the test run should be reported against
TestSetId The id of the test set that the test run should be reported against
TestSetTestCaseId The id of the unique test case entry in the test set
StartDate The date/time that the test execution was started
EndDate The date/time that the test execution was completed
BuildId The id of the build that the test was executed against
EstimatedDuration The estimated duration of how long the test should take to execute (read-only) This field is populated from the test case being executed
ActualDuration The actual duration of how long the test should take to execute (read-only) This field is calculated from the start/end dates provided during execution
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?