#Базы знаний

⚠️ Методы в процессе раскатки — выходят в обновлении note 26.100.0. Доступны не на всех порталах Битрикс24. Если на вашем портале метод ещё не доступен, API вернёт 422 METHOD_NOT_YET_AVAILABLE — это не ошибка интеграции, а признак того, что обновление пока не приехало на портал.

Управление базами знаний (в путях — collection). Все методы требуют скоуп note. OAuth-приложения добавляют заголовок Authorization: Bearer USER_SESSION_TOKEN к каждому вызову.

#Создать базу знаний

POST /v1/note/collections

Создаёт базу знаний и возвращает её идентификатор.

Параметр Где Тип Обяз. Описание
name body string да Название базы знаний
position body integer нет Позиция в списке (сортировка по убыванию), по умолчанию 0 — в начало
Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/note/collections \
  -H "X-Api-Key: YOUR_API_KEY" -H "Content-Type: application/json" \
  -d '{"name": "Продуктовая документация", "position": 100}'
javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/note/collections', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/json' },
  body: JSON.stringify({ name: 'Продуктовая документация', position: 100 }),
})
const { success, data } = await res.json()
console.log(data.id) // идентификатор созданной базы знаний

#Поля ответа

data = { id } — идентификатор созданной базы знаний.

JSON 
{ "success": true, "data": { "id": 42 } }

#Ошибки

HTTP Код Когда
400 INVALID_PARAMS Не передан name, либо position не является неотрицательным целым
401 MISSING_API_KEY Не передан X-Api-Key
403 SCOPE_DENIED Ключу не хватает скоупа note
403 WRITE_BLOCKED_READONLY_KEY Ключ в режиме «только чтение»
403 BITRIX_ACCESS_DENIED Нет права создавать базы знаний
422 METHOD_NOT_YET_AVAILABLE Обновление note 26.100.0 ещё не приехало на портал
502 BITRIX_UNAVAILABLE Bitrix24 недоступен

#Переименовать базу знаний

PATCH /v1/note/collections/:id

Параметр Где Тип Обяз. Описание
id path integer да Идентификатор базы знаний
name body string да Новое название
Terminal 
curl -X PATCH https://vibecode.bitrix24.tech/v1/note/collections/42 \
  -H "X-Api-Key: YOUR_API_KEY" -H "Content-Type: application/json" \
  -d '{"name": "Документация продукта"}'
javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/note/collections/42', {
  method: 'PATCH',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/json' },
  body: JSON.stringify({ name: 'Документация продукта' }),
})
const { success, data } = await res.json()
console.log(data.updated) // true

#Поля ответа

data = { updated: true } при успешном переименовании.

JSON 
{ "success": true, "data": { "updated": true } }

#Ошибки

HTTP Код Когда
400 INVALID_PARAMS Не передан id или name
403 BITRIX_ACCESS_DENIED Нет права управления базой знаний
404 ENTITY_NOT_FOUND База знаний не существует, удалена или архивирована
422 METHOD_NOT_YET_AVAILABLE Обновление note 26.100.0 ещё не приехало на портал

#Архивировать базу знаний

POST /v1/note/collections/:id/archive

Архивирует базу знаний. Каскадно архивирует все её документы — они переходят в режим чтения.

Параметр Где Тип Обяз. Описание
id path integer да Идентификатор базы знаний
Terminal 
curl -X POST https://vibecode.bitrix24.tech/v1/note/collections/42/archive \
  -H "X-Api-Key: YOUR_API_KEY"
javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/note/collections/42/archive', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { success, data } = await res.json()
console.log(data.archived) // true

#Поля ответа

data = { archived: true } при успешной архивации.

JSON 
{ "success": true, "data": { "archived": true } }

#Ошибки

HTTP Код Когда
400 INVALID_PARAMS id не положительное целое
403 BITRIX_ACCESS_DENIED Нет права управления базой знаний
404 ENTITY_NOT_FOUND База знаний не существует или уже архивирована
422 METHOD_NOT_YET_AVAILABLE Обновление note 26.100.0 ещё не приехало на портал

#Удалить базу знаний

DELETE /v1/note/collections/:id

Перемещает базу знаний в корзину. Каскадно перемещает её документы. Удалять можно и уже архивированную базу знаний.

Параметр Где Тип Обяз. Описание
id path integer да Идентификатор базы знаний
Terminal 
curl -X DELETE https://vibecode.bitrix24.tech/v1/note/collections/42 \
  -H "X-Api-Key: YOUR_API_KEY"
javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/note/collections/42', {
  method: 'DELETE',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { success, data } = await res.json()
console.log(data.deleted) // true

#Поля ответа

data = { deleted: true } при успешном удалении.

JSON 
{ "success": true, "data": { "deleted": true } }

#Ошибки

HTTP Код Когда
400 INVALID_PARAMS id не положительное целое
403 BITRIX_ACCESS_DENIED Нет права управления базой знаний
404 ENTITY_NOT_FOUND База знаний не существует или уже удалена
422 BITRIX_ERROR По базе знаний идёт фоновый импорт документов — удаление возможно после его завершения (текст в error.message)
422 METHOD_NOT_YET_AVAILABLE Обновление note 26.100.0 ещё не приехало на портал

#Смотрите также