How to Upload a File to a Task

Scope: disk, tasks

Who can execute the method: users with access to the drive and tasks sections

In Bitrix24, there are two types of file fields:

File. This field is not linked to the drive; files are uploaded directly through the Base64 format string.
File (drive). This field is linked to the drive, and it stores the ID of the drive object. The Base64 format is not processed in this field, so the file must first be uploaded to the Bitrix24 drive.

To attach a file to a task, perform the following two methods in sequence:

disk.folder.uploadfile — this method uploads the file to the disk.
tasks.task.files.attach — this method attaches the drive file to the task.

1. Uploading a File to the Bitrix24 Drive

To upload a file to the drive, we use the disk.folder.uploadfile method with the following parameters:

id — specify the value 1739 — the identifier of the drive folder where the file will be uploaded.
data — specify the file name NAME, which will be the name the file is saved as on the Bitrix24 drive.
fileContent — pass the file in the format ['file_name.extension', 'file as a Base64 encoded string'].

Uploading the file to the drive is a necessary step, as the UF_TASK_WEBDAV_FILES field in tasks only accepts drive file IDs.

How to Use Examples in Documentation

PHP

BX24.callMethod(
            "disk.folder.uploadfile",
            {
                id: 1739,
                data: {
                    NAME: "ava555.jpg"
                },
                fileContent: [
                    'avatar.jpg',
                    '/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAQDAwQDAwQEAwQ///+dAYq6YFKoAv/AFnAa6ArKv8AAtFJVppxCEAulxQ2DWgfMR//2Q=='
                ]
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'disk.folder.uploadfile',
            [
                'id' => 1739,
                'data' => [
                    'NAME' => 'ava555.jpg'
                ],
                'fileContent' => [
                    'avatar.jpg',
                    '/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAQDAwQDAwQEAwQ///+dAYq6YFKoAv/AFnAa6ArKv8AAtFJVppxCEAulxQ2DWgfMR//2Q=='
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

As a result of uploading the file to the drive, we received two different file ID values:

FILE_ID: 28073 — the internal file ID value.
ID: 6687 — the drive object ID, which we will use in methods for working with "file (drive)" type fields.
If the request to change the "file (drive)" field passes the FILE_ID value, the file will either not be attached to the task because there is no drive object with that ID, or the wrong file will be attached.

{
            "result": {
                "ID": 6687,
                "NAME": "ava555.jpg",
                "CODE": null,
                "STORAGE_ID": "1",
                "TYPE": "file",
                "PARENT_ID": "1739",
                "DELETED_TYPE": 0,
                "GLOBAL_CONTENT_VERSION": 1,
                "FILE_ID": 28073,
                "SIZE": "405559",
                "CREATE_TIME": "2024-11-01T17:00:55+02:00",
                "UPDATE_TIME": "2024-11-01T17:00:55+02:00",
                "DELETE_TIME": null,
                "CREATED_BY": "1",
                "UPDATED_BY": "1",
                "DELETED_BY": null,
                "DOWNLOAD_URL": "https://your-domain.bitrix24.com/rest/download.json?sessid=9dd90ed5a58ccc41af81f5f0043739db&token=disk%7CaWQ9NjY4NyZfPTJ5ZXdvN2Fsb09SMGw1b0FHTkRMSGR5MFJkN1pLTjNS%7CImRvd25sb2FkfGRpc2t8YVdROU5qWTROeVpmUFRKNVpYZHZOMkZzYjA5U01HdzFiMEZIVGtSTVNHUjVNRkprTjFwTFRqTlN8OWRkOTBlZDVhNThjY2M0MWFmODFmNWYwMDQzNzM5ZGIi.Lup1vDbibL6twiCPfCMFnLSoDLleNX0cfMHGv5PFaJw%3D",
                "DETAIL_URL": "https://your-domain.bitrix24.com/company/personal/user/1/disk/file/Created files/New folder for testing process/ava555.jpg"
            }
        }

2. Attaching the File to the Task

To attach the file to the task, we use the tasks.task.files.attach method with the following parameters:

taskId — the ID of the task. To obtain the ID value, use the tasks.task.list method.
fileId — specify the file ID from the result of the previous method 6687.

PHP

BX24.callMethod(
            'tasks.task.files.attach',
            {
                taskId: 3709,
                fileId: 6687
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'tasks.task.files.attach',
            [
                'taskId' => 3709,
                'fileId' => 6687
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

We uploaded the file to the task and received the ID of the link between the drive file and the task 423 in response. To verify the attachment of the file to the task by the link ID, we use the disk.attachedObject.get method.

{
            "result": {
                "attachmentId": 423
            },
            "time": {
                "start": 1730795703.5871601,
                "finish": 1730795703.8165951,
                "duration": 0.22943496704101562,
                "processing": 0.18604612350463867,
                "date_start": "2024-11-05T11:35:03+02:00",
                "date_finish": "2024-11-05T11:35:03+02:00",
                "operating_reset_at": 1730796303,
                "operating": 0.18602108955383301
            }
        }

Code Example

PHP

// Function to upload a file
        function uploadFileToDisk() {
            // ID of the folder where you want to upload the file
            var folderId = 'your_folder_ID';
            // File name and its content in Base64 format
            var fileName = 'your_file_name';
            var fileContentBase64 = 'your_file_content_Base64';
            // ID of the task to which the file needs to be attached
            var taskId = 'your_task_ID';
        
            // Call the disk.folder.uploadfile method
            BX24.callMethod(
                'disk.folder.uploadfile',
                {
                    id: folderId,
                    data: {
                        NAME: fileName
                    },
                    fileContent: [
                        fileName,
                        fileContentBase64
                    ]
                },
                function(result) {
                    if (result.error()) {
                        console.error('Error uploading file:', result.error());
                    } else {
                        console.log('File uploaded successfully!', result.data());
                        var fileId = result.data().ID; // Use ID from the result
                        attachFileToTask(taskId, fileId);
                    }
                }
            );
        }
        
        // Function to attach a file to an existing task
        function attachFileToTask(taskId, fileId) {
            // Call the tasks.task.files.attach method
            BX24.callMethod(
                'tasks.task.files.attach',
                {
                    taskId: taskId,
                    fileIds: [fileId]
                },
                function(result) {
                    if (result.error()) {
                        console.error('Error attaching file to task:', result.error());
                    } else {
                        console.log('File successfully attached to the task!', result.data());
                    }
                }
            );
        }
        
        // Call the function to upload the file and attach it to the task
        uploadFileToDisk();

require_once('crest.php');
        
        // Function to upload a file
        function uploadFileToDisk() {
            // ID of the folder where you want to upload the file
            $folderId = 'your_folder_ID';
            // Name of the file you want to upload
            $fileName = 'your_file_name';
            // Path to the file on your file system
            $filePath = '/path/to/your/file';
        
            // Read the file content and encode it in Base64
            $fileContentBase64 = base64_encode(file_get_contents($filePath));
        
            // ID of the task to which the file needs to be attached
            $taskId = 'your_task_ID';
        
            // Call the disk.folder.uploadfile method
            $result = CRest::call(
                'disk.folder.uploadfile',
                [
                    'id' => $folderId,
                    'data' => [
                        'NAME' => $fileName
                    ],
                    'fileContent' => [
                        $fileName,
                        $fileContentBase64
                    ]
                ]
            );
        
            if (isset($result['error'])) {
                echo 'Error uploading file: ' . $result['error'];
            } else {
                echo 'File uploaded successfully!';
                $fileId = $result['result']['ID']; // Use ID from the result
                attachFileToTask($taskId, $fileId);
            }
        }
        
        // Function to attach a file to an existing task
        function attachFileToTask($taskId, $fileId) {
            // Call the tasks.task.files.attach method
            $result = CRest::call(
                'tasks.task.files.attach',
                [
                    'taskId' => $taskId,
                    'fileIds' => [$fileId]
                ]
            );
        
            if (isset($result['error'])) {
                echo 'Error attaching file to task: ' . $result['error'];
            } else {
                echo 'File successfully attached to the task!';
            }
        }
        
        // Call the function to upload the file and attach it to the task
        uploadFileToDisk();