Различия

Здесь показаны различия между двумя версиями данной страницы.

Ссылка на это сравнение

ru:pro:remoteapi:apiref:resource:update_job [05/12/2013 09:08]
zuve
ru:pro:remoteapi:apiref:resource:update_job [05/12/2013 10:09]
Строка 1: Строка 1:
-{{indexmenu_n>​30}} 
-====== Задания:​ создание,​ редактирование и удаление ====== 
  
-Для создания,​ редактирования и удаления заданий используется команда **resource/​update_job**: ​ 
- 
-<code javascript>​ 
-svc=resource/​update_job&​params={"​itemId":<​long>,​ 
- "​id":<​long>,​ 
- "​callMode":<​text>,​ 
- "​n":<​text>,​ 
- "​d":<​text>,​ 
- "​r":<​text>,​ 
- "​at":<​uint>,​ 
- "​m":<​uint>,​ 
- "​tz":<​int>,​ 
- "​l":<​text>,​ 
- "​sch":​{ 
- "​f1":<​uint>,​ 
- "​f2":<​uint>,​ 
- "​t1":<​uint>,​ 
- "​t2":<​uint>,​ 
- "​m":<​uint>,​ 
- "​y":<​uint>,​ 
- "​w":<​uint>​ 
- },  
- "​act":​{  
- "​t":<​text>,​ 
- "​p":​{ 
- <​text>:<​text>,​ 
- ... 
- }  
- }} 
-</​code>​ 
- 
-===== Параметры ===== 
- 
-^  Название ​ ^ Описание ^ 
-|  itemId ​ | ID ресурса | 
-|  id  | ID задания | 
-|  callMode ​ | режим: создание,​ редактирование,​ удаление (create, update, delete) | 
-|  **Параметры,​ обязательными только при создании и редактировании:​** ​ || 
-|  n  | название | 
-|  d  | описание | 
-|  r  | тип выполнения\\ //Тип выполнения//​ может быть двух видов: по точному графику и выполнение через каждое указанное количество часов. Если нужно задать точный график,​ то формат поля **"​r"​** будет вида "1 ...": после цифры 1 указывается время выполнения задания,​ если таких значений несколько,​ то они указываются через пробел. Время может быть указано «часы:​минуты» либо просто «часы». Если нужно указать выполнение через каждое указанное количество часов, то формат поля **"​r"​** будет вида "2 ...": после цифры 2 указывается время через которое задание должно повторятся в формате Unix time. | 
-|  at  | время активации | 
-|  m  | максимальное количество раз выполнения задания,​ 0 - не ограничено | 
-|  tz  | часовой пояс (сек) | 
-|  l  | язык, используемый для задания | 
-|  sch  | ограничение по времени | 
-|  f1  | время начала интервала 1 | 
-|  f2  | время начала интервала 2 | 
-|  t1  | время окончания интервала 1 | 
-|  t2  | время окончания интервала 2 | 
-|  m  | маска дней месяца | 
-|  y  | маска месяцев | 
-|  w  | маска дней недели | 
-|  act  | действие (список типов действий см. ниже) | 
-|  t  | тип | 
-|  p  | параметры вида - название:​ значение | 
- 
-===== Возвращаемый результат ===== 
- 
-При создании и редактировании:​ 
-<​code=javascript>​ 
-[ 
- <​long>,​ /​* ID задания */ 
- { 
- "​id":<​long>,​ /​* ID задания */ 
- "​n":<​text>,​ /​* название */ 
- "​d":<​text>,​ /​* описание */ 
- "​r":<​text>,​ /​* тип выполнения (см. выше) */ 
- "​at":<​uint>,​ /​* время активации */ 
- "​m":<​uint>,​ /​* максимальное количество раз выполнения задания,​ 0 - не ограничено */ 
- "​tz":<​long>,​ /​* часовой пояс */ 
- "​l":<​text>,​ 
- "​st":​{ /​* состояние */ 
- "​e":<​uint>,​ /​* активно/​неактивно */ 
- "​c":<​uint>,​ /​* количество выполнений */ 
- "​l":<​uint>​ /​* время последнего выполнения */ 
- }, 
- "​sch":​{ /​* ограничение по времени */ 
- "​f1":<​uint>,​ /​* время начала интервала 1 */ 
- "​f2":<​uint>,​ /​* время начала интервала 2 */ 
- "​t1":<​uint>,​ /​* время окончания интервала 1 */ 
- "​t2":<​uint>,​ /​* время окончания интервала 2 */ 
- "​mdm":<​uint>,​ /​* маска дней месяца */ 
- "​ymm":<​uint>,​ /​* маска месяцев */ 
- "​wdm":<​uint>​ /​* маска дней недели */ 
- }, 
- "​act":​{ /​* действие */ 
- "​t":<​text>,​ /​* тип действия */ 
- "​p":​{ /​* параметры */ 
- <​text>:<​text>,​ 
- ... 
- } 
- } 
- } 
-] 
-</​code>​ 
- 
-При удалении:​ 
-<code javascript>​ 
-[ 
- <​long>,​ /​* ID задания */ 
- null 
-] 
-</​code>​ 
- 
- 
-===== Возможные ошибки ===== 
-^  Код ​ ^ Значение ^ 
-|  1  | недействительная сессия | 
-|  2  | неверное имя сервиса | 
-|  3  | неверный результат | 
-|  4  | неверный формат или значение параметров | 
-|  6  |  - не существует задания с указанным ID\\ - ошибка удаления задания | 
- 
-===== Типы действий ===== 
- * [[#​Выполнить команду над объектом]],​ 
- * [[#Учет GPRS-трафика]],​ 
- * [[#​Изменить права пользователей]],​ 
- * [[#Учет пробега]],​ 
- * [[#Учет моточасов]],​ 
- * [[#​Отправить информацию о топливе по e-mail или SMS]], 
- * [[#​Отправить отчет по e-mail]], 
- * [[#​Назначить на маршрут]],​ 
- * [[#​Удалить маршрут]]. 
- 
-=== Выполнить команду над объектом === 
-<​code=javascript>​ 
-"​act":​{ 
- "​t":"​exec_unit_cmd",​ /​* тип действия */ 
- "​p":​{ 
- "​cmd_name":<​text>,​ /​* имя команды */ 
- "​cmd_param":<​text>,​ /​* параметр команды */ 
- "​link_type":<​text>,​ /​* тип связи */ 
- "​timeout":<​text>,​ /​* время, в течение которого команда будет пытаться выполниться,​ сек */ 
- "​units":<​text>​ /​* список GUIDов объектов (через запятую) */ 
- } 
-} 
-</​code>​ 
- 
-//Типы связи//​ можно посмотреть в разделе [[../​unit/​exec_cmd]]. 
- 
-=== Учет GPRS-трафика === 
- 
-<code javascript>​ 
-"​act":​{ 
- "​t":"​reset_unit_bytes_counter",​ /​* тип действия */ 
- "​p":​{ 
- "​reset_bytes":<​text>,​ /​* сбросить значение счетчика (1 - да, 0 - нет) */ 
- "​store_bytes":<​text>,​ /​* сохранять значение счетчика в истории объекта (1 - да, 0 - нет) */ 
- "​units":<​text>​ /​* список GUIDов объектов (через запятую) */ 
- } 
-} 
-</​code>​ 
- 
-=== Изменить права пользователей === 
- 
-<​code=javascript>​ 
- 
-"​act":​{ 
- "​t":"​change_access_user",​ /​* тип действия */ 
- "​p":​{ 
- "​acc_level":<​text>,​ /​* права доступа */ 
- "​units":<​text>,​ /​* список GUIDов объектов (через запятую) */ 
- "​users":<​text>​ /​* список GUIDов пользователей (через запятую) */ 
- } 
-} 
-</​code>​ 
- 
-Права доступа рассмотрены в разделе [[../​user/​get_items_access]]. 
- 
-=== Учет пробега === 
- 
-<​code=javascript>​ 
-"​act":​{ 
- "​t":"​reset_unit_mileage_counter",​ /​* тип действия */ 
- "​p":​{ 
- "​param_name":<​text>,​ /​* имя параметра,​ если пустое - не сохранять значение счетчика как параметр сообщения с данными у объекта */ 
- "​skip_reset":<​text>,​ /​* установить новое значение для счетчика пробега (0 - да, 1 - нет) */ 
- "​store_mileage":<​text>,​ /​* сохранять значение счетчика в истории событий объекта */ 
- "​units":<​text>,​ /​* список GUIDов объектов (через запятую) */ 
- "​value_mileage":<​text>​ /​* новое значение для счетчика пробега (метров) */ 
- } 
-} 
-</​code>​ 
- 
-=== Учет моточасов === 
- 
-<​code=javascript>​ 
-"​act":​{ 
- "​t":"​reset_unit_engine_hours_counter",​ /​* тип действия */ 
- "​p":​{ 
- "​param_name":<​text>,​ /​* имя параметра */ 
- "​skip_reset":<​text>,​ /​* установить новое значение для счетчика моточасов (0 - да, 1 - нет) */ 
- "​store_eh":<​text>,​ /​* сохранять значение счетчика как параметр сообщения с данными у объекта */ 
- "​units":<​text>,​ /​* список GUIDов объектов (через запятую) */ 
- "​value_eh":<​text>​ /​* новое значение для счетчика моточасов (секунд) */ 
- } 
-} 
-</​code>​ 
- 
-=== Отправить информацию о топливе по e-mail или SMS === 
- 
-<​code=javascript>​ 
-"​act":​{ 
- "​t":"​send_email_sms_fuel",​ /​* тип действия */ 
- "​p":​{ 
- "​email_to":<​text>,​ /​* e-mail адреса через запятую */ 
- "​flags":<​text>,​ /​* флаги (см. ниже) */ 
- "​phone_to":<​text>,​ /​* телефоны */ 
- "​time_offset":<​text>,​ /​* смещение времени,​ мин. */ 
- "​units":<​text>​ /​* список GUIDов объектов (через запятую) */ 
- } 
-} 
-</​code>​ 
- 
-Флаги: 
-^ Значение ^ Описание ^ 
-|  0x01  | Отдельное сообщение для каждого объекта | 
-|  0x02  | Все объекты в одном сообщении | 
-|  0x04  | Тип события:​ Заправка | 
-|  0x08  | Тип события:​ Слив | 
-|  0x10  | Тип события:​ Уровень топлива | 
-|  0x20  | Отправить сообщение по e-mail | 
-|  0x40  | Отправить сообщение по SMS | 
- 
-=== Отправить отчет по e-mail === 
- 
-<​code=javascript>​ 
-"​act":​{ 
- "​t":"​send_email_report",​ /​* тип действия */ 
- "​p":​{ 
- "​email_to":<​text>,​ /​* e-mail адреса через запятую */ 
- "​file_type":<​text>,​ /​* формат файла (см. ниже) */ 
- "​flags":<​text>,​ /​* флаги интервала */ 
- "​pack":<​text>,​ /​* Сжать файлы отчета:​ 0 - нет, 1 - да */ 
- "​params":<​text>,​ /​* конфигурация отчета (xml) */ 
- "​report_guid":<​text>,​ /​* GUID ресурса */ 
- "​report_id":<​text>,​ /​* индекс шаблона отчета */ 
- "​report_objects":<​text>,/​* список GUIDов элементов через запятую */ 
- "​time_from":<​text>,​ /​* начало временного интервала */ 
- "​time_to":<​text>​ /​* конец временного интервала */ 
- } 
-} 
-</​code>​ 
-Флаги интервала рассмотрены в разделе [[../​report/​exec_report#​Параметры|Отчеты:​ Выполнение отчета]]. 
- 
-Форматы файлов:​ 
- * 1 - html; 
- * 2 - pdf; 
- * 4 - xls; 
- * 8 - xlsx; 
- * 16 - xml; 
- * 32 - csv. 
- 
-=== Назначить на маршрут === 
- 
-<​code=javascript>​ 
-"​act":​{ 
- "​t":"​assign_route",​ /​* тип действия */ 
- "​p":​{ 
- "​units":<​text>​ /​* список GUIDов объектов (через запятую) */ 
- "​name":<​text>,​ /​* название */ 
- "​description":<​text>,​ /​* описание */ 
- "​zone":<​text>,​ /​* ID геозоны */ 
- "​flags":<​text>​ /​* флаги маршрута */ 
- } 
-} 
-</​code>​ 
- 
-Флаги маршрута рассмотрены в разделе [[../​resource/​update_route]]. 
- 
-=== Удалить маршрут === 
- 
-<​code=javascript>​ 
-"​act":​{ 
- "​t":"​remove_route",​  
- "​p":​{ 
- "​units":<​text>,​ /​* список GUIDов объектов (через запятую) */ 
- "​finished":<​text>​ /​* удалить только завершенные маршруты:​ 1 - да, 0 - нет */ 
- } 
-} 
- 
-</​code>​ 
Follow us on Facebook Gurtam Wialon Twitter Gurtam Wialon info@gurtam.com   |   Copyright © 2002-2019 Gurtam