note.collection.archive
Архивировать базу знаний
Описание
Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.
Метод note.collection.archive архивирует базу знаний и каскадно архивирует все ее документы.
Параметры
id
integer
обязательный
Идентификатор базы знаний.
Идентификатор можно получить методом note.collection.list
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":42}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/note.collection.archive
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":42,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/note.collection.archive
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type CollectionArchiveResult = {
result: boolean
}
try {
const response = await $b24.actions.v3.call.make<CollectionArchiveResult>({
method: 'note.collection.archive',
params: {
id: 42,
},
requestId: Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Collection archived:', result.result)
}
} catch (error) {
console.error(error)
}
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function archiveCollection() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v3.call.make({
method: 'note.collection.archive',
params: {
id: 42,
},
requestId: B24Js.Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Collection archived:', result.result)
} catch (error) {
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', archiveCollection)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.note.collection.archive(
bitrix_id=42,
).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}")
try {
$response = $b24Service
->core
->call(
'note.collection.archive',
[
'id' => 42,
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error archiving collection: ' . $e->getMessage();
}
BX24.callMethod(
'note.collection.archive',
{
id: 42
},
function(result){
console.info(result.data());
console.log(result);
}
);
require_once('crest.php');
$result = CRest::call(
'note.collection.archive',
[
'id' => 42
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "note.collection.archive", b24.Params{
"id": 42,
})
if err != nil {
return fmt.Errorf("note.collection.archive: %w", err)
}
var item struct {
Result bool `json:"result"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.Result)
Ответ
HTTP-статус: 200
{
"result": {
"result": true
},
"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
Объект с результатом архивации базы знаний
result
boolean
Значение true, если база знаний успешно архивирована
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
"message": "Ошибка при валидации объекта запроса",
"validation": [
{
"message": "Обязательное поле `id` не указано",
"field": "id"
}
]
}
}
| Код | Описание | Значение |
|---|---|---|
Поле |
Описание ошибки | Как исправить |
id |
Обязательное поле id не указано |
Добавьте id в тело запроса |
id |
В поле id требуется тип данных #TYPE# для такого запроса |
Убедитесь, что передаваемое значение нужного типа |

