Платформа 3V/Планировщик/Настройки задач: различия между версиями
Строка 101: | Строка 101: | ||
== Метод EnableTask == | == Метод EnableTask == | ||
+ | Включает/выключает выполнение задачи в планировщике по идентификатору.<br> | ||
+ | Параметры: | ||
+ | *'''id''' - идентификатор задачи. | ||
+ | *'''isEnable''' - Признак включения. '''true''' - задача будет включена, '''false''' - задача будет выключена | ||
== Метод ResetTask == | == Метод ResetTask == |
Версия 13:45, 7 октября 2020
Для настроек задач в сервисе планировщика имеется отдельный контроллер Scheduler
Содержание
Метод GetAllTasks
Возвращает описания всех задач, которые есть в планировщике.
Метод GetSchedulerTime
Возвращает время планировщика. Используется при настройке задач, возможно будет переход на UTC. Результат представляет собой JSON вида:
{
"hours": 12,
"minutes": 34
}
- hours - компонент часа времени планировщика.
- minutes - компонент минут времени планировщика.
Метод RunTask
Принудительно запускает задачу по идентификатору, даже если она выключена или текущий момент не удовлетворяет её расписанию.
Параметры:
- id - идентификатор задачи.
Метод AddNewTask
Добавляет новую задачу в планировщик, возвращает идентификатор добавленных настроек.
Параметры:
- task - описание запланированной задачи.
Описание запланированной задачи - JSON вида:
{
"runUrl": {
"parameters": [
{
"options": {
"dictionaryId": 8376
},
"value": [
2,
3
],
"isMultiselect": true,
"id": 1,
"discriminator": "DictionaryParameterDto"
}
],
"type": "Post",
"url": "http://engine/api/Calculation/8380",
"headers": [],
"discriminator": "CalcWithParamsTaskUrlDto"
},
"checkStateUrl": null,
"schedule": {
"timeSpan": "00:02:00",
"period": {
"times": 2,
"discriminator": "ManyTimesDto"
},
"runTime": {
"hours": 10,
"minutes": 58
},
"discriminator": "TimerScheduleDto"
},
"isEnable": true,
"authenticationSettingsId": 1,
"id": 1,
"name": "calc_example",
"discriminator": "CalcScheduledTaskDto"
}
- runUrl - настройки Url для запуска задачи.
- checkStateUrl - настройки Url для проверки состояния задачи.
- schedule - расписание задачи.
- isEnable - признак включенности задачи, true - задача включена и будет обрабатываться планировщиком.
- authenticationSettingsId - идентификатор настроек аутентификации.
- id - идентификатор задачи.
- name - наименование задачи.
- discriminator - тип задачи (ScheduledTask/CalcScheduledTask).
Метод EditTask
Обновляет существующую задачу по идентификатору.
Параметры:
- id - идентификатор задачи.
- task - описание запланированной задачи.
Описание запланированной задачи - JSON, см. Метод AddNewTask
Метод RemoveTask
Удаляет существующую задачу по идентификатору.
Параметры:
- id - идентификатор задачи.
Метод GetTask
Возвращает описание существующей задачи по идентификатору.
Параметры:
- id - идентификатор задачи.
Описание существующей задачи - JSON, см. Метод AddNewTask
Метод EnableTask
Включает/выключает выполнение задачи в планировщике по идентификатору.
Параметры:
- id - идентификатор задачи.
- isEnable - Признак включения. true - задача будет включена, false - задача будет выключена