entity.add
Создать хранилище данных
Описание
Метод entity.add создает новое хранилище данных приложения.
Метод работает только в контексте приложения.
Параметры
ENTITY
string
необязательный
Символьный идентификатор хранилища. Это значение используйте в других методах раздела после создания хранилища.
Разрешены символы a-z, A-Z, 0-9, _.
Ограничение длины рассчитывается динамически по формуле:
50 - strlen("APP_<clientId>_"). В большинстве случаев для Битрикс24 это 13 символов
NAME
string
необязательный
Название хранилища
ACCESS
object
необязательный
Права доступа в формате {"код_доступа":"уровень_права"}.
Примеры кодов доступа:
- U<id> — пользователь, например U1
- G<id> — группа пользователей, например G2
- AU — все авторизованные пользователи
Метод принимает стандартные коды доступа Битрикс24. Проверить название кода можно методом access.name.
Поддерживаемые уровни:
- R — чтение
- W — запись
- X — управление
Если передан другой уровень, такая запись права не будет добавлена
Создателю хранилища автоматически добавляется право X (U<id>)
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ENTITY":"dish","NAME":"Dishes","ACCESS":{"U1":"W","AU":"R"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/entity.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
try {
const response = await $b24.actions.v2.call.make<boolean>({
method: 'entity.add',
params: {
ENTITY: 'dish',
NAME: 'Dishes',
ACCESS: {
U1: 'W',
AU: 'R',
},
},
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('Entity created:', result)
}
} 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 addEntity() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'entity.add',
params: {
ENTITY: 'dish',
NAME: 'Dishes',
ACCESS: {
U1: 'W',
AU: 'R',
},
},
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('Entity created:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addEntity)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.entity.add(
entity="dish",
name="Dishes",
access={
"U1": "W",
"AU": "R",
},
).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(
'entity.add',
[
'ENTITY' => 'dish',
'NAME' => 'Dishes',
'ACCESS' => [
'U1' => 'W',
'AU' => 'R',
],
]
);
$result = $response
->getResponseData()
->getResult();
echo '<pre>';
print_r($result);
echo '</pre>';
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding entity: ' . $e->getMessage();
}
BX24.callMethod(
'entity.add',
{
ENTITY: 'dish',
NAME: 'Dishes',
ACCESS: {
U1: 'W',
AU: 'R',
},
},
(result) => {
result.error()
? console.error(result.error())
: console.info(result.data())
;
},
);
require_once('crest.php');
$result = CRest::call(
'entity.add',
[
'ENTITY' => 'dish',
'NAME' => 'Dishes',
'ACCESS' => [
'U1' => 'W',
'AU' => 'R',
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "entity.add", b24.Params{
"ENTITY": "dish",
"NAME": "Dishes",
"ACCESS": b24.Params{
"U1": "W",
"AU": "R",
},
})
if err != nil {
return fmt.Errorf("entity.add: %w", err)
}
var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)
Ответ
HTTP-статус: 200
{
"result": true,
"time": {
"start": 1774255192,
"finish": 1774255192.416864,
"duration": 0.41686391830444336,
"processing": 0,
"date_start": "2026-03-23T11:39:52+03:00",
"date_finish": "2026-03-23T11:39:52+03:00",
"operating_reset_at": 1774255792,
"operating": 0.11449217796325684
}
}
Возвращаемые данные
result
boolean
Результат выполнения метода. Для успешного создания возвращается true
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "ERROR_ARGUMENT",
"error_description": "Argument 'ENTITY' is null or empty",
"argument": "ENTITY"
}
| Код | Описание | Значение |
|---|---|---|
ERROR_ENTITY_ALREADY_EXISTS |
Entity already exists | Хранилище с таким ENTITY уже существует |
ERROR_CORE |
Internal error adding entity. Try adding again. | Внутренняя ошибка при создании хранилища |
ERROR_ARGUMENT |
Argument 'ENTITY' is null or empty | Параметр ENTITY не передан или пустой после очистки |
ERROR_ARGUMENT |
Entity code is too long. Max length is N characters. | Слишком длинное значение ENTITY |
ACCESS_DENIED |
Access denied! Application context required | Нет контекста приложения (clientId) |

