knowledgebase.comment.getFeed

Scope: knowledgebase

Кто может вызывать: авторизованный пользователь; только комментарии к статьям, доступным на чтение (element_read). Подробнее: Права доступа

Лента последних комментариев по базе знаний

HTTP: GET

Побочные эффекты: none

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

Параметр Тип Обяз. Описание
limit int нет Размер страницы, по умолчанию 50, максимум 500
offset int нет Смещение, по умолчанию 0
fetchAll bool нет Вернуть все записи одним ответом

Пагинация

limit (default 50, max 500), offset, fetchAll (защитный лимит 5000, иначе FETCH_ALL_LIMIT_EXCEEDED).

Сортировка: по дате комментария (POST_DATE DESC, ID DESC).

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

Ответ в конверте модуля: result.result — массив комментариев; result.next; result.error; верхнеуровневый Bitrix total.

Поля комментария: id, articleId, authorId, authorName, text, date.

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

Справочник кодов: error-codes.md.

Код Описание
UNAUTHORIZED Пользователь не авторизован
COMMENT_FEED_UNAVAILABLE Модуль forum недоступен
INVALID_LIMIT limit вне диапазона 1..500
INVALID_OFFSET offset < 0
FETCH_ALL_LIMIT_EXCEEDED При fetchAll=true записей больше защитного лимита (5000)
INTERNAL_ERROR Внутренняя ошибка сервера

Пример запроса (GET)

curl -G "https://{портал}/rest/{user_id}/{webhook_code}/knowledgebase.comment.getFeed.json" \
          -H "Accept: application/json" \
          --data-urlencode "limit=10" \
          --data-urlencode "offset=0"
        

Пример ответа

{
          "result": {
            "result": [],
            "error": null
          },
          "total": 0
        }
        

См. также

Предыдущая
Следующая