SpiraPlan: REST Web Service (v5.0)

See all operations

GET: projects/{project_id}/task-folders/{task_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}/task-folders/{task_folder_id}

Request Parameters

Name Description
project_id The id of the current project
task_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
TaskFolderId The id of the task 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 task folder
ParentTaskFolderId The ID of the parent folder of this folder (if any)