Справочный центр Wialon
Wialon для разработчиков Руководство пользователя Документация API unit create_task

create_task

Метод unit/create_task позволяет создать задачу для объекта. Чтобы отредактировать существующую задачу, используйте unit/update_task. Информация о том, как работают задачи в системе мониторинга, приведена в разделе Задачи.

В Wialon Local этот метод доступен начиная с версии 2504.

Конечная точка

Copied!
svc=unit/create_task&params={
	"itemId": <long>,
	"props": {
		"key1": <long>,
		"key2": <text>,
		.....
	}
}

Пример запроса:

Copied!
https://hst-api.wialon.com/wialon/ajax.html?
svc=unit/create_task&
params={
  "itemId": 1514,
  "props": {
    "task_sub_type": 22,
    "task_evt_name": "Refueling",
    "task_description": "Refuel the vehicle before the trip",
    "task_priority": 3,
    "task_params": {
      "filled": 40
    }
  }
}&
sid=SESSION_IDENTIFIER

Параметры

Запрос должен содержать следующие параметры:

Параметр Описание
itemId Идентификатор объекта.
props Объект свойств задачи (пары «ключ — значение»). Список доступных свойств приведен ниже.

Свойства задачи

Обязательные свойства отмечены звездочкой (*).

Свойство Тип Описание
task_sub_type* Integer Подтип задачи. Допустимые значения:
  • 21 (произвольный)
  • 22 (заправка топлива)
  • 23 (зарядка батареи)
  • 26 (работы по техобслуживанию)
Все подтипы приведены в разделе Подтипы событий и задач.
task_evt_name* String Название задачи. Не должно быть пустым.
task_description String Описание задачи.
task_assignee Long Идентификатор пользователя, на которого назначается задача. Необходимо право доступа Выполнение действий от имени пользователя на этого пользователя.
task_priority Integer Приоритет задачи. Допустимые значения:
  • 1 (Низкий)
  • 2 (Средний)
  • 3 (Высокий)
Если свойство не указано, используется 2.
task_status Integer Статус задачи. Новая задача всегда получает статус 1 (Новая), поэтому свойство должно быть равно 1 или не указано.
task_create_time Integer Время создания задачи (UNIX time). Если свойство не указано, равно 0 или позже текущего времени сервера, используется текущее время сервера. Время обновления задачи устанавливается равным этому же значению.
task_address_x
task_address_y		 Double Координаты задачи. Укажите оба свойства. Если указано только одно из них, оба игнорируются.
task_params Object Дополнительные параметры задачи. Поддерживаемые ключи:
  • filled (объем заправленного топлива)
  • charged (объем заряженной энергии)
  • cost (стоимость задачи)
  • engine_hours (моточасы транспортного средства)
  • mileage (пробег транспортного средства)
Значения filled и mileage указываются в системе измерения объекта.

Следующие свойства невозможно задать при создании задачи. Если вы передаете их, используйте указанные ниже значения:

Свойство Допустимое значение
task_id Любое. Значение игнорируется, и сервер генерирует идентификатор задачи.
task_update_time Любое. Значение игнорируется, и используется значение task_create_time.
task_tags Пустая строка.
task_comments Пустой массив.
task_done_rejected 0.

Права доступа

Чтобы создать задачу, необходимо право доступа Редактирование задач на объект. Чтобы назначить задачу на пользователя с помощью task_assignee, также необходимо право доступа Выполнение действий от имени пользователя на этого пользователя.

Для учетной записи должна быть включена услуга Задачи.

Ответ

При успешном выполнении запроса возвращается пустой результат.

Copied!
{}

Чтобы получить идентификатор созданной задачи, используйте messages/get_task_messages.

В противном случае возвращается код ошибки. Пример:

Copied!
{
    "error": 4,
    "reason": "INVALID_INPUT_PARAMS"
}

Коды ошибок

Код ошибки Описание Значение поля reason
4 Невалидные входные параметры. Одна из следующих причин:
  • отсутствует обязательный параметр или свойство либо оно имеет неверный тип;
  • значение task_sub_type отсутствует в списке допустимых значений;
  • task_evt_name пустое;
  • значение task_status не равно 1;
  • пользователь, указанный в task_assignee, не существует;
  • task_tags, task_comments или task_done_rejected не пустые.
 INVALID_INPUT_PARAMS
6 Задачи не поддерживаются для элемента с указанным itemId. UNKNOWN_ERROR
7 Доступ запрещен. Одна из следующих причин:
  • объект с указанным itemId не существует или недоступен текущему пользователю;
  • отсутствует право доступа Редактирование задач на объект;
  • отсутствует право доступа Выполнение действий от имени пользователя на пользователя, указанного в task_assignee;
  • для учетной записи не включена услуга Задачи.
 NO_ACCESS_TO_USER (только если отсутствует право доступа на пользователя)

Общие коды ошибок приведены в разделе Коды ошибок.

Если вы заметили ошибку в тексте, пожалуйста, выделите её и нажмите Ctrl+Enter.