Get Started
Portal api methods
Help

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

Description

Start downlaod process of files and folders with ID

Parameters
Name Description Type Example
fileIds
sent in body
File ID list Collection of strings
collection
some text
folderIds
sent in body
Folder ID list 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": "f200c34d-0e77-4769-8577-443f1ea511ef",
      "operation": 0,
      "progress": 100,
      "error": "",
      "processed": "1",
      "finished": false,
      "url": null,
      "files": [
        {
          "folderId": 12334,
          "version": 3,
          "versionGroup": 1,
          "contentLength": "12345",
          "fileStatus": 2,
          "viewUrl": "http:\/\/www.onlyoffice.com\/viewfile?fileid=2221",
          "fileType": 7,
          "fileExst": ".txt",
          "comment": null,
          "id": 501727846,
          "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": "2019-06-23T18:26:27.1063549Z",
          "createdBy": {
            "id": "00000000-0000-0000-0000-000000000000",
            "displayName": "Mike Zanyatski",
            "title": "Manager",
            "avatarSmall": "url to small avatar",
            "profileUrl": ""
          },
          "updated": "2019-06-23T18:26:27.1063549Z",
          "providerItem": false
        }
      ],
      "folders": [
        {
          "parentId": 501727846,
          "filesCount": 501727846,
          "foldersCount": 501727846,
          "id": 501727846,
          "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": "2019-06-23T18:26:27.1063549Z",
          "createdBy": {
            "id": "00000000-0000-0000-0000-000000000000",
            "displayName": "Mike Zanyatski",
            "title": "Manager",
            "avatarSmall": "url to small avatar",
            "profileUrl": ""
          },
          "updated": "2019-06-23T18:26:27.1063549Z",
          "providerItem": false
        }
      ]
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <id>f200c34d-0e77-4769-8577-443f1ea511ef</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>12345</contentLength>
      <fileStatus>2</fileStatus>
      <viewUrl>http://www.onlyoffice.com/viewfile?fileid=2221</viewUrl>
      <fileType>7</fileType>
      <fileExst>.txt</fileExst>
      <comment />
      <id>501727846</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>2019-06-23T18:26:27.1063549Z</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>2019-06-23T18:26:27.1063549Z</updated>
      <providerItem>false</providerItem>
    </files>
    <folders>
      <parentId>501727846</parentId>
      <filesCount>501727846</filesCount>
      <foldersCount>501727846</foldersCount>
      <id>501727846</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>2019-06-23T18:26:27.1063549Z</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>2019-06-23T18:26:27.1063549Z</updated>
      <providerItem>false</providerItem>
    </folders>
  </response>
</result>