Мобильное приложение
REST API
Тестирование

Обновление заявки

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

Метод изменяет заявку. В fields передаются только те поля, которые нужно изменить.

Нужна авторизация и возможность редактировать заявку: право на все заявки, своя заявка, заявка своего подразделения при праве на заявки своего подразделения, заявка назначенного подразделения при праве на назначенные заявки, либо заявка выбранных подразделений.

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

КлючОписаниеОбяз.
idИД заявкиДа
fieldsИзменяемые поля заявки. Чтобы поменять только чеклист или дополнительные поля, передайте пустой объектДа
checklistПолный список пунктов чеклиста. Если параметр не передан, чеклист не меняется. Пустой массив удаляет все пунктыНет
entityFieldsДополнительные поля. Пары код / значение. Если параметр не передан, дополнительные поля не меняютсяНет

Объект полей заявки (fields)

КлючОписаниеОбяз.
nameНазвание. Пустое значение не принимаетсяНет
descriptionОписаниеНет
equipment_idИД оборудованияНет*
equipment_external_codeВнешний код оборудования. По нему находится оборудование клиента, в заявку записывается его ИДНет*
responsible_department_idИД подразделения исполнителя. Пустое значение не принимается. Смена подразделения без нового исполнителя снимает исполнителя и переводит заявку в статус новойНет
responsible_user_idИД исполнителя. Назначение исполнителя, когда его ещё не было, переводит заявку в статус «исполнитель назначен»Нет
type_idИД типа заявки. Пустое значение не принимаетсяНет
priority_idИД приоритетаНет
sla_level_idИД уровня SLAНет
start_date_planПланируемая дата начала, дд.мм.гггг чч:мм:ссНет
end_date_planПланируемая дата завершения, дд.мм.гггг чч:мм:ссНет
duration_planПлановое время в виде часы:минуты, например 02:30Нет
report_requiredТребуется отчёт при завершении: Y или NНет

* может быть задан либо equipment_id, либо equipment_external_code. Оборудование должно принадлежать клиенту.

Если известны дата начала и плановое время — переданные или уже сохранённые — дата завершения пересчитывается как дата начала плюс плановое время.

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

Переданный список полностью заменяет чеклист. Пункты, которых нет в списке, удаляются. Пункт без id или с id, в котором есть new, создаётся. Остальные пункты обновляются.

КлючОписаниеОбяз.
idИД пункта. Для нового пункта не передаётся или содержит newНет
nameНазвание. Пункт с пустым названием пропускаетсяДа
typeТип: TEXT — комментарий, PHOTO — фото, NUMBER — значение, CHECKBOX — да/нет. Если не передан, используется TEXTНет
optionsДополнительные настройки. Для пункта PHOTO поле disable_gallery со значением Y отключает выбор фото из галереи. Для существующего пункта настройки меняются, только если options переданНет
codeСимвольный кодНет

Объект дополнительных полей (entityFields)

Пары код / значение. Набор полей зависит от типа заявки и настраивается в интерфейсе администрирования. Файловое поле передаётся как multipart, имя поля — entityFields.

Пример:

{
  "id": 15,
  "fields": {
    "name": "Замена оборудования",
    "responsible_user_id": 42,
    "duration_plan": "02:30"
  },
  "checklist": [
    {
      "id": "new1",
      "name": "Проверка",
      "type": "CHECKBOX"
    }
  ]
}

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

КлючОписаниеОбяз.
idИД заявкиДа

Ошибки

  • PARAMS_ERROR — не передан id, либо дополнительное поле не прошло проверку
  • NOT_FOUND — заявка не найдена
  • ACCESS_ERROR — недостаточно прав
  • FIELDS_ERROR — пустое обязательное поле или оборудование не найдено
  • SAVE_ERROR — заявку, чеклист или дополнительные поля не удалось записать