POST api/Projects/{projectId}/tmsr/{tmsrId}/FolderStructure/TreeNodesQuery
Get a tmsr folder structure
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| projectId | integer |
Required |
|
| tmsrId | 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. |
|
| 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-30T11:04:24.4256644+02:00",
"endUploadDate": "2026-07-30T11:04:24.4256644+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-30T11:04:24.4256644+02:00","endUploadDate":"2026-07-30T11:04:24.4256644+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-30T11:04:24.4256644+02:00</EndUploadDate>
<Extension>sample string 5</Extension>
<FileName>sample string 2</FileName>
<FolderName>sample string 1</FolderName>
<StartUploadDate>2026-07-30T11:04:24.4256644+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
Collection of FolderTreeNode| Name | Description | Type | Additional information |
|---|---|---|---|
| Label | string |
None. |
|
| Data | integer |
None. |
|
| EntityId | integer |
None. |
|
| Key | string |
None. |
|
| RelativePath | string |
None. |
|
| ExpandedIcon | string |
None. |
|
| CollapsedIcon | string |
None. |
|
| Children | Collection of FolderTreeNode |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"label": "sample string 1",
"data": 2,
"entityId": 1,
"key": "sample string 3",
"relativePath": "sample string 4",
"expandedIcon": "fa-folder-open",
"collapsedIcon": "fa-folder",
"children": []
},
{
"label": "sample string 1",
"data": 2,
"entityId": 1,
"key": "sample string 3",
"relativePath": "sample string 4",
"expandedIcon": "fa-folder-open",
"collapsedIcon": "fa-folder",
"children": []
}
]
text/html
Sample:
[{"label":"sample string 1","data":2,"entityId":1,"key":"sample string 3","relativePath":"sample string 4","expandedIcon":"fa-folder-open","collapsedIcon":"fa-folder","children":[]},{"label":"sample string 1","data":2,"entityId":1,"key":"sample string 3","relativePath":"sample string 4","expandedIcon":"fa-folder-open","collapsedIcon":"fa-folder","children":[]}]
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.