SpiraPlan: REST Web Service (v6.0)

See all operations

GET: projects/{project_id}/document-folders/children?parent_folder_id={parent_folder_id}

Description

Retrieves a list of all the document folders directly under the specified parent folder

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}/document-folders/children?parent_folder_id={parent_folder_id}

Request Parameters

Name Description
project_id The id of the project
parent_folder_id The id of the parent folder (null == root)

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