Платформа 3V/Планировщик/Настройки задач: различия между версиями

Материал из 3v-wiki
Перейти к навигации Перейти к поиску
Строка 24: Строка 24:
  
 
== Метод AddNewTask ==
 
== Метод AddNewTask ==
 +
Добавляет новую задачу в планировщик, возвращает идентификатор добавленных настроек.<br>
 +
Параметры:
 +
*'''task''' - описание запланированной задачи.
 +
 +
Описание запланированной задачи - JSON вида:
 +
<syntaxhighlight lang="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"
 +
}
 +
</syntaxhighlight>
 +
*'''runUrl''' - настройки Url для запуска задачи.
 +
*'''checkStateUrl''' -  настройки Url для проверки состояния задачи.
 +
*'''schedule''' - расписание задачи.
 +
*'''isEnable''' - признак включенности задачи, '''true''' - задача включена и будет обрабатываться планировщиком.
 +
*'''authenticationSettingsId''' - идентификатор [[Настройки аутентификации|настроек аутентификации]].
 +
*'''id''' - идентификатор задачи.
 +
*'''name''' - наименование задачи.
 +
*'''discriminator''' - тип задачи ([[ScheduledTask]]/[[CalcScheduledTask]]).
  
 
== Метод EditTask ==
 
== Метод EditTask ==

Версия 13:37, 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

Метод RemoveTask

Метод GetTask

Метод EnableTask

Метод ResetTask

Метод GetTaskExample

Метод GetCalcTaskExample

Источник — https://wiki.3v-group.net/index.php?title=Платформа_3V/Планировщик/Настройки_задач&oldid=100