Список версий файла disk.file.getVersions

Scope: disk

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

Метод disk.file.getVersions возвращает список версий файла.

Версии возвращаются в порядке убывания даты создания.

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

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

Название
тип

Описание

id*
integer

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

Идентификатор можно получить с помощью метода disk.storage.getchildren, если файл находится в корне хранилища, и с помощью метода disk.folder.getchildren, если файл находится в папке

filter
array

Массив формата:

{
            field_1: value_1,
            field_2: value_2,
            ...,
            field_n: value_n,
        }

где:

  • field_n — название поля, по которому будет произведена фильтрация
  • value_n — значение фильтра

К ключам field_n можно добавить префикс, уточняющий работу фильтра.
Возможные значения префикса:

  • >= — больше либо равно
  • > — больше
  • <= — меньше либо равно
  • < — меньше
  • @ — IN, в качестве значения передается массив
  • !@ — NOT IN, в качестве значения передается массив
  • % — LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки
  • =% — LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
    • "мол%" — ищет значения, начинающиеся с «мол»
    • "%мол" — ищет значения, заканчивающиеся на «мол»
    • "%мол%" — ищет значения, где «мол» может быть в любой позиции
  • %= — LIKE (аналогично =%)
  • = — равно, точное совпадение (используется по умолчанию)
  • != — не равно
  • ! — не равно

Список доступных полей для фильтрации:

  • ID — идентификатор версии
  • SIZE — размер версии в байтах
  • NAME — название файла на момент создания версии
  • CREATE_TIME — время создания версии
  • CREATED_BY — идентификатор пользователя, который создал версию

start
integer

Параметр используется для управления постраничной навигацией.

Размер страницы результатов всегда статичный — 50 записей.

Чтобы выбрать вторую страницу результатов, необходимо передавать значение 50. Чтобы выбрать третью страницу результатов — значение 100 и так далее.

Формула расчета значения параметра start:

start = (N - 1) * 50, где N — номер нужной страницы

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":9043,"filter":{"NAME":"%тест%"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/disk.file.getVersions
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":9043,"filter":{"NAME":"%тест%"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/disk.file.getVersions
        
try
        {
            const response = await $b24.callMethod(
                'disk.file.getVersions',
                {
                    id: 9043,
                    filter: {
                        NAME: '%тест%',
                    }
                }
            );
            
            const result = response.getData().result;
            console.log('Fetched file versions:', result);
            
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'disk.file.getVersions',
                    [
                        'id' => 9043,
                        'filter' => [
                            'NAME' => '%тест%'
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching file versions: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "disk.file.getVersions",
            {
                id: 9043,
                filter: {
                    NAME: '%тест%'
                },
            },
            function (result)
            {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'disk.file.getVersions',
            [
                'id' => 9043,
                'filter' => [
                    'NAME' => '%тест%'
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": [
                {
                "ID": "7201",
                "OBJECT_ID": "9043",
                "SIZE": "21796",
                "NAME": "Тест №2.docx",
                "GLOBAL_CONTENT_VERSION": "5",
                "CREATE_TIME": "2026-02-17T12:21:22+03:00",
                "CREATED_BY": "1271",
                "DOWNLOAD_URL": "https://test.bitrix24.ru/rest/download.json?auth=343794690000071b006e2cf2000004f500000746484b1f82771b3434ff80eb15edc8f8&token=disk%7CaWQ9NzIwMSZzZXJ2aWNlPXZlcnNpb24mXz0zdHFiVHY5bkNPWm5hVk1rRm92TXlzZUdUSDNTanlVZQ%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU56SXdNU1p6WlhKMmFXTmxQWFpsY25OcGIyNG1YejB6ZEhGaVZIWTVia05QV201aFZrMXJSbTkyVFhselpVZFVTRE5UYW5sVlpRPT18MzQzNzk0NjkwMDAwMDcxYjAwNmUyY2YyMDAwMDA0ZjUwMDAwMDc0NjQ4NGIxZjgyNzcxYjM0MzRmZjgwZWIxNWVkYzhmOCI%3D.dy270nYUZXvxmyBAR1vYnUtn%2Bkn%2FSClb2cIWT8FkOn0%3D"
                },
                {
                "ID": "7199",
                "OBJECT_ID": "9043",
                "SIZE": "21756",
                "NAME": "тест.docx",
                "GLOBAL_CONTENT_VERSION": "3",
                "CREATE_TIME": "2026-02-17T12:15:06+03:00",
                "CREATED_BY": "1269",
                "DOWNLOAD_URL": "https://test.bitrix24.ru/rest/download.json?auth=343794690000071b006e2cf2000004f500000746484b1f82771b3434ff80eb15edc8f8&token=disk%7CaWQ9NzE5OSZzZXJ2aWNlPXZlcnNpb24mXz1Uall3RkZRa0NPMTBncklPM2tYYmxNajRmSWQ2ekVLNg%3D%3D%7CImRvd25sb2FkfGRpc2t8YVdROU56RTVPU1p6WlhKMmFXTmxQWFpsY25OcGIyNG1YejFVYWxsM1JrWlJhME5QTVRCbmNrbFBNMnRZWW14TmFqUm1TV1EyZWtWTE5nPT18MzQzNzk0NjkwMDAwMDcxYjAwNmUyY2YyMDAwMDA0ZjUwMDAwMDc0NjQ4NGIxZjgyNzcxYjM0MzRmZjgwZWIxNWVkYzhmOCI%3D.mtFVuU%2F1h4eGP1VROTj7n4PDUDOSc4suh90NuNPQyyQ%3D"
                }
            ],
            "total": 2,
            "time": {
                "start": 1771320110,
                "finish": 1771320110.716905,
                "duration": 0.7169051170349121,
                "processing": 0,
                "date_start": "2026-02-17T12:21:50+03:00",
                "date_finish": "2026-02-17T12:21:50+03:00",
                "operating_reset_at": 1771320710,
                "operating": 0
            }
        }

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

Название
тип

Описание

result
array

Список версий файла.

Пустой массив означает, что нет версий, удовлетворяющих фильтру

ID
integer

Идентификатор версии

OBJECT_ID
integer

Идентификатор файла, к которому принадлежит версия

SIZE
integer

Размер версии в байтах

NAME
string

Название файла на момент создания версии

GLOBAL_CONTENT_VERSION
integer

Инкрементальный счетчик версии файла

CREATE_TIME
string

Время создания версии

CREATED_BY
integer

Идентификатор пользователя, который создал версию

DOWNLOAD_URL
string

Ссылка на скачивание версии

total
integer

Общее количество версий файла

time
time

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

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

HTTP-статус: 400

{
            "error":"ERROR_ARGUMENT",
            "error_description":"Invalid value of parameter {Parameter #0}"
        }

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

Значение

ERROR_ARGUMENT

Invalid value of parameter

Не указан обязательный параметр id

ERROR_NOT_FOUND

Could not find entity with id X

Файл с указанным id не найден

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

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

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

Предыдущая
Получить поля файла
Следующая
Получить параметры файла