Статьи
Методы работы со статьями базы знаний (article.*).
Методы
| Метод | HTTP | Назначение |
|---|---|---|
knowledgebase.article.add |
POST |
Создать статью |
knowledgebase.article.clearTrash |
POST |
Окончательно удалить статьи из корзины |
knowledgebase.article.delete |
POST |
Переместить статью в корзину (soft-delete) |
knowledgebase.article.deletePermanent |
POST |
Окончательно удалить статью из корзины |
knowledgebase.article.deleteVersion |
POST |
Удалить версию статьи |
knowledgebase.article.get |
GET |
Статья по id |
knowledgebase.article.getVersions |
GET |
Список версий статьи |
knowledgebase.article.incrementView |
POST |
Увеличить счётчик просмотров |
knowledgebase.article.list |
GET |
Список статей с фильтром и поиском |
knowledgebase.article.restoreVersion |
POST |
Восстановить версию статьи |
knowledgebase.article.update |
POST |
Обновить статью |
Теги статей
Теги хранятся в общем справочнике модуля, а не в списочном свойстве статьи. Тег идентифицируется кодом (xmlId); для тегов, перенесённых из прежнего списочного свойства, код совпадает с их прежним XML_ID.
Формат в ответах. В knowledgebase.article.get и knowledgebase.article.list поле tags — массив объектов:
| Поле | Тип | Описание |
|---|---|---|
id |
int |
Идентификатор тега в справочнике. Это не ID значения прежнего списочного свойства |
xmlId |
string |
Код тега — стабильный идентификатор |
name |
string |
Название тега |
В knowledgebase.article.getVersions поле tags версии — массив кодов тегов (xmlId).
Параметр tags в knowledgebase.article.add и knowledgebase.article.update. Массив (или строка со списком) элементов. Каждый элемент — код тега (xmlId, предпочтительно), числовой id тега справочника, название тега или объект с одним из полей xmlId / id / name. Значения сопоставляются в таком порядке: код, затем числовой id, затем название (без учёта регистра).
- Неизвестные значения отбрасываются. Новые теги через REST не создаются — их создают в интерфейсе редактора статьи.
- Пустой массив очищает теги статьи.
Совместимость. Клиенты, которые передавали коды (xmlId) или названия, работают без изменений. Если клиент передавал числовые ID значений прежнего списочного свойства, числовое значение теперь трактуется как id тега справочника: такие вызовы нужно перевести на xmlId. Получить список тегов справочника (id, xmlId, name) можно методом knowledgebase.enum.tags (GET, без параметров).