SpiraPlan: REST Web Service (v5.0)

See all operations

GET: projects/{project_id}/document-folders/{folder_id}


Retrieves the folder by the specified ID.

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
folder_id The id of the folder being retrieved

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
ProjectAttachmentFolderId The id of the document folder
ProjectId The id of the project that the folder belongs to
ParentProjectAttachmentFolderId The id of the parent folder of this folder Null for root folders
Name The name of the folder.
IndentLevel The indentation level of the artifact The system uses a set of three-letter segments to denote indent (e.g. AAA followed by AAB, etc.)