knowledgebase.article.add

Scope: knowledgebase

Кто может вызывать: IblockRights::canBindElementToSection() для каждого раздела привязки. Подробнее: Права доступа

Создать статью базы знаний

HTTP: POST

Побочные эффекты: создаёт элемент инфоблока базы знаний

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

Параметр Тип Обяз. Описание
name string да Название статьи
detailText string да Текст статьи (непустое содержимое после удаления HTML)
sectionId int|array да ID раздела или массив разделов (алиасы: sectionIds, IBLOCK_SECTION_ID, IBLOCK_SECTION)
active bool|string нет Активность, по умолчанию true
detailTextType string нет Тип текста: text или html (по умолчанию text; при extendedTextEditor=true — html)
tags array|string нет Теги: enum id, xmlId или имя (алиас: TAG_LIST)
disk array нет ID файлов диска (алиас: DISK)
extendedTextEditor bool|string нет Расширенный HTML-редактор (алиас: EXTENDED_TEXT_EDITOR)
disallowPublicLink bool|string нет Запретить публичную ссылку (алиас: DISALLOW_PUBLIC_LINK)
disableComments bool|string нет Отключить комментарии (алиас: DISABLE_COMMENTS)

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

Ответ в конверте модуля: result.result — созданная статья (формат как у article.get); result.error.

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
VALIDATION_ERROR Некорректные или неполные параметры (name, detailText, sectionId)
PERMISSION_DENIED Нет прав на привязку к разделу
INTERNAL_ERROR Внутренняя ошибка сервера

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

curl -X POST "https://{портал}/rest/{user_id}/{webhook_code}/knowledgebase.article.add.json" \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          --data '{
          "name": "Инструкция по оформлению отпуска",
          "detailText": "Пошаговая инструкция для сотрудников.",
          "sectionId": 12,
          "tags": ["hr"],
          "active": true
        }'

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

{
          "result": {
            "result": {
              "id": 1078,
              "name": "REST Docs test article",
              "detailText": "Initial body for REST documentation",
              "createdAt": "03.09.2026 15:25",
              "updatedAt": "03.09.2026 15:25",
              "tags": [],
              "createdBy": {
                "id": 1,
                "fullName": "Портала Админ",
                "icon": "",
                "position": ""
              },
              "updatedBy": {
                "id": 1,
                "fullName": "Портала Админ",
                "icon": "",
                "position": ""
              },
              "disk": [],
              "sections": [
                {
                  "id": 96,
                  "name": "Регламенты и инструкции"
                }
              ],
              "sectionId": 96,
              "extendedTextEditor": false,
              "isBlockNote": false,
              "publicUrl": "",
              "internalUrl": "http://76569.dev.wehive.digital/knowledgebase/show/1078/",
              "isPublicUrlEnabled": true,
              "isCommentsEnabled": true,
              "disallowPublicLink": false,
              "disableComments": false,
              "commentsCount": 0,
              "newCommentsCount": 0
            },
            "error": null
          }
        }

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

{
          "result": {
            "result": null,
            "error": {
              "code": "VALIDATION_ERROR",
              "message": "Укажите раздел.",
              "details": {
                "field": "sectionId"
              }
            }
          }
        }

См. также

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