How to Upload a File to a Task

Scope: disk, task

Who can execute the methods: to complete the whole scenario, you need permission to add files to a Drive folder, edit the task, and read the file

• disk.folder.uploadFile — a user with the Add permission for the Drive folder
• tasks.task.files.attach — the task creator or a user with permission to edit the task and read the file
• disk.attachedObject.get — a user with the Read permission for the file

Bitrix24 has two types of file fields:

• File. This field is not linked to Drive. Files are uploaded directly through a Base64 format string
• File (Drive). This field is linked to Drive. The field stores the Drive object ID. Base64 format is not processed in this field, so the file must first be uploaded to Bitrix24 Drive

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

1. disk.folder.uploadFile — uploads a file to Drive
2. tasks.task.files.attach — attaches a Drive file to a task

1. Upload the File to Bitrix24 Drive1. Upload the File to Bitrix24 Drive

Use the disk.folder.uploadFile method with the following parameters:

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

Uploading the file to Drive is required because the UF_TASK_WEBDAV_FILES field in tasks accepts only Drive file IDs.

How to Use Examples in Documentation

import { B24Hook } from '@bitrix24/b24jssdk'
        
        const $b24 = B24Hook.fromWebhookUrl(process.env.B24_HOOK)
        // B24_HOOK = 'https://your-domain.bitrix24.com/rest/USER_ID/TOKEN/'
        
        const response = await $b24.actions.v2.call.make({
            method: 'disk.folder.uploadFile',
            params: {
                id: 1739,
                data: {
                    NAME: 'ava555.jpg'
                },
                fileContent: [
                    'avatar.jpg',
                    '/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAQDAwQDAwQEAwQ///+dAYq6YFKoAv/AFnAa6ArKv8AAtFJVppxCEAulxQ2DWgfMR//2Q=='
                ]
            },
            requestId: 'disk-uploadfile'
        })
        
        if (!response.isSuccess) {
            throw new Error(response.getErrorMessages().join('; '))
        }
        
        const result = response.getData().result
        

from b24pysdk import BitrixWebhook, Client
        
        token = BitrixWebhook(
            domain="your-domain.bitrix24.com",
            webhook_token="user_id/webhook_key",
        )
        client = Client(token)
        
        result = client.disk.folder.uploadfile(
            bitrix_id=1739,
            data={
                "NAME": "ava555.jpg",
            },
            file_content=[
                "avatar.jpg",
                "/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAQDAwQDAwQEAwQ///+dAYq6YFKoAv/AFnAa6ArKv8AAtFJVppxCEAulxQ2DWgfMR//2Q==",
            ],
        ).response.result
        

require_once 'vendor/autoload.php';
        
        use Bitrix24\SDK\Services\ServiceBuilderFactory;
        use Symfony\Component\EventDispatcher\EventDispatcher;
        
        $serviceBuilder = (new ServiceBuilderFactory(new EventDispatcher(), $log))
            ->initFromWebhook('https://your-domain.bitrix24.com/rest/USER_ID/TOKEN/');
        
        $result = $serviceBuilder->getDiskScope()->folder()->uploadFile(
            1739,
            ['NAME' => 'ava555.jpg'],
            [
                'avatar.jpg',
                '/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAQDAwQDAwQEAwQ///+dAYq6YFKoAv/AFnAa6ArKv8AAtFJVppxCEAulxQ2DWgfMR//2Q=='
            ]
        );
        
        echo '<PRE>';
        print_r($result->getFile());
        echo '</PRE>';
        

As a result of uploading the file to Drive, you get two different file ID values:

• FILE_ID: 28073 — the internal file ID
• ID: 6687 — the Drive object ID. Use this value when working with File (Drive) fields

If you pass FILE_ID instead of ID in a request that updates a File (Drive) field, the file will either not be attached because there is no Drive object with that ID, or a different file will be attached.

{
            "result": {
                "ID": 6687,
                "NAME": "ava555.jpg",
                "TYPE": "file",
                "PARENT_ID": "1739",
                "FILE_ID": 28073,
                "SIZE": "405559"
            }
        }
        

2. Attach the File to the Task2. Attach the File to the Task

Use the tasks.task.files.attach method with the following parameters:

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

const response = await $b24.actions.v2.call.make({
            method: 'tasks.task.files.attach',
            params: {
                taskId: 3709,
                fileId: 6687
            },
            requestId: 'task-files-attach'
        })
        
        if (!response.isSuccess) {
            throw new Error(response.getErrorMessages().join('; '))
        }
        
        const result = response.getData().result
        

result = client.tasks.task.files.attach(
            task_id=3709,
            file_id=6687,
        ).response.result
        

$result = $serviceBuilder->core->call(
            'tasks.task.files.attach',
            [
                'taskId' => 3709,
                'fileId' => 6687
            ]
        )->getResponseData()->getResult();
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

The response returns the link ID between the Drive file and the task: 423. To verify the attachment using this ID, use the disk.attachedObject.get method.

{
            "result": {
                "attachmentId": 423
            }
        }
        

Check the ResultCheck the Result

Pass attachmentId from the response of the tasks.task.files.attach method to the id parameter of the disk.attachedObject.get method.

const checkResponse = await $b24.actions.v2.call.make({
            method: 'disk.attachedObject.get',
            params: {
                id: result.attachmentId
            },
            requestId: 'disk-attached-object-get'
        })
        
        if (!checkResponse.isSuccess) {
            throw new Error(checkResponse.getErrorMessages().join('; '))
        }
        
        console.log(checkResponse.getData().result)
        

file = token.call_method(
            "disk.attachedObject.get",
            {
                "id": result["attachmentId"],
            },
        )["result"]
        
        print(file)
        

$file = $serviceBuilder->core->call(
            'disk.attachedObject.get',
            [
                'id' => $result['attachmentId']
            ]
        )->getResponseData()->getResult();
        
        print_r($file);
        

The method returns the attached file data. The scenario is successful if:

• ID matches attachmentId from the previous step
• OBJECT_ID contains the Drive file identifier
• ENTITY_TYPE equals tasks_task
• ENTITY_ID equals the task identifier
• NAME contains the attached file name

{
            "result": {
                "ID": "423",
                "OBJECT_ID": "6687",
                "MODULE_ID": "tasks",
                "ENTITY_TYPE": "tasks_task",
                "ENTITY_ID": "3709",
                "NAME": "ava555.jpg",
                "SIZE": "405559"
            }
        }
        

Errors and DiagnosticsErrors and Diagnostics

If the method returns an error, check the request data.

Repeat the scenario from the step that returned the error. If the file has already been uploaded to Drive, do not upload it again: fix taskId or fileId and repeat only the tasks.task.files.attach call.

Continue LearningContinue Learning

• How to Create a Task with an Attached File
• Upload a File to a Drive Folder disk.folder.uploadFile
• Attach a File to a Task tasks.task.files.attach
• Get an Attached Object disk.attachedObject.get