метод REST scope: entity

entity.item.property.add

Добавить свойство элементов хранилища

Кто может выполнять: пользователь с уровнем права 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 необязательный

Индекс сортировки свойства

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

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

Ответ

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_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

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

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