Наряды

Наряд это описание работы, которую необходимо провести на выезде. Помимо этого, наряд содержит информацию, вносимую исполнителем во время выполнения наряда. Каждый наряд подразумевает один выезд. Обычно наряд включает в себя информацию о клиенте или объекте, список полей, взятый из шаблона, и набор резолюций, одну из которых исполнитель выберет при завершении наряда.

URL: https://api.planadoapp.com/v2/jobs

Действия

Catalog

Вебхуки

Типы вебхуков

Наряды поддерживают два типа вебхуков:

Структура наряда

Тело вебхука почти полностью повторяет формат ответа REST API.

В документации на конкретные типы вебхуков приведены примеры и описание запросов для CRUD-вебхуков и вебхуков состояния.

Table 1. Поля
Поле	Тип	JSON-тип	Может быть `null`	Описание
`event_type`	Строка	Строка	Нет	Тип события, которое изменило данные. Например, `job_started` или `job_updated`
`context`	Контекст	Объект	Нет	Контекст изменения
`job`	Наряд	Объект	Нет	Состояние наряда на момент изменения

Table 2. Поля `job`
Поле	Тип	JSON-тип	Может быть `null`	Описание
`uuid`	UUID	Строка	Нет	Уникальный идентификатор
`external_id`	Строка	Строка	Да	Внешний идентификатор
`external_order_id`	Строка	Строка	Да	Внешний идентификатор заказа
`serial_no`	Целое	Число	Нет	Порядковый номер наряда
`status`	Строка	Строка	Нет	Текущее состояние наряда
`scheduled_at`	Дата и время	Строка	Да	Запланированное время начала наряда
`scheduled_duration`	Длительность	Строка	Да	Запланированная длительность няряда
`description`	Строка	Строка	Да	Описание наряда, обычно содержит подробности предстоящей работы. Ограничено 15000 символов
`assignee`	Исполнитель	Объект	Да	Исполнитель — пользователь или бригада
`type`	Тип наряда	Объект	Да	Тип наряда
`template`	Шаблон	Объект	Да	Шаблон
`client`	Клиент	Объект	Да	Клиент
`site`	Объект	Объект	Да	Объект
`territory`	Участок	Объект	Да	Участок
`skills`	[Навык]	Массив	Нет	Список навыков, требуемых для выполнения наряда
`contacts`	[Контакт]	Массив	Нет	Список контактов
`possible_resolutions`	[Резолюция]	Массив	Нет	Список возможных резолюций
`custom_fields`	[Доп. поле]	Массив	Нет	Список дополнительных полей наряда
`report_fields`	[Доп. поле]	Массив	Нет	Список полей отчета
`resolution`	Резолюция	Объект	Нет	Резолюция. Это поле присутствует только у завершенных нарядов (`status == "finished"`)
`version`	Целое	Число	Нет	Порядковый номер версии
`previous`	Наряд	Объект	Нет	Предыдущее состояние наряда. Это поле присутствует только для событий с типом `job_updated`