|
Get Started
Portal api methods
Help
|
GET api/2.0/files/@common This function requires authenticationDescription
Returns the detailed list of files and folders located in the Common section Parameters
This method doesn't have any parameters Example
GET api/2.0/files/@common Host: yourportal.onlyoffice.com Content-Type: application/json Accept: application/json Returns
Common folder contents Example Response
application/json {
"status": 0,
"response": {
"files": [
{
"folderId": 12334,
"version": 3,
"versionGroup": 1,
"contentLength": "12.06 KB",
"pureContentLength": 12345,
"fileStatus": 2,
"viewUrl": "http:\/\/www.onlyoffice.com\/viewfile?fileid=2221",
"fileType": 7,
"fileExst": ".txt",
"comment": null,
"id": 192720414,
"title": "Some titile.txt",
"access": 1,
"shared": false,
"rootFolderType": 2,
"updatedBy": {
"id": "00000000-0000-0000-0000-000000000000",
"displayName": "Mike Zanyatski",
"title": "Manager",
"avatarSmall": "url to small avatar",
"profileUrl": ""
},
"created": "2021-03-06T18:32:50.9761735Z",
"createdBy": {
"id": "00000000-0000-0000-0000-000000000000",
"displayName": "Mike Zanyatski",
"title": "Manager",
"avatarSmall": "url to small avatar",
"profileUrl": ""
},
"updated": "2021-03-06T18:32:50.9761735Z"
},
{
"folderId": 12334,
"version": 3,
"versionGroup": 1,
"contentLength": "12.06 KB",
"pureContentLength": 12345,
"fileStatus": 2,
"viewUrl": "http:\/\/www.onlyoffice.com\/viewfile?fileid=2221",
"fileType": 7,
"fileExst": ".txt",
"comment": null,
"id": 192720414,
"title": "Some titile.txt",
"access": 1,
"shared": false,
"rootFolderType": 2,
"updatedBy": {
"id": "00000000-0000-0000-0000-000000000000",
"displayName": "Mike Zanyatski",
"title": "Manager",
"avatarSmall": "url to small avatar",
"profileUrl": ""
},
"created": "2021-03-06T18:32:50.9761735Z",
"createdBy": {
"id": "00000000-0000-0000-0000-000000000000",
"displayName": "Mike Zanyatski",
"title": "Manager",
"avatarSmall": "url to small avatar",
"profileUrl": ""
},
"updated": "2021-03-06T18:32:50.9761735Z"
}
],
"folders": [
{
"parentId": 192720414,
"filesCount": 192720414,
"foldersCount": 192720414,
"id": 192720414,
"title": "Some titile",
"access": 1,
"shared": false,
"rootFolderType": 2,
"updatedBy": {
"id": "00000000-0000-0000-0000-000000000000",
"displayName": "Mike Zanyatski",
"title": "Manager",
"avatarSmall": "url to small avatar",
"profileUrl": ""
},
"created": "2021-03-06T18:32:50.9761735Z",
"createdBy": {
"id": "00000000-0000-0000-0000-000000000000",
"displayName": "Mike Zanyatski",
"title": "Manager",
"avatarSmall": "url to small avatar",
"profileUrl": ""
},
"updated": "2021-03-06T18:32:50.9761735Z"
},
{
"parentId": 192720414,
"filesCount": 192720414,
"foldersCount": 192720414,
"id": 192720414,
"title": "Some titile",
"access": 1,
"shared": false,
"rootFolderType": 2,
"updatedBy": {
"id": "00000000-0000-0000-0000-000000000000",
"displayName": "Mike Zanyatski",
"title": "Manager",
"avatarSmall": "url to small avatar",
"profileUrl": ""
},
"created": "2021-03-06T18:32:50.9761735Z",
"createdBy": {
"id": "00000000-0000-0000-0000-000000000000",
"displayName": "Mike Zanyatski",
"title": "Manager",
"avatarSmall": "url to small avatar",
"profileUrl": ""
},
"updated": "2021-03-06T18:32:50.9761735Z"
}
],
"current": {
"parentId": 192720414,
"filesCount": 192720414,
"foldersCount": 192720414,
"id": 192720414,
"title": "Some titile",
"access": 1,
"shared": false,
"rootFolderType": 2,
"updatedBy": {
"id": "00000000-0000-0000-0000-000000000000",
"displayName": "Mike Zanyatski",
"title": "Manager",
"avatarSmall": "url to small avatar",
"profileUrl": ""
},
"created": "2021-03-06T18:32:50.9761735Z",
"createdBy": {
"id": "00000000-0000-0000-0000-000000000000",
"displayName": "Mike Zanyatski",
"title": "Manager",
"avatarSmall": "url to small avatar",
"profileUrl": ""
},
"updated": "2021-03-06T18:32:50.9761735Z"
},
"pathParts": {
"key": "Key",
"path": "\/\/path\/\/to\/\/folder"
},
"startIndex": 0,
"count": 4,
"total": 4
}
}
text/xml <result>
<status>0</status>
<response>
<files>
<folderId>12334</folderId>
<version>3</version>
<versionGroup>1</versionGroup>
<contentLength>12.06 KB</contentLength>
<pureContentLength>12345</pureContentLength>
<fileStatus>2</fileStatus>
<viewUrl>http://www.onlyoffice.com/viewfile?fileid=2221</viewUrl>
<fileType>7</fileType>
<fileExst>.txt</fileExst>
<comment />
<id>192720414</id>
<title>Some titile.txt</title>
<access>1</access>
<shared>false</shared>
<rootFolderType>2</rootFolderType>
<updatedBy>
<id>00000000-0000-0000-0000-000000000000</id>
<displayName>Mike Zanyatski</displayName>
<title>Manager</title>
<avatarSmall>url to small avatar</avatarSmall>
<profileUrl></profileUrl>
</updatedBy>
<created>2021-03-06T18:32:50.9761735Z</created>
<createdBy>
<id>00000000-0000-0000-0000-000000000000</id>
<displayName>Mike Zanyatski</displayName>
<title>Manager</title>
<avatarSmall>url to small avatar</avatarSmall>
<profileUrl></profileUrl>
</createdBy>
<updated>2021-03-06T18:32:50.9761735Z</updated>
</files>
<files>
<folderId>12334</folderId>
<version>3</version>
<versionGroup>1</versionGroup>
<contentLength>12.06 KB</contentLength>
<pureContentLength>12345</pureContentLength>
<fileStatus>2</fileStatus>
<viewUrl>http://www.onlyoffice.com/viewfile?fileid=2221</viewUrl>
<fileType>7</fileType>
<fileExst>.txt</fileExst>
<comment />
<id>192720414</id>
<title>Some titile.txt</title>
<access>1</access>
<shared>false</shared>
<rootFolderType>2</rootFolderType>
<updatedBy>
<id>00000000-0000-0000-0000-000000000000</id>
<displayName>Mike Zanyatski</displayName>
<title>Manager</title>
<avatarSmall>url to small avatar</avatarSmall>
<profileUrl></profileUrl>
</updatedBy>
<created>2021-03-06T18:32:50.9761735Z</created>
<createdBy>
<id>00000000-0000-0000-0000-000000000000</id>
<displayName>Mike Zanyatski</displayName>
<title>Manager</title>
<avatarSmall>url to small avatar</avatarSmall>
<profileUrl></profileUrl>
</createdBy>
<updated>2021-03-06T18:32:50.9761735Z</updated>
</files>
<folders>
<parentId>192720414</parentId>
<filesCount>192720414</filesCount>
<foldersCount>192720414</foldersCount>
<id>192720414</id>
<title>Some titile</title>
<access>1</access>
<shared>false</shared>
<rootFolderType>2</rootFolderType>
<updatedBy>
<id>00000000-0000-0000-0000-000000000000</id>
<displayName>Mike Zanyatski</displayName>
<title>Manager</title>
<avatarSmall>url to small avatar</avatarSmall>
<profileUrl></profileUrl>
</updatedBy>
<created>2021-03-06T18:32:50.9761735Z</created>
<createdBy>
<id>00000000-0000-0000-0000-000000000000</id>
<displayName>Mike Zanyatski</displayName>
<title>Manager</title>
<avatarSmall>url to small avatar</avatarSmall>
<profileUrl></profileUrl>
</createdBy>
<updated>2021-03-06T18:32:50.9761735Z</updated>
</folders>
<folders>
<parentId>192720414</parentId>
<filesCount>192720414</filesCount>
<foldersCount>192720414</foldersCount>
<id>192720414</id>
<title>Some titile</title>
<access>1</access>
<shared>false</shared>
<rootFolderType>2</rootFolderType>
<updatedBy>
<id>00000000-0000-0000-0000-000000000000</id>
<displayName>Mike Zanyatski</displayName>
<title>Manager</title>
<avatarSmall>url to small avatar</avatarSmall>
<profileUrl></profileUrl>
</updatedBy>
<created>2021-03-06T18:32:50.9761735Z</created>
<createdBy>
<id>00000000-0000-0000-0000-000000000000</id>
<displayName>Mike Zanyatski</displayName>
<title>Manager</title>
<avatarSmall>url to small avatar</avatarSmall>
<profileUrl></profileUrl>
</createdBy>
<updated>2021-03-06T18:32:50.9761735Z</updated>
</folders>
<current>
<parentId>192720414</parentId>
<filesCount>192720414</filesCount>
<foldersCount>192720414</foldersCount>
<id>192720414</id>
<title>Some titile</title>
<access>1</access>
<shared>false</shared>
<rootFolderType>2</rootFolderType>
<updatedBy>
<id>00000000-0000-0000-0000-000000000000</id>
<displayName>Mike Zanyatski</displayName>
<title>Manager</title>
<avatarSmall>url to small avatar</avatarSmall>
<profileUrl></profileUrl>
</updatedBy>
<created>2021-03-06T18:32:50.9761735Z</created>
<createdBy>
<id>00000000-0000-0000-0000-000000000000</id>
<displayName>Mike Zanyatski</displayName>
<title>Manager</title>
<avatarSmall>url to small avatar</avatarSmall>
<profileUrl></profileUrl>
</createdBy>
<updated>2021-03-06T18:32:50.9761735Z</updated>
</current>
<pathParts>
<key>Key</key>
<path>//path//to//folder</path>
</pathParts>
<startIndex>0</startIndex>
<count>4</count>
<total>4</total>
</response>
</result>
|
|
© Ascensio System SIA 2021. All rights reserved
|
|