SQL API
Выберите нужный метод в боковом меню.
Общее ¶
Общая информация
В Окдеск встроены базовые отчеты по работе сервисной службы. Отчеты постоянно развиваются, но иногда потребности клиентов в аналитике превосходят наши “продуктовые” границы — быть системой анализа данных или конструктором отчетов Окдеск не может. Иначе на ключевую функциональность не останется времени.
Системы анализа данных — это специальный класс систем/программ. Они не привязаны к модели данных, которые предлагается анализировать. Такие системы могут собирать данные из разных источников (helpdesk-система, система управления складом, бухгалтерская система) и давать полную картину и аналитику по всей компании. У пользователей есть возможность настраивать произвольные отчеты с любой детализацией и визуализацией. Такие системы называются BI-системами (Business Intelligence).
Для компаний, чей бизнес требует глубокой аналитики, мы разработали интерфейс для интеграции с BI-системами. По сути, мы даем доступ к данным аккаунта в SQL-представлении — к этим данным можно как подключить BI-систему, так и просто делать SQL-запросы напрямую.
Для предоставления доступа к SQL API необходимо:
-
подключить опцию “Расширенный набор отчетов / интеграция с BI” (для тарифов “Эксперт” или “Профи”), либо оформить подписку на тариф, где эта опция включена в стоимость;
-
написать запрос на подключение SQL API к вашему аккаунту на help@okdesk.ru;
-
после получения реквизитов доступа вы можете изменить пароль пользователя, выполнив sql-запрос:
ALTER USER user_name WITH PASSWORD 'new_password'
где user_name — имя пользователя, под которым вы планируете подключаться к SQL API, а new_password — новый пароль, который вы хотите установить пользователю.
Данные в SQL API обновляются один раз в 3 часа. SQL API будет развиваться по требованию клиентов в соответствии с реальными кейсами.
Заявки ¶
Таблица заявок (issues)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID заявки |
| sequential_id | integer | Номер заявки |
| parent_id | integer | ID родительской заявки (уникальный ID заявки из таблицы issues) |
| company_id | integer | ID компании, привязанной к заявке (уникальный ID компании из таблицы companies) |
| contact_id | integer | ID контактного лица, привязанного к заявке (уникальный ID контакта из таблицы users) |
| maintenance_entity_id | integer | ID объекта обслуживания, привязанного к заявке (уникальный ID объекта обслуживания из таблицы company_maintenance_entities) |
| assignee_id | integer | ID ответственного за заявку (уникальный ID сотрудника из таблицы users) |
| author_id | integer | ID автора заявки (уникальный ID сотрудника или контакта из таблицы users) |
| agreement_id | integer | ID договора, привязанного к заявке |
| status_id | integer | ID текущего статуса заявки (уникальный ID статуса заявки из таблицы issue_statuses) |
| work_type_id | integer | ID типа заявки (уникальный ID типа заявки из таблицы issue_work_types) |
| priority_id | integer | ID приоритета заявки (уникальный ID приоритета заявки из таблицы issue_priorities) |
| title | character varying | Название заявки |
| created_at | timestamp | Дата регистрации заявки |
| completed_at | timestamp | Дата решения заявки |
| deadline_at | timestamp | Плановая дата решения заявки |
| employees_updated_at | timestamp | Дата последнего изменения заявки для сотрудника |
| contacts_updated_at | timestamp | Дата последнего изменения заявки для контакта |
| delay_to | timestamp | Отложена до |
| spent_time_total | double | Затраченное время на заявку |
| start_execution_until | timestamp | Назначена на |
| planned_execution_in_hours | double | Плановая продолжительность |
| planned_reaction_at | timestamp | Плановое время реакции на заявку |
| reacted_at | timestamp | Время реакции на заявку |
| deleted_at | timestamp | Дата удаления заявки |
| spent_seconds_for_reaction_in_sla | integer | Время реакции в секундах (по графику обслуживания) |
| spent_seconds_for_completion_in_sla | integer | Время решения в секундах (по графику обслуживания) |
| group_id | integer | ID ответственной группы заявки (уникальный ID группы сотрудников из таблицы groups) |
| parameters | jsonb | Дополнительные атрибуты заявки |
| source | integer | Способ регистрации заявки. Возможные значения: {0=>“Электронная почта”, 1=>“Web-форма”, 2=>“Клиентский портал”, 3=>“Диспетчер”, 4=>“API”, 5=>“Мобильный сотрудник”, 6=>“Партнерская заявка”, 7=>“Телеграм”, 8=>“Оборудование клиента”, 9=>“Повторяющаяся заявка”, 10=>“Оборудование клиента”, 11=>“Мобильный контакт”} |
| seconds_to_deadline | integer | Время оставшееся до Плановой даты решения заявки по нормативу в секундах |
| repeat_at | timestamp | Дата/время следующего повторения |
| repeat_period | integer | Количество периодов, через которое происходит повторение |
| repeat_period_type | integer | Период повторения. Возможные значения: {0=>“День”, 1=>“Неделя”, 2=>“Месяц”} |
| repeated_to_issue_id | integer | ID заявки, которая является следующей итерацией повторения для текущей |
Примечание: ¶
-
В таблице issues хранятся все заявки, включая удаленные. У удаленных заявок присутствует дата удаления deleted_at. У остальных заявок значение отсутствует.
-
Дополнительные атрибуты заявки хранятся в виде jsonb. Данное поле представляет собой хеш, в котором ключом является код дополнительного атрибута, а значением является хранимое значение дополнительного атрибута.
Например:
Есть дополнительный атрибут заявки с кодом service. В заявке с номером 56 в данном дополнительном атрибуте указано значение free. В таблице issues для заявки с номером sequential_id = 56 в атрибуте parameters будет храниться хеш вида {service: ‘free’}.
Таблица с комментариями (comments)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID комментария |
| issue_id | integer | Уникальный ID заявки из таблицы issues |
| author_id | integer | Уникальный ID автора комментария. ID из таблицы users, если комментарий от Контакта или Сотрудника. ID из таблицы companies, если комментарий от Компании. |
| author_type | character varying | Company если комментарий от Компании или User если комментарий от Контакта или Сотрудника |
| is_public | boolean | Признак “Публичный” |
| published_at | timestamp | Дата публикации комментария |
Таблица типов заявок (issue_work_types)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID типа заявки |
| code | character varying | Код типа заявки |
| name | character varying | Название типа заявки |
| inner | boolean | Признак типа заявки “Внутренняя” |
Таблица приоритетов заявок (issue_priorities)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID приоритета заявки |
| code | character varying | Код приоритета заявки |
| name | character varying | Название приоритета заявки |
Таблица с доп атрибутами заявок (issue_parameters)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID доп. атрибута |
| code | character varying | Код доп. атрибута |
| name | character varying | Название доп. атрибута |
| sequential_id | integer | ID доп. атрибута в рамках аккаунта |
| field_type | integer | Тип доп. атрибута. Возможные значения: {0=>“Строка”, 1=>“Дата”, 2=>“Дата/время”, 3=>“Чекбокс”, 4=>“Значение из списка”, 5=>“Набор значений из списка”} |
| required | boolean | Признак обязательности |
| field_type_values | array | Набор допустимых значений доп. атрибута |
Таблица статусов заявок (issue_statuses)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID статуса заявки |
| code | character varying | Код статуса заявки |
| name | character varying | Название статуса заявки |
| final | boolean | Заявки в этом статусе считаются выполненными |
| keep_deadline | boolean | Не учитывать время, проведенное в статусе |
Таблица истории смены статусов заявок (issue_status_times)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID смены статуса заявки |
| start_at | timestamp | Дата перехода заявки в статус |
| end_at | timestamp | Дата выхода заявки из статуса |
| value | integer | Количество секунд, которое заявка провела в статусе (астрономическое время) |
| on_schedule_value | integer | Количество секунд, которое заявка провела в статусе с учетом графика обслуживания, который соответствует заявке на момент смены статуса |
| status_id | integer | ID статуса заявки (уникальный ID статуса заявки из таблицы issue_statuses) |
| issue_id | integer | ID заявки (уникальный ID заявки из таблицы issues) |
| author_id | integer | Уникальный ID автора. ID из таблицы users, если автором является Контакт или Сотрудник. ID из таблицы equipments, если автором является Оборудование. |
| author_type | character varying | Equipment если автором является оборудование, User если автором является Контакт или Сотрудник |
| automatical | boolean | Автоматическая смена статуса |
Таблица трудозатрат по заявкам (time_entries)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID трудозатраты |
| employee_id | integer | ID сотрудника (уникальный ID сотрудника из таблицы users) |
| spent_time | double | Затраченное время |
| comment | text | Комментарий |
| issue_id | integer | ID заявки (уникальный ID заявки из таблицы issues) |
| logged_at | timestamp | Дата/время за которое были списаны трудозатраты |
| created_at | timestamp | Дата/время добавления трудозатраты |
| parameters | jsonb | Дополнительные атрибуты трудозатраты |
Примечание: ¶
Дополнительные атрибуты трудозатрат хранятся в виде jsonb. Данное поле представляет собой хеш, в котором ключом является код дополнительного атрибута, а значением является хранимое значение дополнительного атрибута.
Например:
Есть дополнительный атрибут трудозатрат с кодом service. Для трудозатрат в данном дополнительном атрибуте указано значение free. В таблице time_entries для этой трудозатраты в атрибуте parameters будет храниться хеш вида {service: ‘free’}.
Таблица спецификаций по заявкам (issue_services)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID строки спецификации заявки |
| service_id | integer | ID услуги (уникальный ID услуги из таблицы price_list_lines) |
| issue_id | integer | ID заявки (уникальный ID заявки из таблицы issues) |
| quantity | double | Количество |
| discount | double | Скидка |
| total | double | Стоимость с учетом НДС |
| total_nds | double | Величина НДС |
| performer_id | integer | ID сотрудника (уникальный ID сотрудника из таблицы users) |
| created_at | timestamp | Дата создания |
| updated_at | timestamp | Дата изменения |
| comment | character varying | Комментарий |
Таблица с названием способов регистрации заявок (issue_sources)
| Название столбца | Тип | Описание |
|---|---|---|
| code | integer | Код способа регистрации заявок (таблица issues, столбец source) |
| locale | character varying | Локаль для которой определено указанное в столбце value название способа регистрации аккаунта |
| value | character varying | Название способа регистрации в локали из столбца locale |
Таблица с оценками заявок (issue_rates)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID оценки заявки |
| issue_id | integer | ID заявки (уникальный ID заявки из таблицы issues) |
| value | character varying | Код оценки заявки. Возможные значения: {0=>“Плохо”, 1=>“Нормально”, 2=>“Хорошо”, null=>“Без оценки”} |
| rated_at | timestamp | Дата оценки |
| author_id | integer | ID автора оценки (уникальный ID сотрудника из таблицы users) |
Таблица с переводами оценок заявок (issue_rates_localized)
| Название столбца | Тип | Описание |
|---|---|---|
| code | integer | Код оценки заявки (таблица issue_rates, столбец value) |
| locale | character varying | Локаль для которой определено указанное в столбце value название оценки заявки |
| value | character varying | Название оценки заявки в локали из столбца locale |
Таблица с чек-листом заявок (issue_check_list_items)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID строки пункта чек-листа |
| issue_id | integer | ID заявки (уникальный ID заявки из таблицы issues) |
| name | character varying | Название пункта чек-листа |
| required | boolean | Признак обязательности |
| position | integer | Позиция пункта |
| checked_by_user_id | integer | Уникальный ID сотрудника из таблицы users, выполнившего пункт чек-листа |
| checked_at | timestamp | Дата/время выполнения пункта |
| planned_execution_in_hours | double | Плановое время выполнения |
Таблица параметров пунктов чек-листа заявок (issue_check_list_item_parameters)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID параметра пункта чек-листа |
| item_id | integer | ID пункта чек-листа (уникальный ID пункта чек-листа из таблицы issue_check_list_items) |
| param_type | character varying | Тип параметра |
| value | text | Значение параметра |
Таблица с историей смены ответственных за заявку (issue_assignee_logs)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID строки |
| owner_id | integer | ID автора действия по смене ответственного из таблицы users, если есть |
| trackable_id | integer | ID заявки (уникальный ID заявки из таблицы issues) |
| assignee_was_id | integer | ID предыдущего ответственного сотрудника (уникальный ID заявки из таблицы users) |
| assignee_now_id | integer | ID нового ответственного сотрудника (уникальный ID заявки из таблицы users) |
| assignee_group_was_id | integer | ID предыдущей ответственной группы (уникальный ID заявки из таблицы groups) |
| assignee_group_now_id | integer | ID новой ответственной группы (уникальный ID заявки из таблицы groups) |
| automatical | boolean | Автоматическая смена ответственного |
| created_at | timestamp | Дата/время события |
Таблица с историей назначения соисполнителей заявки (issue_coexecutor_logs)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID строки |
| created_at | timestamp | Дата/время события |
| action_type | integer | Тип действия. Возможные значения: {0=>“Добавление”, 1=>“Удаление”} |
| coexecutor_id | integer | ID соисполнителя (уникальный ID заявки из таблицы users) |
| trackable_id | integer | ID заявки (уникальный ID заявки из таблицы issues) |
| owner_id | integer | ID автора действия по смене соисполнителя из таблицы users, если есть |
Таблица с историей смены типа заявки (issue_work_type_log)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID строки |
| owner_id | integer | ID автора действия по смене типа заявки из таблицы users, если есть |
| trackable_id | integer | ID заявки (уникальный ID заявки из таблицы issues) |
| old_type | integer | ID старого типа заявки из таблицы issue_work_types |
| new_type | integer | ID нового типа заявки из таблицы issue_work_types |
| created_at | timestamp | Дата/время события |
Таблица связей соисполнителей с заявками (issue_coexecutors)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID связи соисполнителя с заявкой |
| issue_id | integer | ID заявки (уникальный ID заявки из таблицы issues) |
| group_id | integer | ID группы (уникальный ID группы сотрудников из таблицы groups) |
| user_id | integer | ID сотрудника (уникальный ID сотрудника из таблицы users) |
Компании ¶
Таблица компаний (companies)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID компании |
| sequential_id | integer | ID компании в рамках аккаунта |
| name | character varying (2000) | Название компании |
| additional_name | character varying | Дополнительное название компании |
| category_id | integer | ID категории компании (уникальный ID категории компании из таблицы company_categories) |
| default_assignee_id | integer | Ответственный за компанию (сотрудник) |
| default_assignee_group_id | integer | Ответственный за компанию (группа) |
| crm_1c_id | character varying | Идентификатор компании в 1С |
| parameters | jsonb | Дополнительные атрибуты компании |
| created_at | timestamp | Дата создания |
| active | boolean | Признак активности (true для активных и false для архивных) |
Примечание: ¶
Дополнительные атрибуты компании хранятся в виде jsonb. Данное поле представляет собой хеш, в котором ключом является код дополнительного атрибута, а значением является хранимое значение дополнительного атрибута.
Например:
Есть дополнительный атрибут компании с кодом service. Для компании в данном дополнительном атрибуте указано значение free. В таблице companies для этой компании в атрибуте parameters будет храниться хеш вида {service: ‘free’}.
Таблица категорий компаний (company_categories)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID категории компании |
| code | character varying | Код категории компании |
| name | character varying | Название категории компании |
| color | character varying | Цвет категории компании |
Таблица связей компаний с внешними контактами-наблюдателями (company_external_observers)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID связи внешнего контакта-наблюдателя и компании |
| company_id | integer | ID компании (уникальный ID объекта из таблицы companies) |
| contact_id | integer | ID внешнего контакта-наблюдателя (уникальный ID из таблицы users) |
Таблица связи компаний с наблюдателями-сотрудниками (company_observer_users)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID записи |
| company_id | integer | Уникальный идентификатор связанной компании из таблицы companies |
| user_id | integer | Уникальный идентификатор связанного сотрудника из таблицы users |
Таблица связи компаний с наблюдателями-группами (company_observer_groups)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID записи |
| company_id | integer | Уникальный идентификатор связанной компании из таблицы companies |
| group_id | integer | Уникальный идентификатор связанной группы сотрудников из таблицы groups |
Таблица с доп атрибутами компаний (company_parameters)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID доп. атрибута |
| code | character varying | Код доп. атрибута |
| name | character varying | Название доп. атрибута |
| field_type | integer | Тип доп. атрибута. Возможные значения: {0=>“Строка”, 1=>“Дата”, 2=>“Дата/время”, 3=>“Чекбокс”, 4=>“Значение из списка”, 5=>“Набор значений из списка”} |
| required | boolean | Признак обязательности |
| field_type_values | array | Набор допустимых значений доп. атрибута |
Объекты обслуживания ¶
Таблица объектов обслуживания (company_maintenance_entities)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID объекта обслуживания |
| sequential_id | integer | ID объекта обслуживания в рамках аккаунта |
| name | character varying | Название объекта обслуживания |
| company_id | integer | ID компании, к которой привязан объект обслуживания (уникальный ID компании из таблицы companies) |
| timezone | character varying | Часовой пояс объекта обслуживания |
| parameters | jsonb | Дополнительные атрибуты объекта обслуживания |
| default_assignee_id | integer | Ответственный сотрудник (уникальный ID из таблицы users) |
| default_assignee_group_id | integer | Ответственная группа (уникальный ID из таблицы groups) |
| created_at | timestamp | Дата создания |
| active | boolean | Признак активности. true если активный и false если архивный. |
Примечание: ¶
Дополнительные атрибуты объекта обслуживания хранятся в виде jsonb. Данное поле представляет собой хеш, в котором ключом является код дополнительного атрибута, а значением является хранимое значение дополнительного атрибута.
Например:
Есть дополнительный атрибут объекта обслуживания с кодом service. Для объекта обслуживания в данном дополнительном атрибуте указано значение free. В таблице company_maintenance_entities для этого объекта обслуживания в атрибуте parameters будет храниться хеш вида {service: ‘free’}.
Таблица связи объектов обслуживания с контактными лицами (contact_maintenance_entities)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID связи контактного лица и объекта обслуживания |
| maintenance_entity_id | integer | ID объекта обслуживания (уникальный ID объекта обслуживания из таблицы company_maintenance_entities) |
| contact_id | integer | ID контактного лица (уникальный ID из таблицы users) |
Таблица связи объектов обслуживания с наблюдателями-сотрудниками (maintenance_entities_observer_users)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID записи |
| maintenance_entity_id | integer | ID объекта обслуживания (уникальный ID объекта обслуживания из таблицы company_maintenance_entities) |
| user_id | integer | Уникальный идентификатор связанного сотрудника из таблицы users |
Таблица связи объектов обслуживания с наблюдателями-группами (maintenance_entities_observer_groups)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID записи |
| maintenance_entity_id | integer | ID объекта обслуживания (уникальный ID объекта обслуживания из таблицы company_maintenance_entities) |
| group_id | integer | Уникальный идентификатор связанной группы сотрудников из таблицы groups |
Таблица с доп атрибутами объектов обслуживания (company_maintenance_entity_parameters)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID доп. атрибута |
| code | character varying | Код доп. атрибута |
| name | character varying | Название доп. атрибута |
| field_type | integer | Тип доп. атрибута. Возможные значения: {0=>“Строка”, 1=>“Дата”, 2=>“Дата/время”, 3=>“Чекбокс”, 4=>“Значение из списка”, 5=>“Набор значений из списка”} |
| required | boolean | Признак обязательности |
| field_type_values | array | Набор допустимых значений доп. атрибута |
Оборудование ¶
Таблица оборудования (equipments)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID оборудования |
| sequential_id | integer | ID оборудования в рамках аккаунта |
| inventory_number | character varying | Инвентарный номер оборудования |
| serial_number | character varying | Серийный номер оборудования |
| equipment_model_id | integer | ID модели оборудования (уникальный ID модели оборудования из таблицы equipment_models) |
| equipment_kind_id | integer | ID типа оборудования (уникальный ID типа оборудования из таблицы equipment_kinds) |
| equipment_manufacturer_id | integer | ID производителя оборудования (уникальный ID производителя оборудования из таблицы equipment_manufacturers) |
| company_id | integer | ID компании, к которой привязано оборудование (уникальный ID компании из таблицы companies) |
| maintenance_entity_id | integer | ID объекта обслуживания, к которому привязано оборудование (уникальный ID объекта обслуживания из таблицы company_maintenance_entities) |
| parent_id | integer | ID головного оборудования (уникальный ID оборудования из таблицы equipments) |
| warehouse_id | integer | ID склада (уникальный ID склада из таблицы warehouses) |
| parameters | jsonb | Дополнительные атрибуты оборудования |
| created_at | timestamp | Дата создания |
Примечание: ¶
Дополнительные атрибуты оборудования хранятся в виде jsonb. Данное поле представляет собой хеш, в котором ключом является код дополнительного атрибута, а значением является хранимое значение дополнительного атрибута.
Например:
Есть дополнительный атрибут оборудования с кодом service. Для оборудования в данном дополнительном атрибуте указано значение free. В таблице equipments для этого оборудования в атрибуте parameters будет храниться хеш вида {service: ‘free’}.
Таблица связи оборудования с заявками (issue_equipments)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID связи оборудования с заявкой |
| issue_id | integer | ID заявки (уникальный ID заявки из таблицы issues) |
| equipment_id | integer | ID оборудования (уникальный ID оборудования из таблицы equipments) |
Таблица типов оборудования (equipment_kinds)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID типа оборудования |
| code | character varying | Код типа оборудования |
| name | character varying | Название типа оборудования |
Таблица производителей оборудования (equipment_manufacturers)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID производителя оборудования |
| code | character varying | Код производителя оборудования |
| name | character varying | Название производителя оборудования |
Таблица моделей оборудования (equipment_models)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID модели оборудования |
| code | character varying | Код модели оборудования |
| name | character varying | Название модели оборудования |
| equipment_manufacturer_id | integer | ID производителя оборудования (уникальный ID производителя оборудования из таблицы equipment_manufacturers) |
| equipment_kind_id | integer | ID типа оборудования (уникальный ID типа оборудования из таблицы equipment_kinds) |
Таблица с доп атрибутами оборудования (equipment_parameters)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID доп. атрибута |
| sequential_id | integer | ID доп. атрибута в рамках аккаунта |
| code | character varying | Код доп. атрибута |
| name | character varying | Название доп. атрибута |
| field_type | integer | Тип доп. атрибута. Возможные значения: {0=>“Строка”, 1=>“Дата”, 2=>“Дата/время”, 3=>“Чекбокс”, 4=>“Значение из списка”, 5=>“Набор значений из списка”} |
| required | boolean | Признак обязательности |
| field_type_values | array | Набор допустимых значений доп. атрибута |
Таблица с историей смены доп атрибутов оборудования (equipment_parameter_logs)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID строки |
| owner_id | integer | ID автора действия по смене доп. атрибута из таблицы users, если есть |
| trackable_id | integer | ID оборудования (уникальный ID оборудования из таблицы equipments) |
| code | character varying | Код доп. атрибута |
| name | character varying | Название доп. атрибута |
| field_type | character varying | Тип доп. атрибута. Возможные значения: {ftstring=>“Строка”, ftdate=>“Дата”, ftdatetime=>“Дата/время”, ftcheckbox=>“Чекбокс”, ftselect=>“Значение из списка”, ftmultiselect=>“Набор значений из списка”} |
| value | jsonb | Хеш с информацией об изменении значения доп атрибута. Прошлое значение хранится под ключом old_value. Новое значение хранится под ключом new_value. Например: { old_value: ‘’, new_value: ‘значение’ } |
| created_at | timestamp | Дата/время события |
Таблица связей атрибутов оборудования с типами оборудования (equipment_kind_parameters)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID связи атрибута с типом оборудования |
| equipment_kind_id | integer | ID типа оборудования (уникальный ID типа оборудования из таблицы equipment_kinds) |
| parameter_id | integer | ID доп. атрибута оборудования (уникальный ID доп. атрибута оборудования из таблицы equipment_parameters) |
Договоры ¶
Таблица с договорами (agreements)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID договора |
| sequential_id | integer | ID договора в рамках аккаунта |
| title | character varying | Название договора |
| parameters | jsonb | Дополнительные атрибуты договора |
| active | boolean | Признак активности. true если активный и false если архивный. |
| created_at | timestamp | Дата создания |
Таблица связей договоров с компаниями (company_agreements)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID записи |
| company_id | integer | Уникальный идентификатор связанной компании из таблицы companies |
| agreement_id | integer | Уникальный идентификатор связанного договора из таблицы agreements |
Таблица связей договоров с оборудованием (equipment_related_agreements)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID записи |
| equipment_id | integer | Уникальный идентификатор связанного оборудования из таблицы equipments |
| agreement_id | integer | Уникальный идентификатор связанного договора из таблицы agreements |
Таблица с сервисными периодами (agreement_service_periods)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID сервисного периода |
| sequential_id | integer | Номер сервисного периода в рамках договора |
| agreement_id | integer | Уникальный идентификатор связанного договора |
| start_date | date | Дата начала сервисного периода |
| end_date | date | Дата завершения сервисного периода |
| cost | double precision | Стоимость сервисного периода |
| comment | character varying | Комментарий |
| paid | boolean | Статус оплаченности |
| postpay | boolean | Признак постоплаты |
Таблица связей договоров с объектами обслуживания (company_maintenance_entity_related_agreements)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID связи договора и объекта обслуживания |
| maintenance_entity_id | integer | ID объекта обслуживания (уникальный ID объекта обслуживания из таблицы company_maintenance_entities) |
| agreement_id | integer | ID договора (уникальный ID из таблицы agreements) |
Таблица с доп атрибутами договоров (agreement_parameters)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID доп. атрибута |
| code | character varying | Код доп. атрибута |
| name | character varying | Название доп. атрибута |
| field_type | integer | Тип доп. атрибута. Возможные значения: {0=>“Строка”, 1=>“Дата”, 2=>“Дата/время”, 3=>“Чекбокс”, 4=>“Значение из списка”, 5=>“Набор значений из списка”, 6=>“Текст”} |
| required | boolean | Признак обязательности |
| field_type_values | array | Набор допустимых значений доп. атрибута |
Прайс-листы ¶
Таблица строк прайс-листов (price_list_lines)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID услуги |
| price | double | Цена |
| nds | integer | Ставка НДС, % |
| price_list_id | integer | ID прайс-листа (уникальный ID прайс-листа из таблицы price_lists) |
| nomenclature_item_id | integer | ID элемента справочника номенклатуры (уникальный ID номенклатуры из таблицы nomenclature_items) |
Таблица со списком прайс-листов (price_lists)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID прайс-листа |
| name | character varying | Название прайс-листа |
Номенклатура ¶
Таблица позиций номенклатур (nomenclature_items)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID позиции номенклатуры |
| code | character varying | Код позиции номенклатуры |
| item_type | integer | Тип позиции номенклатуры. Возможные значения: {0=>“Услуги”, 1=>“Товары/Продукты”, 2=>“Материалы”, 3=>“Работы”} |
| name | character varying | Название позиции номенклатуры |
| description | character varying | Описание позиции номенклатуры |
| unit | character varying | Единица измерения |
| vendor_code | character varying | Артикул позиции номенклатуры |
| active | boolean | Признак активности. true если активный и false если архивный. |
| group_id | integer | ID группы (уникальный ID группы из таблицы nomenclature_groups) |
Таблица групп номенклатур (nomenclature_groups)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID группы номенклатур |
| parent_id | integer | ID группы (уникальный ID группы из таблицы nomenclature_groups) |
| code | character varying | Код группы номенклатур |
| name | character varying | Название группы номенклатур |
| active | boolean | Признак активности. true если активный и false если архивный. |
Склады ¶
Таблица складов (warehouses)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID склада |
| sequential_id | integer | ID склада в рамках аккаунта |
| name | character varying | Название склада |
| external_id | character varying | Внешний id |
| active | boolean | Признак активности. true если активный и false если архивный. |
Таблица материально ответственных лиц (warehouse_assignees)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID записи |
| warehouse_id | integer | ID склада (уникальный ID склада из таблицы warehouses) |
| user_id | integer | ID пользователя (уникальный ID пользователя из таблицы users) |
Таблица наблюдателей складов (warehouse_observer_users)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID записи |
| warehouse_id | integer | ID склада (уникальный ID склада из таблицы warehouses) |
| user_id | integer | ID пользователя (уникальный ID пользователя из таблицы users) |
Таблица документов (material_assets_documents)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID документа |
| sequential_id | integer | ID документа в рамках аккаунта |
| doc_type | integer | Тип документа. Возможные значения: {0=>“Оприходование”, 1=>“Списание”, 2=>“Перемещение”} |
| accounted_at | timestamp | Дата учета документа |
| from_warehouse_id | integer | ID склада, с которого происходит списание или перемещение (уникальный ID из таблицы warehouses) |
| to_warehouse_id | integer | ID склада, на который осуществляется приход или перемещение (уникальный ID из таблицы warehouses) |
| issue_id | integer | ID заявки (уникальный ID заявки из таблицы issues) |
| state | integer | Статус документа. Возможные значения: {0=>“Черновик”, 1=>“Согласование”, 2=>“Ожидает приемки”, 3=>“Учтен”} |
| external_doc | character varying | Внешний документ |
| description | character varying | Описание документа |
| created_at | timestamp | Дата создания |
| author_id | integer | ID автора заявки (уникальный ID пользователя из таблицы users) |
Таблица ТМЦ (material_assets_document_items)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID записи |
| quantity | double | Количество |
| nomenclature_item_id | integer | ID элемента справочника номенклатуры (уникальный ID номенклатуры из таблицы nomenclature_items) |
| material_assets_document_id | integer | ID документа (уникальный ID документа из таблицы material_assets_documents) |
| created_at | timestamp | Дата создания |
Таблица связей оборудования и документов (material_assets_document_equipment_items)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID записи |
| equipment_id | integer | ID оборудования (уникальный ID оборудования из таблицы equipments) |
| material_assets_document_id | integer | ID документа (уникальный ID документа из таблицы material_assets_documents) |
| issue_id | integer | ID заявки (уникальный ID заявки из таблицы issues) |
Таблица остатков (material_assets_remainders)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID записи |
| quantity | double | Количество |
| nomenclature_item_id | integer | ID элемента справочника номенклатуры (уникальный ID номенклатуры из таблицы nomenclature_items) |
| warehouse_id | integer | ID склада (уникальный ID склада из таблицы warehouses) |
Пользователи ¶
Таблица пользователей (users)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID пользователя |
| sequential_id | integer | ID пользователя в рамках аккаунта |
| login | character varying | Логин пользователя |
| character varying | E-mail пользователя | |
| first_name | character varying | Имя пользователя |
| last_name | character varying | Фамилия пользователя |
| position | character varying (300) | Должность пользователя |
| patronymic | character varying (100) | Отчество пользователя |
| company_id | integer | ID компании пользователя (уникальный ID компании из таблицы companies, только для пользователей-контактов) |
| type | character varying | Тип пользователя (см. примечания) |
| crm_1c_id | character varying | Идентификатор пользователя в 1C |
| telephony_number | character varying | Добавочный номер (только для пользователей-сотрудников) |
| parameters | jsonb | Дополнительные атрибуты пользователя (только для пользователей-контактов) |
| deleted_at | timestamp | Дата удаления пользователя |
| active | boolean | Признак активности. true если активный и false если архивный. |
| created_at | timestamp | Дата создания |
| phone | character varying | Номер телефона пользователя |
Примечание: ¶
-
В таблице users хранится информация и о сотрудниках, и о контактных лицах. Их различает атрибут type. Для сотрудников хранится значение Employee, для контактов — Contact.
-
Дополнительные атрибуты контакта хранятся в виде jsonb. Данное поле представляет собой хеш, в котором ключом является код дополнительного атрибута, а значением является хранимое значение дополнительного атрибута.
Например:
Есть дополнительный атрибут контакта с кодом service. Для контакта в данном дополнительном атрибуте указано значение free. В таблице users для этого контакта в атрибуте parameters будет храниться хеш вида {service: ‘free’}.
Таблица групп сотрудников (groups)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID группы сотрудников |
| sequential_id | integer | ID группы в рамках аккаунта |
| name | character varying | Название группы сотрудников |
Таблица связей сотрудников и групп сотрудников (employee_groups)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID связи сотрудника и группы |
| employee_id | integer | Уникальный ID пользователя из таблицы users |
| group_id | integer | Уникальный ID группы из таблицы groups |
Таблица ролей сотрудников (employee_roles)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID роли |
| name | character varying | Название роли |
| code | character varying | Код роли. У администраторских ролей код ‘admin’ |
| default | boolean | Является ли роль стандартной |
| position | integer | Порядковый номер |
| created_at | timestamp | Дата создания |
Таблица с доп атрибутами контактов (contact_parameters)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID доп. атрибута |
| code | character varying | Код доп. атрибута |
| name | character varying | Название доп. атрибута |
| field_type | integer | Тип доп. атрибута. Возможные значения: {0=>“Строка”, 1=>“Дата”, 2=>“Дата/время”, 3=>“Чекбокс”, 4=>“Значение из списка”, 5=>“Набор значений из списка”} |
| required | boolean | Признак обязательности |
| field_type_values | array | Набор допустимых значений доп. атрибута |
Информация об аккаунте ¶
Таблица информации об аккаунте (accounts)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID аккаунта |
| name | character varying | Название аккаунта |
| parked_domain | character varying | Припаркованный домен, если есть |
| timezone | character varying | Часовой пояс аккаунта |
| locale | character varying | Язык аккаунта |
| last_update | timestamp | Дата/время последней синхронизации данных в GMT+0 |
Телефонные разговоры ¶
Таблица с телефонными разговорами (phone_calls)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID телефонного разговора |
| call_id | character varying | Уникальный ID звонка на АТС |
| started_at | timestamp | Дата/время начала звонка |
| finished_at | timestamp | Дата/время завершения звонка |
| direction | integer | Направление вызова (0 - входящий, 1 - исходящий) |
| source_phone | character varying | Номер звонящего абонента |
| receiver_phone | character varying | Номер принимающего абонента |
| company_id | integer | ID компании, привязанной к телефонному звонку (уникальный ID компании из таблицы companies) |
| contact_id | integer | ID контактного лица, привязанного к телефонному звонку (уникальный ID контакта из таблицы users) |
| employee_id | integer | ID сотрудника, ответственного за звонок (уникальный ID сотрудника из таблицы users) |
| duration | integer | Продолжительность разговора |
| created_at | timestamp | Дата создания |
Таблица связей телефонных разговоров с заявками (phone_calls_issues)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID записи |
| phone_call_id | integer | ID телефонного разговора (уникальный ID телефонного разговора из таблицы phone_calls) |
| issue_id | integer | ID заявки (уникальный ID заявки из таблицы issues) |
Адреса и координаты ¶
Таблица адресов объектов обслуживания компаний и заявок (addresses)
| Название столбца | Тип | Описание |
|---|---|---|
| id | integer | Уникальный ID адреса |
| string_value | character varying | Текстовое значение адреса |
| coordinates | point | Координаты адреса |
| owner_id | integer | ID объекта обслуживания, компании или заявки (уникальный ID объекта обслуживания из таблицы company_maintenance_entities, компании из таблицы companies или заявки из таблицы issues) |
| owner_type | character varying | Company::MaintenanceEntity для объектов обслуживания, Company для компаний, Issue для заявок |
Примечание: ¶
Таблица addresses хранит адреса разных объектов. На данный момент предоставлен доступ к адресам объектов обслуживания, адресам компаний и адресам заявок. Связь между адресом и связанным объектом является полиморфической. Для объектов обслуживания в атрибуте owner_type хранится значение Company::MaintenanceEntity, в атрибуте owner_id хранится id объекта обслуживания. Для компаний в атрибуте owner_type хранится значение Company, в атрибуте owner_id хранится id компании. Для заявок в атрибуте owner_type хранится значение Issue, в атрибуте owner_id хранится id заявки.