Коды ошибок REST API модуля ithive.knowledgebase

Методы knowledgebase.* возвращают ошибки в конверте модуля внутри стандартной обёртки Bitrix REST.

Полный перечень кодов совпадает с ITHive\KnowledgeBase\Rest\Constants. На страницах методов указаны только актуальные для конкретного endpoint коды — этот справочник содержит все коды модуля.

Формат ответа при ошибке

{
          "result": {
            "result": null,
            "error": {
              "code": "VALIDATION_ERROR",
              "message": "Параметр id обязателен",
              "details": {
                "field": "id"
              }
            }
          },
          "time": {}
        }
        

details опционален (часто field, allowed, id, elementId).

Общие коды

Код HTTP (ориентир) Когда возникает
UNAUTHORIZED 401 Пользователь не авторизован
ACCESS_DENIED 403 Нет прав на операцию (общий запрет)
PERMISSION_DENIED 403 Нет прав на конкретную сущность/действие
VALIDATION_ERROR 400 Некорректные или неполные параметры
NOT_FOUND 404 Сущность не найдена (общий код)
INVALID_LIMIT 400 limit вне диапазона 1..500
INVALID_OFFSET 400 offset < 0
INVALID_FILTER 400 Некорректный filter или неизвестное поле
INVALID_FILTER_OPERATOR 400 Неизвестный оператор фильтра
FETCH_ALL_LIMIT_EXCEEDED 400 При fetchAll=true подходящих записей больше защитного лимита (5000)
INTERNAL_ERROR 500 Внутренняя ошибка сервера
METHOD_NOT_FOUND 404 Метод не зарегистрирован (обёртка Bitrix)

Коды сущностей

Код HTTP (ориентир) Когда возникает
ARTICLE_NOT_FOUND 404 Статья не найдена или недоступна
SECTION_NOT_FOUND 404 Раздел не найден
SECTION_NOT_EMPTY 400 Раздел нельзя удалить: есть вложенные разделы или статьи
VERSION_NOT_FOUND 404 Версия статьи не найдена или операция не выполнена
HASH_NOT_FOUND 404 Публичная ссылка (hash) для элемента не найдена
PUBLIC_LINK_FORBIDDEN 400 Публичные ссылки отключены модулем или для статьи
COMMENT_FEED_UNAVAILABLE 400 Модуль forum недоступен

См. также

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