Создать базу знаний note.collection.add
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
noteКто может выполнять метод: пользователь с доступом к модулю База знаний и правом «Создание баз знаний»
Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.
Метод note.collection.add создает новую базу знаний и возвращает ее объект.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
fields* |
Объект с полями новой базы знаний. Описание структуры объекта |
Параметр fields
|
Название |
Описание |
|
name* |
Название базы знаний. Название базы знаний не должно превышать 255 символов |
|
position |
Позиция базы знаний в общем списке. По умолчанию: |
Примеры кода
Как использовать примеры в документации
Вызов нового api отличается добавлением параметра /api/ в запросе:
https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/note.collection.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"name":"Продуктовая документация","position":100}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/note.collection.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"name":"Продуктовая документация","position":100},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/note.collection.add
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type CollectionAddResult = {
item: {
id: number
name: string
position: number
policyLevel: string
createdBy: number
updatedBy: number
createdAt: string
updatedAt: string
}
}
try {
const response = await $b24.actions.v3.call.make<CollectionAddResult>({
method: 'note.collection.add',
params: {
fields: {
name: 'Продуктовая документация',
position: 100,
},
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Collection created:', result.item.id, result.item.name)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function addCollection() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v3.call.make({
method: 'note.collection.add',
params: {
fields: {
name: 'Продуктовая документация',
position: 100,
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Collection created:', result.item.id, result.item.name)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addCollection)
</script>
SDK пока не поддерживают в вызовах адрес /rest/api/. Используйте прямые HTTP-запросы, например, через curl, fetch.
try {
$response = $b24Service
->core
->call(
'note.collection.add',
[
'fields' => [
'name' => 'Продуктовая документация',
'position' => 100,
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error creating collection: ' . $e->getMessage();
}
SDK пока не поддерживают в вызовах адрес /rest/api/. Используйте прямые HTTP-запросы, например, через curl, fetch.
BX24.callMethod(
'note.collection.add',
{
fields: {
name: 'Продуктовая документация',
position: 100
}
},
function(result){
console.info(result.data());
console.log(result);
}
);
SDK пока не поддерживают в вызовах адрес /rest/api/. Используйте прямые HTTP-запросы, например, через curl, fetch.
require_once('crest.php');
$result = CRest::call(
'note.collection.add',
[
'fields' => [
'name' => 'Продуктовая документация',
'position' => 100
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "note.collection.add", b24.Params{
"fields": b24.Params{
"name": "Продуктовая документация",
"position": 100,
},
})
if err != nil {
return fmt.Errorf("note.collection.add: %w", err)
}
// Метод заворачивает ответ в объект с ключом "item".
raw, ok := b24.Unwrap(res.Result, "item")
if !ok {
return fmt.Errorf("в ответе нет ключа item")
}
var item struct {
ID b24.ID `json:"id"`
Name string `json:"name"`
Position int `json:"position"`
PolicyLevel string `json:"policyLevel"`
CreatedBy int `json:"createdBy"`
CreatedAt string `json:"createdAt"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.Name)
Обработка ответа
HTTP-статус: 200
{
"result": {
"item": {
"id": 42,
"name": "Продуктовая документация",
"position": 100,
"policyLevel": "view",
"createdBy": 1,
"createdAt": "2026-04-20T12:00:00Z",
"updatedBy": 1,
"updatedAt": "2026-04-20T12:00:00Z"
}
},
"time": {
"start": 1780388120,
"finish": 1780388120.245321,
"duration": 0.24532103538513184,
"processing": 0.1812450885772705,
"date_start": "2026-06-16T11:15:20+03:00",
"date_finish": "2026-06-16T11:15:20+03:00",
"operating_reset_at": 1780388720,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Объект с результатом создания базы знаний |
|
item |
Объект созданной базы знаний |
|
id |
Идентификатор созданной базы знаний |
|
name |
Название базы знаний |
|
position |
Позиция базы знаний в общем списке |
|
policyLevel |
Базовая политика доступа базы знаний |
|
createdBy |
Идентификатор автора базы знаний |
|
createdAt |
Дата и время создания базы знаний в UTC |
|
updatedBy |
Идентификатор последнего редактора базы знаний |
|
updatedAt |
Дата и время последнего изменения базы знаний в UTC |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION",
"message": "Ошибка при валидации объекта",
"validation": [
{
"message": "Не заполнено обязательное поле \"name\"",
"field": "name"
}
]
}
}
|
Название |
Описание |
|
error.code |
Строковый код ошибки. Используйте для идентификации типа исключения |
|
error.message |
Текстовое описание ошибки |
|
error.validation |
Массив c деталями ошибки. Присутствует только в ошибках валидации данных |
|
error.validation[].field |
Название поля, в котором возникла ошибка валидации |
|
error.validation[].message |
Описание ошибки, связанной с указанным полем |
Возможные коды ошибок
Ошибки валидации запроса
Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Обязательное поле |
Добавьте объект |
Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Не заполнено обязательное поле |
Добавьте |
|
|
В поле |
Убедитесь, что передаваемое значение нужного типа |
|
|
Название базы знаний не может быть пустым |
Передайте непустую строку в поле |
|
|
Название базы знаний не должно превышать 255 символов |
Сократите значение |
Ошибки доступа
Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Доступ запрещен |
У пользователя нет доступа к модулю База знаний или права создавать базы знаний |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |