Получить путь к файлу lists.element.get.file.url

Scope: lists

Кто может выполнять метод: пользователь с правом «Чтение» для нужного списка

Метод lists.element.get.file.url возвращает путь к файлу.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

IBLOCK_TYPE_ID*
string

Идентификатор типа инфоблока. Возможные значения:

  • lists — тип инфоблока списка
  • bitrix_processes — тип инфоблока процессов
  • lists_socnet — тип инфоблока списков групп

IBLOCK_ID*
integer

Идентификатор инфоблока.

Идентификатор можно получить с помощью метода lists.get

IBLOCK_CODE*
string

Cимвольный код инфоблока.

Код можно получить с помощью метода lists.get

Необходимо указать хотя бы один из параметров: IBLOCK_ID или IBLOCK_CODE

ELEMENT_ID*
integer

Идентификатор элемента.

Идентификатор можно получить с помощью метода lists.element.get

ELEMENT_CODE*
string

Символьный код элемента.

Код можно получить с помощью метода lists.element.get

Необходимо указать хотя бы один из параметров: ELEMENT_ID или ELEMENT_CODE

FIELD_ID*
integer

Идентификатор свойства Файл или Файл (Диск), без префикса PROPERTY_

Примеры кода

Как использовать примеры в документации

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"IBLOCK_TYPE_ID":"lists","IBLOCK_ID":37,"ELEMENT_ID":231,"FIELD_ID":423}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/lists.element.get.file.url
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"IBLOCK_TYPE_ID":"lists","IBLOCK_ID":37,"ELEMENT_ID":231,"FIELD_ID":423,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/lists.element.get.file.url
        
try
        {
            const response = await $b24.callMethod(
                'lists.element.get.file.url',
                {
                    IBLOCK_TYPE_ID: 'lists',
                    IBLOCK_ID: 37,
                    ELEMENT_ID: 231,
                    FIELD_ID: 423
                }
            );
            
            const result = response.getData().result;
            console.log('URL файла:', result);
            
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'lists.element.get.file.url',
                    [
                        'IBLOCK_TYPE_ID' => 'lists',
                        'IBLOCK_ID' => 37,
                        'ELEMENT_ID' => 231,
                        'FIELD_ID' => 423
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'URL файла: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching file URL: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'lists.element.get.file.url',
            {
                IBLOCK_TYPE_ID: 'lists',
                IBLOCK_ID: 37,
                ELEMENT_ID: 231,
                FIELD_ID: 423  // Файл (Диск)
            },
            function(res) {
                if (res.error()) {
                    console.error(res.error());
                } else {
                    const result = res.data();
                    console.log('URL файла:', result);
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'lists.element.get.file.url',
            [
                'IBLOCK_TYPE_ID' => 'lists',
                'IBLOCK_ID' => 37,
                'ELEMENT_ID' => 231,
                'FIELD_ID' => 423
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Обработка ответа

Пример ответа для свойства типа Файл (Диск)

HTTP-статус: 200

{
            "result": ["/bitrix/tools/disk/uf.php?attachedId=103&action=download&ncc=1"],
            "time": {
                "start": 1763660762,
                "finish": 1763660762.617248,
                "duration": 0.6172480583190918,
                "processing": 0,
                "date_start": "2025-11-19T16:46:02+03:00",
                "date_finish": "2025-11-19T16:46:02+03:00",
                "operating_reset_at": 1763661362,
                "operating": 0
            }
        }

Пример ответа для свойства типа Файл

HTTP-статус: 200

{
            "result": ["/company/lists/37/file/0/6651/PROPERTY_425/32521/?ncc=y&download=y"],
                "time": {
                    "start": 1764014727,
                    "finish": 1764014727.124893,
                    "duration": 0.1248929500579834,
                    "processing": 0,
                    "date_start": "2025-11-24T17:05:27+03:00",
                    "date_finish": "2025-11-24T17:05:27+03:00",
                    "operating_reset_at": 1764015327,
                    "operating": 0
                }
        }

Возвращаемые данные

Название
тип

Описание

result
array

Массив ссылок для скачивания файлов.

Пустой массив означает, что в указанном свойстве нет файлов

time
time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
            "error":"ERROR_REQUIRED_PARAMETERS_MISSING",
            "error_description":"Required parameter is missing"
        }

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код

Описание

Значение

ERROR_REQUIRED_PARAMETERS_MISSING

Required parameter X is missing

Обязательный параметр не передан

ERROR_IBLOCK_NOT_FOUND

Iblock not found

Инфоблок не найден

ERROR_ELEMENT_NOT_FOUND

Element not found

Элемент с таким ID/CODE не найден

ACCESS_DENIED

Access denied

Недостаточно прав для чтения элемента

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Удалить элемент
Следующая
Обзор методов