метод REST scope: note

note.collection.add

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

Кто может выполнять: пользователь с доступом к модулю База знаний и правом «Создание баз знаний»

Описание

Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.

Метод note.collection.add создает новую базу знаний и возвращает ее объект.

Параметры

fields object обязательный

Объект с полями новой базы знаний. Описание структуры объекта

Параметр fields

name string обязательный

Название базы знаний.

Название базы знаний не должно превышать 255 символов

position integer необязательный

Позиция базы знаний в общем списке.

По умолчанию: 0

Примеры запроса

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

Ответ

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 object

Объект с результатом создания базы знаний

item object

Объект созданной базы знаний

id integer

Идентификатор созданной базы знаний

name string

Название базы знаний

position integer

Позиция базы знаний в общем списке

policyLevel string

Базовая политика доступа базы знаний

createdBy integer

Идентификатор автора базы знаний

createdAt datetime

Дата и время создания базы знаний в UTC

updatedBy integer

Идентификатор последнего редактора базы знаний

updatedAt datetime

Дата и время последнего изменения базы знаний в UTC

time time

Информация о времени выполнения запроса

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

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION",
        "message": "Ошибка при валидации объекта",
        "validation": [
            {
                "message": "Не заполнено обязательное поле \"name\"",
                "field": "name"
            }
        ]
    }
}
Код Описание Значение
Поле Описание ошибки Как исправить
fields Обязательное поле fields не указано Добавьте объект fields в тело запроса

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.