Добавить свойство элементов хранилища entity.item.property.add

Scope: entity

Кто может выполнять метод: пользователь с уровнем права X (управление) в хранилище данных

Метод entity.item.property.add добавляет свойство элементов хранилища данных приложения.

Метод работает только в контексте приложения.

Параметры метода

Обязательные параметры отмечены *

Название `тип`	Описание
ENTITY^* `string`	Идентификатор хранилища данных приложения. Используйте значение, которое указали при создании хранилища. Получить идентификатор можно методом entity.get
PROPERTY^* `string`	Код нового свойства. Разрешены символы `a-z`, `A-Z`, `0-9`, `_`
NAME `string`	Название свойства
TYPE `string`	Тип свойства: `S` — строка `N` — число `F` — файл
SORT `integer`	Индекс сортировки свойства

Примеры кода

Как использовать примеры в документации

Пример добавления свойства, где:

ENTITY — идентификатор хранилища dish
PROPERTY — код свойства new_prop
NAME — название свойства
TYPE — тип S
SORT — индекс сортировки

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"ENTITY":"dish","PROPERTY":"new_prop","NAME":"Новое свойство","TYPE":"S","SORT":100,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/entity.item.property.add

try
        {
        	const response = await $b24.callMethod(
        		'entity.item.property.add',
        		{
        			ENTITY: 'dish',
        			PROPERTY: 'new_prop',
        			NAME: 'Новое свойство',
        			TYPE: 'S',
        			SORT: 100,
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'entity.item.property.add',
                    [
                        'ENTITY' => 'dish',
                        'PROPERTY' => 'new_prop',
                        'NAME' => 'Новое свойство',
                        'TYPE' => 'S',
                        'SORT' => 100,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo '<pre>';
            print_r($result);
            echo '</pre>';
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding entity item property: ' . $e->getMessage();
        }

BX24.callMethod(
            'entity.item.property.add',
            {
                ENTITY: 'dish',
                PROPERTY: 'new_prop',
                NAME: 'Новое свойство',
                TYPE: 'S',
                SORT: 100,
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );

require_once('crest.php');
        
        $result = CRest::call(
            'entity.item.property.add',
            [
                'ENTITY' => 'dish',
                'PROPERTY' => 'new_prop',
                'NAME' => 'Новое свойство',
                'TYPE' => 'S',
                'SORT' => 100,
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Обработка ответа

HTTP-статус: 200

{
            "result": true,
            "time": {
                "start": 1774440592,
                "finish": 1774440592.563202,
                "duration": 0.563201904296875,
                "processing": 0,
                "date_start": "2026-03-25T15:09:52+03:00",
                "date_finish": "2026-03-25T15:09:52+03:00",
                "operating_reset_at": 1774441192,
                "operating": 0
            }
        }

Возвращаемые данные

Название `тип`	Описание
result `boolean`	Результат добавления свойства (`true` — успешно)
time `time`	Информация о времени выполнения запроса

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

HTTP-статус: 400

{
            "error": "ERROR_PROPERTY_ALREADY_EXISTS",
            "error_description": "Property already exists"
        }

{
            "error": "ERROR_ARGUMENT",
            "error_description": "Argument 'ENTITY' is null or empty",
            "argument": "ENTITY"
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код	Описание	Значение
`ERROR_ARGUMENT`	Argument 'ENTITY' is null or empty	Параметр `ENTITY` не передан или пустой после очистки
`ERROR_ARGUMENT`	Entity code is too long. Max length is N characters.	Слишком длинное значение `ENTITY`
`ERROR_ARGUMENT`	Argument 'PROPERTY' is null or empty	Параметр `PROPERTY` не передан
`ERROR_ARGUMENT`	Wrong entity item property type	Передан недопустимый тип `TYPE`
`ERROR_ENTITY_NOT_FOUND`	Entity not found	Хранилище с переданным `ENTITY` не найдено
`ERROR_PROPERTY_ALREADY_EXISTS`	Property already exists	Свойство с переданным `PROPERTY` уже существует
`ACCESS_DENIED`	Access denied!	Недостаточно прав для добавления свойства
`ACCESS_DENIED`	Access denied! Application context required	Нет контекста приложения (`clientId`)
`ERROR_UNSUPPORTED_PROPERTY_TYPE`	Недопустимый тип свойства	Попытка создать свойство с типом `L`
`ERROR_CORE`	Internal error adding entity property. Try adding again.	Внутренняя ошибка при добавлении свойства
`ERROR_CORE`	Код свойства не может начинаться с цифры	Передан некорректный код свойства в `PROPERTY`

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Обзор методов

Изменить дополнительное свойство

Добавить свойство элементов хранилища entity.item.property.add

Параметры методаПараметры метода

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

Возвращаемые данныеВозвращаемые данные

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

Возможные коды ошибокВозможные коды ошибок

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение