Изменить позицию базы знаний note.collection.move
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
noteКто может выполнять метод: пользователь с доступом к модулю База знаний и правом «Создание баз знаний»
Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.
Метод note.collection.move перемещает базу знаний на другое место в списке баз знаний.
Порядок баз знаний общий для всего Битрикс24: изменение увидят все сотрудники в боковом меню.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
id* |
Идентификатор базы знаний. Идентификатор можно получить методом note.collection.list. База знаний в архиве или корзине не перемещается |
|
position |
Вес сортировки базы знаний. Базы знаний с большим весом располагаются выше. Чтобы поставить базу знаний между двумя другими, передайте число между их значениями Сохраненный вес пересчитывается по соседним базам знаний и может отличаться от переданного. Актуальное значение вернется в ответе. По умолчанию: база знаний встает последней в списке |
Примеры кода
Как использовать примеры в документации
Вызов нового API отличается добавлением параметра /api/ в запросе:
https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/note.collection.move
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":47,"position":500}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/note.collection.move
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":47,"position":500,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/note.collection.move
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type CollectionMoveResult = {
item: {
id: number
name: string
position: number
policyLevel: string
accessLevel: string
state: 'live' | 'archived' | 'trashed'
isArchived: boolean
createdBy: number
createdAt: ISODate
updatedBy: number
updatedAt: ISODate
markdownDescription: string | null
}
}
try {
const response = await $b24.actions.v3.call.make<CollectionMoveResult>({
method: 'note.collection.move',
params: {
id: 47,
position: 500,
},
requestId: Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Collection position:', result.item.position)
}
} catch (error) {
console.error(error)
}
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function moveCollection() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v3.call.make({
method: 'note.collection.move',
params: {
id: 47,
position: 500,
},
requestId: B24Js.Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Collection position:', result.item.position)
} catch (error) {
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', moveCollection)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.note.collection.move(
bitrix_id=47,
position=500,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.
try {
$response = $b24Service
->core
->call(
'note.collection.move',
[
'id' => 47,
'position' => 500,
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error: ' . $e->getMessage();
}
SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.
BX24.callMethod(
'note.collection.move',
{
id: 47,
position: 500,
},
result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.
require_once('crest.php');
$result = CRest::call(
'note.collection.move',
[
'id' => 47,
'position' => 500,
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "note.collection.move", b24.Params{
"id": 47,
"position": 500,
})
if err != nil {
return fmt.Errorf("note.collection.move: %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"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.Position)
Обработка ответа
HTTP-статус: 200
{
"result": {
"item": {
"id": 47,
"name": "Регламенты",
"position": 550,
"policyLevel": "private",
"accessLevel": "full",
"state": "live",
"isArchived": false,
"createdBy": 1,
"createdAt": "2026-10-21T15:29:56+03:00",
"updatedBy": 1,
"updatedAt": "2026-10-21T15:46:14+03:00",
"markdownDescription": null
}
},
"time": {
"start": 1792586774,
"finish": 1792586774.535677,
"duration": 0.5356769561767578,
"processing": 0,
"date_start": "2026-10-21T15:46:14+03:00",
"date_finish": "2026-10-21T15:46:14+03:00",
"operating_reset_at": 1792587360,
"operating": 0
}
}
В примере передан position = 500, а сохранен вес 550: значение пересчитано по соседним базам знаний с весами 1000 и 100.
Возвращаемые данные
|
Название |
Описание |
|
result |
Объект с данными базы знаний |
|
result.item |
База знаний в том виде, в котором она сохранена после перемещения |
|
result.item.id |
Идентификатор базы знаний |
|
result.item.name |
Название базы знаний |
|
result.item.position |
Сохраненный вес сортировки базы знаний |
|
result.item.policyLevel |
Код политики доступа базы знаний, например |
|
result.item.accessLevel |
Код уровня доступа текущего пользователя к базе знаний, например |
|
result.item.state |
Состояние базы знаний: |
|
result.item.isArchived |
|
|
result.item.createdBy |
Идентификатор автора базы знаний |
|
result.item.createdAt |
Дата и время создания в формате ISO 8601 с часовым поясом |
|
result.item.updatedBy |
Идентификатор последнего редактора базы знаний |
|
result.item.updatedAt |
Дата и время последнего изменения в формате ISO 8601 с часовым поясом |
|
result.item.markdownDescription |
Описание базы знаний в Markdown |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 409
{
"error": {
"code": "NOTE_COLLECTION_IN_RECYCLE_BIN",
"message": "База знаний удалена в корзину — восстановите её, чтобы изменить"
}
}
|
Название |
Описание |
|
error.code |
Строковый код ошибки. Используйте для идентификации типа исключения |
|
error.message |
Текстовое описание ошибки |
|
error.validation |
Массив c деталями ошибки. Присутствует только в ошибках валидации данных |
|
error.validation[].field |
Название поля, в котором возникла ошибка валидации |
|
error.validation[].message |
Описание ошибки, связанной с указанным полем |
Возможные коды ошибок
Ошибки валидации запроса
Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Обязательное поле |
Добавьте |
|
|
В поле |
Передайте идентификатор числом |
Ошибка базы знаний в корзине
Код ошибки: NOTE_COLLECTION_IN_RECYCLE_BIN
HTTP-статус: 409
|
Поле |
Описание ошибки |
Как исправить |
|
|
База знаний удалена в корзину — восстановите её, чтобы изменить |
Восстановите базу знаний методом note.collection.restore |
Ошибки доступа
Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Доступ запрещен |
У пользователя нет доступа к модулю База знаний или права «Создание баз знаний» |
|
|
Доступ запрещен |
База знаний находится в архиве. Верните ее методом note.collection.unarchive |
Ошибка отсутствия объекта
Код ошибки: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Запись с ID = |
База знаний не существует или недоступна пользователю |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |