knowledgebase.comment.list

Scope: knowledgebase

Кто может вызывать: IblockRights::elementUserHasRightTo(..., 'element_read') на статью (articleId обязателен). Подробнее: Права доступа

Список комментариев к статье (форум)

HTTP: GET

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

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

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

Пагинация

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

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

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

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

Если тема форума для статьи ещё не создана — пустой массив и total: 0.

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
VALIDATION_ERROR Некорректные или неполные параметры (articleId)
PERMISSION_DENIED Нет прав на чтение статьи
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.list.json" \
          -H "Accept: application/json" \
          --data-urlencode "articleId=501" \
          --data-urlencode "limit=20" \
          --data-urlencode "offset=0"

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

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

См. также

Предыдущая
knowledgebase.comment.getFeed
Следующая
Обзор раздела