Drive: Overview of Methods

Drive is a tool for working with files. It allows you to:

  • store company documents and personal files
  • upload, edit documents, and view change history
  • configure access permissions for files and folders
  • share files via public links with external users
  • synchronize files with your computer

Drive is integrated with Tasks, Chats, CRM, Workgroups, and other Bitrix24 tools. This simplifies work by providing quick access to files, collaborative work on them, and automating document flow.

Quick navigation: all methods

User documentation: Bitrix24 Drive

Drive Storage

There are three types of storage:

  • personal user storage
  • company shared storage
  • workgroup storage

Storage can be managed using the group of methods disk.storage.*.

Working with Folders and Files

Folders and files can be created, moved, deleted, and their access permissions can be modified. Use the groups of methods disk.folder.* and disk.file.* for this.

You can find out the version of a file using the method disk.version.get.

Drive Connection with Other Objects

CRM. Files can be attached to deals and estimates. The group of methods crm.activity.* is responsible for working with activities, while crm.quote.* handles estimates.

Workflows. You can initiate workflows for documents in the shared drive. Workflow management is performed using the methods bizproc.workflow.*.

Tasks. Files are attached to task descriptions. All task participants can view, edit, and download attached files. Work with tasks must be done through the methods tasks.task.*.

Calendar. Files can be added to events and become accessible to all participants. You can create and modify events using the methods calendar.event.*.

News Feed. Files can be attached to messages and comments. The method log.blogpost.add creates a new message, while the method log.blogcomment.add creates a new comment.

Email. Attachments from emails are saved on Drive. Emails can only be managed through the Bitrix24 interface. If an email is saved in CRM, attachments can be interacted with using the methods crm.activity.* through the FILES field.

Workgroups and Projects. Drive is integrated into workgroups and projects, each having its own storage.

Universal Lists. List items are linked to Drive through the field of type File (Drive). You can create and modify items using the methods lists.element.*.

Chats. Users can exchange documents, photos, videos, and audio. Files can be viewed and downloaded, and documents can be edited in the chat without downloading. Attached files are available to all chat participants. The method im.message.add sends a message with a file in the chat.

Overview of Methods

Scope: disk

Who can execute the method: any user

Version

Method

Description

disk.version.get

Returns the version by identifier

Folder

Method

Description

disk.folder.getfields

Returns the description of folder fields

disk.folder.get

Returns the folder by identifier

disk.folder.getchildren

Returns a list of files and folders located in the folder

disk.folder.addsubfolder

Creates a subfolder

disk.folder.sharetouser

Assigns access permissions to the folder

disk.folder.copyto

Copies the folder to the specified folder

disk.folder.moveto

Moves the folder to the specified folder

disk.folder.rename

Renames the folder

disk.folder.deletetree

Permanently deletes the folder and all its contents

disk.folder.markdeleted

Moves the folder to the trash

disk.folder.restore

Restores the folder from the trash

disk.folder.uploadfile

Uploads a new file to the specified folder

disk.folder.getexternallink

Returns a public link to the folder

Access Permissions

Method

Description

disk.rights.getTasks

Allows you to get a list of access levels that can be used in assigning permissions

Attached File

Method

Description

disk.attachedObject.get

Returns information about the attached file

File

Method

Description

disk.file.getfields

Returns the description of file fields

disk.file.get

Returns the file by identifier

disk.file.rename

Renames the file

disk.file.copyto

Copies the file to the specified folder

disk.file.moveto

Moves the file to the specified folder

disk.file.delete

Permanently deletes the file

disk.file.markdeleted

Moves the file to the trash

disk.file.restore

Restores the file from the trash

disk.file.uploadversion

Uploads a new version of the file

disk.file.getVersions

Returns a list of file versions

disk.file.restoreFromVersion

Restores the file from a specific version

disk.file.getExternalLink

Returns a public link to the file

Storage

Method

Description

disk.storage.getfields

Returns the description of storage fields

disk.storage.get

Returns the storage by identifier

disk.storage.rename

Renames the application storage

disk.storage.getlist

Returns a list of available storages

disk.storage.gettypes

Returns a list of storage types

disk.storage.addfolder

Creates a folder in the root of the storage

disk.storage.getchildren

Returns a list of files and folders that are directly in the root of the storage

disk.storage.uploadfile

Uploads a new file to the root of the storage

disk.storage.getforapp

Returns the application storage description