Объекты

Объекты являются основополагающей структурой в проекте, с помощью которой описываются все сущности.

Пример

{
  "title": "Продажи",
  "table": "salesList",
  "is_trash": false,
  "properties": [],
  "action_buttons": []
}

Схемы объектов

Св-во	Тип	Описание
title	string	Название. Используется в качестве комментария для разработчиков
table	string	Таблица, из которой будет брать информацию схема
article_modifier	string	Приписка к get-запросу. Пример использования ниже
search	string	Объект, по которому будет производиться поиск. Если не указывать – то поиск не будет доступен для этого Объекта
is_trash	boolean	Используется ли “корзина”. Поле “is_active” в базе данных
is_hook	boolean	Используется ли “хук”
properties*	array	Св-ва Объекта
action_buttons	array	Кнопки в записях списка:
settings	object	Настройки Объекта. Требуются для некоторых Блоков

Свойства Объекта - properties

Название	Тип	Описание
title *	string	Название
article *	string	Артикул. Соответствует названию поля таблицы в базе данных (если св-во связано с ним)
is_disabled	bool	Активность поля (true) по умолчанию
is_visible	bool	Отображать в админке (true) по умолчанию
is_default_in_list	bool	Показывать поле в списке
is_variable	bool	Используется при печати
annotation	string	Аннотация поля
data_type *	string	Тип поля, который принимает API
field_type *	string	Внешний вид поля в админке
joined_field	string	Связанное поле. По этому полю, будет фильтроваться текущее. Например: поле "Кабинеты" фильтруется по филиалам
settings	object	Дополнительные настройки поля (зависят от field_type)
is_in_search	boolean	Поле выводится в списках при поиске
is_unique	boolean	Проверка на уникальность
is_autofill	boolean	Автозаполнение. Если true – то значения полей, заполненные в админке, будут передаваться в запросы к базе данных
on_change_submit	boolean	Отправлять форму, при изменении поля
required_permissions	array	Артикулы доступов, которые нужны для использования св-ва
required_modules	array	Артикулы модулей, которые нужны для использования св-ва
use_in_commands	array	Команды, в которых используется св-во
require_in_commands	array	Команды, для которых св-во обязательно
custom_list	array	Список значений, которые может принимать св-во
max_value	integer	Максимальное значение
min_value	integer	Минимальное значение
list_donor	object	Источник детальной информации. Используется, когда св-во содержит ID записи, а нужно получить детальную информацию
join	object	Связанные данные. Используется для таблицы “связки”. Например, когда к заказу добавляются товары

Пример

[
  {
    "title": "Дата и время операции",
    "article": "created_at",
    "data_type": "datetime",
    "field_type": "datetime",
    "is_default_in_list": true,
    "is_unique": false,
    "is_autofill": false,
    "use_in_commands": [
      "add",
      "get"
    ]
  },
  {
    "title": "Сотрудник",
    "article": "employee_id",
    "data_type": "integer",
    "field_type": "list",
    "is_default_in_list": true,
    "is_unique": false,
    "is_autofill": true,
    "list_donor": {
      "table": "users",
      "properties_title": "last_name",
      "select": [
        [ "id" ],
        [ "last_name" ],
        [ "first_name" ],
        [ "patronymic" ]
      ]
    },
    "use_in_commands": [
      "get",
      "add",
      "update"
    ],
    "require_in_commands": [],
    "is_visible": false
  },
  {
    "title": "Филиал",
    "article": "store_id",
    "data_type": "integer",
    "field_type": "list",
    "is_default_in_list": false,
    "is_unique": false,
    "is_autofill": true,
    "is_visible": false,
    "list_donor": {
      "table": "stores",
      "properties_title": "title"
    },
    "use_in_commands": [
      "hook",
      "add",
      "get"
    ],
    "require_in_commands": []
  },
  {
    "title": "Способ оплаты",
    "article": "pay_method",
    "data_type": "string",
    "field_type": "list",
    "is_default_in_list": true,
    "is_unique": false,
    "is_autofill": true,
    "use_in_commands": [
      "hook",
      "update",
      "add",
      "get"
    ],
    "custom_list": [
      {
        "title": "Наличные",
        "value": "cash"
      },
      {
        "title": "Безналичные",
        "value": "card"
      },
      {
        "title": "Раздельная",
        "value": "parts"
      },
      {
        "title": "Юридическое лицо",
        "value": "legalEntity"
      },
      {
        "title": "Онлайн оплата",
        "value": "online"
      }
    ],
    "is_hook": true,
    "require_in_commands": [
      "add",
      "return"
    ]
  }
]

25 июня 2025