Returns all the sections matching the parameters specified in the request.
Name | Description | Type | Example |
userIdOrGroupId
sent in body
|
User or group ID
optional
|
guid | 9924256A-739C-462b-AF15-E652A3B1B6EB |
filterType
sent in body
|
Filter type
Allowed values: None (0), FilesOnly (1), FoldersOnly (2), DocumentsOnly (3), PresentationsOnly (4), SpreadsheetsOnly (5), ImagesOnly (7), ByUser (8), ByDepartment (9), ArchiveOnly (10), ByExtension (11), MediaOnly (12), EditingRooms (14), CustomRooms (17), OFormTemplateOnly (18), OFormOnly (19)
optional
|
None, FilesOnly, FoldersOnly, DocumentsOnly, PresentationsOnly, SpreadsheetsOnly, ImagesOnly, ByUser, ByDepartment, ArchiveOnly, ByExtension, MediaOnly, EditingRooms, CustomRooms, OFormTemplateOnly, OFormOnly | None |
withsubfolders
sent in body
|
Specifies whether to return sections with or without subfolders
optional
|
Bool value | true |
withoutTrash
sent in body
|
Specifies whether to return the "Trash" section or not
optional
|
Bool value | true |
searchInContent
sent in body
|
Specifies whether to search within the section contents or not
optional
|
Bool value | true |
withoutAdditionalFolder
sent in body
|
Specifies whether to return sections with or without additional folders
optional
|
Bool value | true |
GET api/2.0/files/@root Host: yourportal.onlyoffice.com Content-Type: application/json Accept: application/json { "userIdOrGroupId": "9924256A-739C-462b-AF15-E652A3B1B6EB", "filterType": "None", "withsubfolders": true, "withoutTrash": true, "searchInContent": true, "withoutAdditionalFolder": true }
List of section contents with the following parameters
application/json
{ "status": 0, "response": [ { "Current": { "ParentId": 1234, "FilesCount": 1234, "FoldersCount": 1234, "New": 1234, "Mute": true, "Pinned": true, "Private": true }, "StartIndex": 1234, "Count": 1234, "Total": 1234, "New": 1234 } ] }
text/xml
<result> <status>0</status> <response> <Current> <ParentId>1234</ParentId> <FilesCount>1234</FilesCount> <FoldersCount>1234</FoldersCount> <New>1234</New> <Mute>True</Mute> <Pinned>True</Pinned> <Private>True</Private> </Current> <StartIndex>1234</StartIndex> <Count>1234</Count> <Total>1234</Total> <New>1234</New> </response> </result>