knowledgebase.article.incrementView

Scope: knowledgebase

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

Увеличить счётчик просмотров статьи

HTTP: POST

Побочные эффекты: инкрементирует счётчик просмотров через ArticleView::inc()

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

Параметр Тип Обяз. Описание
id int да ID статьи (алиасы: articleId, elementId)
type string да Канал просмотра: intranet, mobile или ext

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

Ответ в конверте модуля: result.result — { id, type, counted }; counted — true, если просмотр учтён; result.error.

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
VALIDATION_ERROR Некорректный type или неполные параметры
ARTICLE_NOT_FOUND Статья не найдена
PERMISSION_DENIED Нет прав на чтение статьи
INTERNAL_ERROR Внутренняя ошибка сервера

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

curl -X POST "https://{портал}/rest/{user_id}/{webhook_code}/knowledgebase.article.incrementView.json" \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          --data '{
          "id": 501,
          "type": "intranet"
        }'

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

{
          "result": {
            "result": {
              "id": 1078,
              "type": "intranet",
              "counted": true
            },
            "error": null
          }
        }

Пример ошибки

{
          "result": {
            "result": null,
            "error": {
              "code": "VALIDATION_ERROR",
              "message": "Некорректный тип просмотра.",
              "details": {
                "type": "bad",
                "allowed": [
                  "intranet",
                  "mobile",
                  "ext"
                ]
              }
            }
          }
        }

См. также

Предыдущая
knowledgebase.article.getVersions
Следующая
knowledgebase.article.list