Модели системы: описание полей

Для правильной работы с API и шаблонами уведомлений важно знать точные названия полей моделей системы. Ниже приведено подробное описание каждой модели, доступной через API.

Сотрудник (Employee)

Модель: personal.models.Employee

Доступные поля через API:

Пример использования в шаблоне уведомления:

{
  "subject": "Задача назначена: {title}",
  "body": "Здравствуйте, {executor_str}!\n\nВам назначена задача: {title}\n\nИсполнитель: {executor_str}\nРуководитель: {manager_name}"
}

Примечание: В шаблонах уведомлений доступны как прямые поля объекта (например, {executor.display_name}), так и вычисляемые значения через extra_context (например, {executor_str}).

Пользователь (User)

Модель: users.models.CustomUser

Доступные поля через API:

Пример использования в шаблоне уведомления:

{
  "subject": "Добро пожаловать, {user_name}!",
  "body": "Здравствуйте, {user_name}!\n\nВаш email: {user.email}\nДата регистрации: {user.date_joined}"
}

Договор (Contract)

Модель: finance.contracts.Contract

Доступные поля через API:

Пример использования в шаблоне уведомления:

{
  "subject": "Договор {number} истекает",
  "body": "Договор {number} от {date} с клиентом {client_name} истекает {date_expiry}.\n\nСумма: {currency_price} {currency}"
}

Заявка (Request)

Модель: servicedesk.requests.Request

Доступные поля через API:

Пример использования в шаблоне уведомления:

{
  "subject": "Новая заявка: {title}",
  "body": "Создана новая заявка:\n\nНазвание: {title}\nТип: {type_name}\nПриоритет: {priority_name}\nСтатус: {status_name}\nИсполнитель: {executor_name}\nСрок: {duedate}"
}

Проект (Project)

Модель: projects.models.Project

Доступные поля через API:

Пример использования в шаблоне уведомления:

{
  "subject": "Проект {name} - обновление статуса",
  "body": "Проект {name} (код: {code}) изменил статус на {status_display}.\n\nМенеджер: {manager_name}\nБюджет: {budget}"
}

Задача (Task)

Модель: tasks.models.Task

Доступные поля через API:

Пример использования в шаблоне уведомления:

{
  "subject": "Просроченная задача: {title}",
  "body": "Здравствуйте, {executor_str}!\n\nУ вас есть просроченная задача:\n\nНазвание: {title}\nОписание: {description}\nСрок выполнения: {duedate}\nПроект: {project_str}\n\nПожалуйста, выполните задачу или обновите срок выполнения.\n\nСсылка: {url}"
}

Важно: В шаблонах уведомлений для задач доступны следующие вычисляемые поля через extra_context:

• {executor_str} - строковое представление исполнителя (обычно executor.display_name)
• {project_str} - строковое представление проекта (обычно project.name)
• {url} - URL задачи (через task.get_absolute_url())

Уведомление (Notification)

Модель: system.notifications.Notification

Доступные поля через API:

Пример использования:

Уведомления обычно не используются напрямую в шаблонах модулей, но доступны через API для отображения в интерфейсе модуля.

Работа с полями в шаблонах уведомлений

При создании шаблонов уведомлений в module.json вы можете использовать следующие способы доступа к полям:

1. Прямой доступ к полям объекта:

json { "subject": "Задача: {title}", "body": "Исполнитель: {executor.display_name}\nПроект: {project.name}" }

1. Использование вычисляемых значений через extra_context: В коде модуля при отправке уведомления:

python send_notify( obj=task, recipients=[user], template_name='module_code_TemplateName', extra_context={ 'executor_str': str(task.executor), 'project_str': str(task.project) if task.project else 'N/A', 'user_name': str(user.get_full_name() or user.username) } )

В шаблоне:

json { "subject": "Задача: {title}", "body": "Исполнитель: {executor_str}\nПроект: {project_str}" }

1. Форматирование дат: Django автоматически форматирует даты в шаблонах. Для кастомного форматирования используйте фильтры Django в extra_context.

Типы данных полей

• String - строка текста
• Integer - целое число
• Decimal - десятичное число (деньги, проценты)
• Boolean - логическое значение (true/false)
• Date - дата в формате YYYY-MM-DD
• DateTime - дата и время в формате ISO 8601
• FK - внешний ключ (Foreign Key), возвращает ID связанного объекта
• UUID - уникальный идентификатор в формате UUID

Важные замечания

1. Read-only поля - поля с пометкой (read-only) вычисляются автоматически и не могут быть изменены через API.
2. Связанные объекты - при работе с API связанные объекты (например, manager, project) возвращаются как ID. Для получения полной информации используйте отдельный запрос к API или используйте вычисляемые поля (например, manager_name, project_name).
3. Null значения - многие поля могут быть null. Всегда проверяйте наличие значения перед использованием в шаблонах.
4. Форматирование - для форматирования дат, чисел и других значений в шаблонах уведомлений используйте extra_context в коде модуля.