GET api/Projects/{projectId}/FolderStructure/TreeQuery

Get a project folder structure

Request Information

URI Parameters

Name	Description	Type	Additional information
projectId		integer	Required

Body Parameters

FolderStructureFilter

Name	Type	Additional information
FolderName	string	None.
FileName	string	None.
Description	string	None.
Tag	string	None.
Extension	string	None.
StartUploadDate	date	None.
EndUploadDate	date	None.
ExistFilterForFolder	boolean	None.
ChildSelectedFoldersString	string	None.
ChildSelectedFolders	Collection of integer	None.
ViewDocOnlyInSelectedFolder	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "folderName": "sample string 1",
  "fileName": "sample string 2",
  "description": "sample string 3",
  "tag": "sample string 4",
  "extension": "sample string 5",
  "startUploadDate": "2026-07-30T23:03:17.3184094+02:00",
  "endUploadDate": "2026-07-30T23:03:17.3184094+02:00",
  "existFilterForFolder": true,
  "childSelectedFoldersString": "1,2",
  "childSelectedFolders": [
    1,
    2
  ],
  "viewDocOnlyInSelectedFolder": true
}

text/html

Sample:

{"folderName":"sample string 1","fileName":"sample string 2","description":"sample string 3","tag":"sample string 4","extension":"sample string 5","startUploadDate":"2026-07-30T23:03:17.3184094+02:00","endUploadDate":"2026-07-30T23:03:17.3184094+02:00","existFilterForFolder":true,"childSelectedFoldersString":"1,2","childSelectedFolders":[1,2],"viewDocOnlyInSelectedFolder":true}

application/xml, text/xml

Sample:

<FolderStructureFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.DocumentModule.Application.Dtos.Dtos.StructureAgg">
  <ChildSelectedFolders xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </ChildSelectedFolders>
  <Description>sample string 3</Description>
  <EndUploadDate>2026-07-30T23:03:17.3184094+02:00</EndUploadDate>
  <Extension>sample string 5</Extension>
  <FileName>sample string 2</FileName>
  <FolderName>sample string 1</FolderName>
  <StartUploadDate>2026-07-30T23:03:17.3184094+02:00</StartUploadDate>
  <Tag>sample string 4</Tag>
  <ViewDocOnlyInSelectedFolder>true</ViewDocOnlyInSelectedFolder>
</FolderStructureFilter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiDataResultOfIEnumerableOfFolderTreeNode

Name	Type	Additional information
Data	Collection of FolderTreeNode	None.
Success	boolean	None.
Message	string	None.
Errors	Collection of CustomError	None.
Warnings	Collection of string	None.

Response Formats

application/json, text/json, text/html

Sample:

Sample not available.