Модель представляет дополнительное (кастомное) поле, привязанное к сущности в системе — содержит метаданные поля: ключ, название, тип данных, к какой сущности привязано, обязательность и т.п.
| Название | Тип данных | Описание |
|---|---|---|
| id | Int64 | Идентификатор поля |
| key | String | Уникальный ключ поля (machine-name) |
| name | String | Читабельное наименование поля |
| entity_type | Enum | Сущность, к которому привязано дополнительное поле |
| data_type | Enum | Тип данных значения поля. Допустимые значения: string, int, decimal, bool |
| is_custom | Boolean | Признак: поле пользовательское (true) или системное (false) |
| required | Boolean | Обязательное поле (true) или нет (false) |
Допустимые значения entity_type
| Название | Описание |
|---|---|
| RetailCustomer | Розничный покупатель |
Ниже — описание трёх моделей, которые используются в объектах сущности. Каждая модель обычно передаётся/принимается как массив элементов (FieldValue[], FieldValueAdd[], FieldValueEdit[]).
| Название | Тип данных | Описание |
|---|---|---|
| key | string | Ключ поля |
| name | string | Читабельное наименование поля |
| data_type | string | Тип данных поля. Допустимые значения: string, int, decimal, bool |
| value | string | Значение поля в текстовом представлении. При обработке на сервере/клиенте значение конвертируется в тип, указанный в data_type |
В объекте сущности хранится массив FieldValue[]. Сервер ожидает, что value приведён к строковому представлению; типовая валидация/конвертация выполняется на стороне API по data_type.
| Название | Тип данных | Описание |
|---|---|---|
| key | string | Ключ поля |
| value | string | Значение поля в строковом представлении. Будет конвертировано к data_type при сохранении |
При создании сущности передаётся массив FieldValueAdd[]. Обязательность передачи конкретных полей определяется моделью и бизнес-правилами (например, если поле required = true — требуется передать значение).
| Название | Тип данных | Описание |
|---|---|---|
| key | string | Ключ поля |
| value | string | Новое значение поля в строковом представлении |
| deleted | bool | Метка удаления значения по этому полю в сущности. true — удалить значение; false — оставить/обновить. По умолчанию false. |
При редактировании сущности используется массив FieldValueEdit[]. Если deleted = true, значение поля будет удалено (сервер игнорирует value в этом случае).