See all operations

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

Description

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

https://api.inflectra.com/spira/services/v6_0/RestService.svc/projects/{project_id}/document-folders/{folder_id}

Request Parameters

Name	Description
project_id	The id of the current project
folder_id	The id of the folder being retrieved

Request Body

Nothing Expected

Nothing Expected

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 to add to the existing root folder
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.)

<RemoteDocumentFolder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v6_0.DataObjects">
  <IndentLevel i:nil="true" />
  <Name i:nil="true" />
  <ParentProjectAttachmentFolderId i:nil="true" />
  <ProjectAttachmentFolderId i:nil="true" />
  <ProjectId>0</ProjectId>
</RemoteDocumentFolder>

{"ProjectAttachmentFolderId":null,
"ProjectId":0,
"ParentProjectAttachmentFolderId":null,
"Name":null,
"IndentLevel":null}