метод REST scope: note

note.document.search.list

Найти документы

Кто может выполнять: пользователь с доступом к модулю База знаний

Описание

Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.

Метод note.document.search.list ищет документы по заголовку и содержимому.

Выдача содержит документы из баз знаний, к которым у пользователя есть доступ, а также документы с прямым доступом к документу. Архивные документы не попадают в результат.

Параметры

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

Поисковый запрос.

Минимальная длина: 3 символа

Максимальная длина: 200 символов

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

Объект постраничной навигации. Описание структуры объекта

Параметр pagination

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

Размер страницы.

Допустимые значения: от 1 до 200

По умолчанию: 50

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"query":"рецепт борща","pagination":{"limit":50}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/note.document.search.list

Ответ

HTTP-статус: 200

{
    "result": {
        "items": [
            {
                "documentId": 42,
                "collectionId": 123,
                "title": "Традиционный рецепт",
                "score": 0.853,
                "snippet": "...классический <b>рецепт</b> украинского <b>борща</b>...",
                "sharedAccess": false
            },
            {
                "documentId": 43,
                "collectionId": null,
                "title": "Рецепт из общего доступа",
                "score": 0.791,
                "snippet": "...быстрый <b>рецепт</b>...",
                "sharedAccess": true
            }
        ],
        "hasMore": true
    },
    "time": {
        "start": 1780640100,
        "finish": 1780640100.286773,
        "duration": 0.2867729663848877,
        "processing": 0.24144291877746582,
        "date_start": "2026-06-19T10:15:00+03:00",
        "date_finish": "2026-06-19T10:15:00+03:00",
        "operating_reset_at": 1780640700,
        "operating": 0
    }
}

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

result object

Объект с результатами поиска

items array

Список найденных документов

items[] object

Объект найденного документа

documentId integer

Идентификатор найденного документа

collectionId integer

Идентификатор базы знаний или null, если документ доступен через прямой доступ к документу

title string

Заголовок документа

score double

Относительная релевантность совпадения

snippet string

HTML-фрагмент с выделением совпадений (теги <b>…</b>)

sharedAccess boolean

Признак прямого доступа к документу без доступа ко всей базе знаний.

Возможные значения:

  • true — документ доступен через прямой доступ
  • false — документ доступен через доступ к базе знаний
hasMore boolean

Значение true, если за пределами страницы есть еще результаты

time time

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

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

HTTP-статус: 400

{
    "error": {
        "code": "NOTE_SEARCH_QUERY_TOO_SHORT",
        "message": "Поисковый запрос слишком короткий"
    }
}
Код Описание Значение
Поле Описание ошибки Как исправить
query Обязательное поле query не указано Добавьте query в тело запроса
query pagination В поле #FIELD# требуется тип данных #TYPE# для такого запроса Убедитесь, что передаваемое значение нужного типа

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

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