Мобильное приложение

Список заявок

Сущность.Метод: request.list

Метод получает список заявок. 

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

 Ключ Описание  Обяз. 
order
Сортировка Нет
filter Фильтр Нет 
paging
Параметры постраничной выборки Нет 
loadChecklist Y/N загружать чеклисты Нет
Объект сортировки (order)

Представляет из себя пары поле / значение.
Сортировать можно по всем полям заявки.
В качестве значения можно использовать:
  • asc - в порядке возрастания
  • desc - в порядке убывания
Дополнительно можно сортировать по некоторым полям связанных сущностей:

 Поле Описание 
status.name название статуса
status.sort порядок статуса
priority.name название приоритета
priority.sort порядок приоритета
Пример:

{
 "status.sort": "asc",
 "id": "desc"
}

Объект фильтра (filter)

Массив вида {"фильтруемое поле"=>"значения фильтра" [, ...]}. "фильтруемое поле" может принимать значения:


 Поле Описание  Тип
id ИД заявки Число
number номер (выдаётся нумератором) Строка
name название заявки Строка
description описание Строка
equipment_id ИД оборудования    Число
equipment_external_code Внешний код оборудования Строка
created_by ИД автора заявки. Допускается указание MY_SELF - подставляется ИД текущего пользователя. Число
created_department_id ИД подразделения автора. Допускается указание MY_DEPARTMENT - подставляется ИД подразделения текущего пользователя. Число
 date_create Дата создания заявки. Дата
 date_update Дата обновления заявки  Дата
 date_status_update Дата обновления статуса заявки Дата
 date_close Дата завершения заявки Дата
 responsible_department_id ИД подразделения-исполнителя. Допускается указание MY_DEPARTMENT - подставляется ИД подразделения текущего пользователя. Число
 type_id ИД типа Число
 priority_id ИД приоритета Число
 status_id ИД статуса Число
 entity.#CODE# Фильтр по дополнительному полю заявки  
Пример:

{
   "created_by": "MY_SELF",
   ">=date_create": "26.08.2024",
   "<date_crete": "27.08.2024",
   "type_id": 2396,
   "entity.ROUTE_NUMBER": "12345"
}

Объект параметров постраничной выборки (pager)

 Ключ Описание  Обяз. 
size
Размер одной страницы.
По умолчанию 2000
Нет
page Номер страницы (нумерация от 1).
По умолчанию 1.
Нет 

Параметры ответа

 Ключ Описание  Обяз. 
items Массив заявок.
Да   
pager Параметры постраничной выборки Да 

Объект заявки


 Ключ Описание  Обяз. 
id ИД Да
number Номер заявки  
name Название Да
description
Описание Нет 
equipment_id
ИД оборудования     Нет

created_by ИД автора Да
created_department_id
ИД подразделения автора Да   
date_create Дата создания Да   
date_update Дата изменения Да
date_status_update Дата изменения статуса Да
date_close Дата завершения Нет
responsible_department_id ИД подразделения исполнителя Да
responsible_user_id ИД исполнителя Нет
type_id ИД типа заявки    Да
priority_id ИД приоритета заявки. Да
priority_name Название приоритета Да
priority_color Цвет приоритета Да
status_id ИД статуса Да
status_name Название статуса Да
status_color Цвет статуса Да
start_date_plan Планируемая дата начала Нет
end_date_plan Планируемая дата завершения Нет   
report_required Требуется отчёт при завершении Y/N  Нет   
deadline Контрольный срок Нет
checklist Массив пунктов чеклиста Нет

Объект пункта чеклиста (checklist)

 Ключ Описание  Обяз. 
 id  Ид Да
name Название Да
type Тип:
  • TEXT - комментарий
  • PHOTO - фото
  • NUMBER - значение
  • CHECKBOX - Да/Нет
Да
status  Статус прохождения:
  • N - ещё не проходили
  • C - не пройдено
  • F - пройдено
 Да
options  Дополнительные настройки пункта. Возможные поля:
  • disable_gallery - Y/N для пункта типа "Фото" отключает возможность выбрать фото из галлереи.

Нет   
code  Символьный код  Нет

 value  Значение  Нет