SpiraPlan: REST Web Service (v5.0)

See all operations

GET: projects/{project_id}/test-folders/{test_case_folder_id}

Description

Retrieves a single test folder 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):

https://api.inflectra.com/Spira/Services/v5_0/RestService.svc/projects/{project_id}/test-folders/{test_case_folder_id}

Request Parameters

Name Description
project_id The id of the current project
test_case_folder_id The id of the test folder

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
TestCaseFolderId The id of the test case folder
ProjectId The id of the project this folder belongs to
IndentLevel The indentation level of the folder The system uses a set of three-letter segments to denote indent (e.g. AAA followed by AAB, etc.)
Name The name of the test case folder
Description The description of the test case folder
LastUpdateDate The date the test case folder was last updated
ExecutionDate The date the test cases in the folder were last executed
EstimatedDuration The estimated time to execute the test case
ProjectName The display name of the project that the test case folder belongs to
ParentTestCaseFolderId The ID of the parent folder of this folder (if any)
ActualDuration The actual duration of all the tests in the folder
CountBlocked The count of blocked test cases in the folder
CountCaution The count of blocked test cases in the folder
CountFailed The count of blocked test cases in the folder
CountNotApplicable The count of blocked test cases in the folder
CountNotRun The count of blocked test cases in the folder
CountPassed The count of blocked test cases in the folder