метод REST scope: disk

disk.file.search

Найти файлы и папки

Кто может выполнять: любой пользователь

Описание

Метод disk.file.search находит файлы и папки на Диске по текстовому запросу.

Поиск работает по индексу: в него попадают имена файлов и папок, а для документов — еще и текст внутри файла. Объекты в корзине метод не находит.

В результат попадают только объекты, которые доступны текущему пользователю на чтение. Объекты из хранилищ без внутренних прав доступа — например, из хранилищ других модулей — метод не возвращает. Папки чатов исключаются из выдачи.

Запрос короче трех символов метод отклоняет, поэтому для подсказки по первым введенным буквам он не подходит. Чтобы пройти по известной структуре, используйте методы disk.storage.getChildren и disk.folder.getChildren, а если идентификатор файла уже известен — disk.file.get.

Параметры

QUERY string обязательный

Текст поискового запроса.

Длина — от 3 до 255 символов. Повторяющиеся пробелы схлопываются в один, пробелы по краям обрезаются, длина проверяется уже после этого

TYPE enum необязательный

Тип объектов в результате:

  • file — только файлы
  • folder — только папки
  • all — файлы и папки

Значение по умолчанию — file

FILTER object необязательный

Область поиска (подробное описание).

Без этого параметра метод ищет по всем доступным пользователю хранилищам

start integer необязательный

Смещение для постраничной навигации.

За один запрос метод возвращает не более 50 объектов. Значение параметра — количество пропущенных объектов, а не номер страницы: при start=10 выдача начнется с одиннадцатого объекта.

Значение по умолчанию — 0. Максимальное значение — 1000, большее метод приводит к 1000.

Имя параметра пишется строчными буквами, в отличие от остальных параметров метода

Параметр FILTER

STORAGE_ID integer необязательный

Необязательный ключ. Идентификатор хранилища, внутри которого нужно искать.

Идентификатор можно получить методом disk.storage.getList

FOLDER_ID integer необязательный

Необязательный ключ. Идентификатор папки, внутри которой нужно искать. Поиск идет и по вложенным папкам, сама папка в результат не попадает.

Идентификатор можно получить методом disk.folder.getChildren

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"QUERY":"тест","TYPE":"all","FILTER":{"STORAGE_ID":1}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/disk.file.search

Ответ

HTTP-статус: 200

{
    "result": [
        {
            "ID": "1739",
            "NAME": "Новая папка для теста процесса",
            "CODE": null,
            "STORAGE_ID": "1",
            "TYPE": "folder",
            "REAL_OBJECT_ID": "1739",
            "PARENT_ID": "649",
            "DELETED_TYPE": "0",
            "CREATE_TIME": "2020-10-26T16:25:33+03:00",
            "UPDATE_TIME": "2024-11-26T09:23:03+03:00",
            "DELETE_TIME": null,
            "CREATED_BY": "0",
            "UPDATED_BY": "1",
            "DELETED_BY": "0",
            "DETAIL_URL": "https://test.bitrix24.ru/company/personal/user/1/disk/path/Созданные файлы/Новая папка для теста процесса"
        },
        {
            "ID": "1277",
            "NAME": "Роман Савин - Тестирование Дот Ком.pdf",
            "CODE": null,
            "STORAGE_ID": "1",
            "TYPE": "file",
            "PARENT_ID": "1275",
            "DELETED_TYPE": "0",
            "GLOBAL_CONTENT_VERSION": "1",
            "FILE_ID": "1983",
            "SIZE": "5517483",
            "CREATE_TIME": "2020-08-07T15:43:48+03:00",
            "UPDATE_TIME": "2020-08-07T15:43:48+03:00",
            "DELETE_TIME": null,
            "CREATED_BY": "1",
            "UPDATED_BY": "1",
            "DELETED_BY": "0",
            "DOWNLOAD_URL": "https://test.bitrix24.ru/rest/download.json?auth=**put_access_token_here**&token=disk%7CaWQ9MTI3NyZfPXVqVGJUMmxoclBOb0JmQjVLWmxyWnRISWFTQ2M5V2hT",
            "DETAIL_URL": "https://test.bitrix24.ru/company/personal/user/1/disk/file/Загруженные файлы/Файлы из Google Drive/Роман Савин - Тестирование Дот Ком.pdf"
        }
    ],
    "time": {
        "start": 1785494344,
        "finish": 1785494344.440217,
        "duration": 0.4402170181274414,
        "processing": 0,
        "date_start": "2026-07-31T13:39:04+03:00",
        "date_finish": "2026-07-31T13:39:04+03:00",
        "operating_reset_at": 1785494944,
        "operating": 0.13181495666503906
    }
}

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

result array

Массив найденных объектов (подробное описание)

next integer

Смещение для следующего запроса. Приходит только тогда, когда есть следующая страница (пример)

time time

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

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

HTTP-статус: 400

{
    "error": "INVALID_QUERY",
    "error_description": "Search query is invalid. (INVALID_QUERY)."
}
Код Описание Значение
ERROR_ARGUMENT Invalid value of parameter { Parameter #0 [ <required> $QUERY ] }. Не передан обязательный параметр QUERY
INVALID_QUERY Search query is invalid. (INVALID_QUERY). Запрос короче 3 или длиннее 255 символов либо передан не строкой
INVALID_TYPE Search result type is invalid. (INVALID_TYPE). Значение TYPE отличается от file, folder и all
INVALID_FILTER Search filter contains an unknown field. (INVALID_FILTER). В FILTER передан ключ, кроме STORAGE_ID и FOLDER_ID
NOT_FOUND Search scope was not found. (NOT_FOUND). Хранилище или папка из FILTER не существует, недоступна пользователю на чтение или папка не принадлежит указанному хранилищу. Та же ошибка приходит, если FILTER передан не объектом
UNSUPPORTED_STORAGE Search is not supported for this storage. (UNSUPPORTED_STORAGE). В указанном хранилище не используются внутренние права доступа Диска

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.