get_job_data
Функция get_job_data используется для получения подробной информации об указанных заданиях.
svc=resource/get_job_data¶ms={"itemId":<long>,
"col":[<long>]}
Параметры
Название | Описание |
---|---|
itemId | ID ресурса. |
col | Массив ID заданий. Необязательное поле. Если его нет, функция выполняется для всех заданий. |
Возвращаемый результат
[
{
"id":<long>, /* ID задания */
"n":"<text>", /* имя */
"d":"<text>", /* описание */
"r":"<text>", /* тип выполнения (см. ниже) */
"at":<uint>, /* время активации */
"m":<uint>, /* максимальное количество выполнений, 0 — неограниченное количество */
"fl":<uint>, /* удалить задание при достижении максимального количества выполнений, 1 — да */
"tz":<int>, /* временнáя зона, сек. */
"l":"<text>", /* язык, используемый для задания */
"st":{ /* состояние */
"e":<int>, /* включено/отключено */
"c":<uint>, /* количество выполнений */
"l":<uint> /* время последнего выполнения */
},
"sch":{ /* ограничение по времени */
"f1":<uint>, /* начало интервала 1 */
"f2":<uint>, /* начало интервала 2 */
"t1":<uint>, /* конец интервала 1 */
"t2":<uint>, /* конец интервала 2 */
"m":<uint>, /* маска дней месяца */
"y":<uint>, /* маска месяцев */
"w":<uint>, /* маска дней недели */
"fl":<int> /* флаги расписания */
},
"act":{ /* действия (см. список действий ниже) */
"t":"<text>", /* тип */
"p":{ /* параметры */
"<text>":"<text>", /* имя: значение */
...
}
},
"ct":<uint>, /* время создания */
"mt":<uint> /* время последнего изменения */
}
]
Доступно два типа выполнения:
- Составьте подробный список выполнений в соответствии с точным графиком. В таком случае, формат поля r — «1 …», где после 1 должно быть указано время выполнения. Если выполнений должно быть несколько, укажите их время через пробел. Формат времени — «часы:минуты» или «часы».
- Установите интервал между выполнениями заданий. Если необходимо использовать определенный интервал, то формат поля r — «2 …», где после 2 в формате Unix необходимо указать интервал, после которого задание должно выполняться повторно.
Типы действий
Для заданий доступны следующие типы действий:
- Отправить команду на объекты;
- Изменить доступ к объектам;
- Отправить отчет по email;
- Отправить информацию о топливе по email или SMS;
- Учет пробега;
- Учет моточасов;
- Учет GPRS-трафика.
Отправить команду на объекты
"act":{
"t":"exec_unit_cmd", /* тип действия */
"p":{
"cmd_name":"<text>", /* имя команды */
"cmd_type":"<text>", /* тип команды */
"cmd_param":"<text>", /* параметр команды */
"link_type":"<text>", /* тип связи */
"timeout":"<text>", /* время, в течение которого команда должна быть выполнена, сек. */
"units":"<text>" /* список ID объектов/групп объектов (через запятую) */
}
}
Список доступных типов команд можно найти здесь.
Изменить доступ к объектам
"act":{
"t":"change_access_user", /* тип действия */
"p":{
"acl_bits":"<text>", /* 1 — установить бит, 0 — снять бит */
"acl_mask":"<text>", /* маски битов, которые должны быть изменены */
"units":"<text>", /* список ID объектов/групп объектов (через запятую) */
"users":"<text>" /* список ID пользователей (через запятую) */
}
}
Отправить отчет по email
"act":{
"t":"send_email_report", /* тип действия */
"p":{
"email_to":"<text>", /* список электронных адресов (через запятую) */
"file_type":"<text>", /* формат файла */
"flags":"<text>", /* флаги интервалов */
"params":"<text>", /* конфигурация отчета (XML) */
"report_guid":"<text>", /* ID ресурса */
"report_id":"<text>", /* ID шаблона отчета */
"report_objects":"<text>",/* список ID объектов (через запятую) */
"time_from":"<text>", /* начало временнóго интервала */
"time_to":"<text>" /* конец временнóго интервала */
}
}
Флаги интервалов описаны здесь.
Форматы файлов (содержимое ZIP-архива):
- 1 — HTML;
- 2 — PDF;
- 4 — XLS;
- 8 — XLSX;
- 16 — XML;
- 32 — CSV.
Отправить информацию о топливе по email или SMS
"act":{
"t":"send_email_sms_fuel", /* тип действия */
"p":{
"email_to":"<text>", /* список электронных адресов (через запятую) */
"flags":"<text>", /* флаги (см. ниже) */
"phone_to":"<text>", /* телефонные номера */
"time_offset":"<text>", /* временнóе смещение, мин. */
"units":"<text>" /* список ID объектов/групп объектов (через запятую) */
}
}
Флаги:
Значение | Описание |
---|---|
0x01 | Отдельное сообщение для каждого объекта. |
0x02 | Все объекты в одном сообщении. |
0x04 | Тип события: заправка. |
0x08 | Тип события: слив. |
0x10 | Тип события: уровень топлива. |
0x20 | Способ отправки: email. |
0x40 | Способ отправки: SMS. |
Учет пробега
"act":{
"t":"reset_unit_mileage_counter", /* тип действия */
"p":{
"param_name":"<text>", /* имя параметра; если поле пустое, значение счетчика не сохраняется в качестве параметра сообщения с данными объекта */
"skip_reset":"<text>", /* установить новое значение для счетчика пробега (0 — да, 1 — нет) */
"store_mileage":"<text>", /* сохранить значение счетчика в истории объекта */
"units":"<text>", /* список ID объектов/групп объектов (через запятую) */
"value_mileage":"<text>" /* новое значение счетчика пробега, м */
}
}
Учет моточасов
"act":{
"t":"reset_unit_engine_hours_counter", /* тип действия */
"p":{
"param_name":"<text>", /* имя параметра; если поле пустое, значение счетчика не сохраняется в качестве параметра сообщения с данными объекта */
"skip_reset":"<text>", /* установить новое значение для моточасов (0 — да, 1 — нет) */
"store_eh":"<text>", /* сохранить значение счетчика в истории объекта */
"units":"<text>", /* список ID объектов/групп объектов (через запятую) */
"value_eh":"<text>" /* новое значение моточасов, сек. */
}
}
Учет GPRS-трафика
"act":{
"t":"reset_unit_bytes_counter", /* тип действия */
"p":{
"reset_bytes":"<text>", /* сбросить значение счетчика (1 — да, 2 — нет) */
"store_bytes":"<text>", /* сохранить значение счетчика в истории объекта (1 — да, 0 — нет) */
"units":"<text>" /* список ID объектов/групп объектов (через запятую) */
}
}
Возможные коды ошибок:
Код | Описание |
---|---|
7 | Не удалось извлечь ресурс с требуемым ACL (ADF_ACL_AVL_RES_VIEW_JOBS). |
4 | Неверные входные параметры. |