knowledgebase.article.get

Scope: knowledgebase

Кто может вызывать: чтение через Post::getById; при отсутствии доступа — ACCESS_DENIED или ARTICLE_NOT_FOUND. Подробнее: Права доступа

Статья базы знаний по id (полная карточка)

HTTP: GET

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

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

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

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

Ответ в конверте модуля: result.result — объект статьи; result.error. Ключи total/next для не-list методов могут отсутствовать в сериализации, если не переданы.

Основные поля: id, name, detailText, createdAt, updatedAt, tags, createdBy, updatedBy, disk, sections, sectionId, extendedTextEditor, isBlockNote, publicUrl, internalUrl, isPublicUrlEnabled, isCommentsEnabled, disallowPublicLink, disableComments, commentsCount, newCommentsCount.

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

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

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

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

curl -G "https://{портал}/rest/{user_id}/{webhook_code}/knowledgebase.article.get.json" \
          -H "Accept: application/json" \
          --data-urlencode "id=501"

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

{
          "result": {
            "result": {
              "id": 1073,
              "name": "Without text",
              "detailText": "",
              "createdAt": "31.08.2026 15:22",
              "updatedAt": "31.08.2026 15:22",
              "tags": [],
              "createdBy": {
                "id": 1,
                "fullName": "Портала Админ",
                "icon": "",
                "position": ""
              },
              "updatedBy": {
                "id": 1,
                "fullName": "Портала Админ",
                "icon": "",
                "position": ""
              },
              "disk": [],
              "sections": [],
              "sectionId": 0,
              "extendedTextEditor": false,
              "isBlockNote": false,
              "publicUrl": "",
              "internalUrl": "http://76569.dev.wehive.digital/knowledgebase/show/1073/",
              "isPublicUrlEnabled": true,
              "isCommentsEnabled": true,
              "disallowPublicLink": false,
              "disableComments": false,
              "commentsCount": 0,
              "newCommentsCount": 0
            },
            "error": null
          }
        }

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

{
          "result": {
            "result": null,
            "error": {
              "code": "ARTICLE_NOT_FOUND",
              "message": "Статья не найдена.",
              "details": {
                "id": 999999
              }
            }
          }
        }

См. также

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