Get Started
Usage API
More information

PUT api/2.0/files/fileops/bulkdownload This function requires authentication

Description

Starts the download process of files and folders with the IDs specified in the request.

Parameters
Name Description Type Example
fileIds
sent in body
List of file IDs Collection of strings
collection
some text
folderIds
sent in body
List of folder IDs Collection of strings
collection
some text
Example
PUT api/2.0/files/fileops/bulkdownload
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "fileIds": [
    "some text"
  ],
  "folderIds": [
    "some text"
  ]
}
Returns

Operation result

Example Response

application/json

{
  "status": 0,
  "response": [
    {
      "id": "fa9598eb-00b9-4eb0-88ca-4ea0fae8f92d",
      "operation": 0,
      "progress": 100,
      "error": "",
      "processed": "1",
      "finished": false,
      "url": null,
      "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": 488263859,
          "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-10-26T01:24:24.5328322Z",
          "createdBy": {
            "id": "00000000-0000-0000-0000-000000000000",
            "displayName": "Mike Zanyatski",
            "title": "Manager",
            "avatarSmall": "url to small avatar",
            "profileUrl": ""
          },
          "updated": "2021-10-26T01:24:24.5328322Z"
        }
      ],
      "folders": [
        {
          "parentId": 488263859,
          "filesCount": 488263859,
          "foldersCount": 488263859,
          "id": 488263859,
          "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-10-26T01:24:24.5328322Z",
          "createdBy": {
            "id": "00000000-0000-0000-0000-000000000000",
            "displayName": "Mike Zanyatski",
            "title": "Manager",
            "avatarSmall": "url to small avatar",
            "profileUrl": ""
          },
          "updated": "2021-10-26T01:24:24.5328322Z"
        }
      ]
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <id>fa9598eb-00b9-4eb0-88ca-4ea0fae8f92d</id>
    <operation>0</operation>
    <progress>100</progress>
    <error></error>
    <processed>1</processed>
    <finished>false</finished>
    <url />
    <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>488263859</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-10-26T01:24:24.5328322Z</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-10-26T01:24:24.5328322Z</updated>
    </files>
    <folders>
      <parentId>488263859</parentId>
      <filesCount>488263859</filesCount>
      <foldersCount>488263859</foldersCount>
      <id>488263859</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-10-26T01:24:24.5328322Z</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-10-26T01:24:24.5328322Z</updated>
    </folders>
  </response>
</result>