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 | Description | Type | Additional information |
|---|---|---|---|
| FolderName | string |
None. |
|
| FileName | string |
None. |
|
| Description | string |
None. |
|
| Tag | string |
None. |
|
| Extension | string |
None. |
|
| StartUploadDate | date |
None. |
|
| EndUploadDate | date |
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-05-09T14:03:04.6140639+02:00",
"endUploadDate": "2026-05-09T14:03:04.6140639+02:00"
}
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-05-09T14:03:04.6140639+02:00","endUploadDate":"2026-05-09T14:03:04.6140639+02:00"}
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"> <Description>sample string 3</Description> <EndUploadDate>2026-05-09T14:03:04.6140639+02:00</EndUploadDate> <Extension>sample string 5</Extension> <FileName>sample string 2</FileName> <FolderName>sample string 1</FolderName> <StartUploadDate>2026-05-09T14:03:04.6140639+02:00</StartUploadDate> <Tag>sample string 4</Tag> </FolderStructureFilter>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ApiDataResultOfIEnumerableOfFolderTreeNode| Name | Description | 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.