GET api/2.0/files/rooms
Returns the contents of the "Rooms" section by the parameters specified in the request.
Name |
Description |
Type |
Example |
type
sent in body
|
Filter by room type
optional
|
EditingRoomOnly, CustomRoomOnly, FoldersOnly
|
EditingRoomOnly
|
subjectId
sent in body
|
Filter by user ID
|
string
|
some text
|
searchInContent
sent in body
|
Specifies whether to search within the section contents or not
optional
|
Bool value
|
true
|
withSubfolders
sent in body
|
Specifies whether to return sections with or without subfolders
optional
|
Bool value
|
true
|
searchArea
sent in body
|
Room search area (Active, Archive, Any)
optional
|
Active, Archive, Any
|
Active
|
withoutTags
sent in body
|
Specifies whether to search by tags or not
optional
|
Bool value
|
true
|
tags
sent in body
|
Tags in the serialized format
|
string
|
some text
|
excludeSubject
sent in body
|
Specifies whether to exclude a subject or not
optional
|
Bool value
|
true
|
provider
sent in body
|
Filter by provider name (None, Box, DropBox, GoogleDrive, kDrive, OneDrive, SharePoint, WebDav, Yandex)
optional
|
None, Box, DropBox, GoogleDrive, kDrive, OneDrive, SharePoint, WebDav, Yandex
|
Box
|
subjectFilter
sent in body
|
Filter by subject (Owner - 1, Member - 1)
optional
|
Owner, Member
|
Owner
|
GET api/2.0/files/rooms
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
{
"type": "EditingRoomOnly",
"subjectId": "some text",
"searchInContent": true,
"withSubfolders": true,
"searchArea": "Active",
"withoutTags": true,
"tags": "some text",
"excludeSubject": true,
"provider": "Box",
"subjectFilter": "Owner"
}
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>