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

Для настроек задач в сервисе планировщика имеется отдельный раздел Scheduler.
Перед настройкой задач не забудьте авторизоваться в планировщике

Метод GetAllTasks

Данный метод возвращает описания всех задач, которые есть в планировщике.
Для получения описания всех задач следует открыть вкладку /api/Scheduler/GetAllTasks в разделе Scheduler и нажать кнопку "Try it out", затем нажать на кнопку "Execute". После чего в "Response body" вы увидите описание всех задач планировщика.

Метод GetSchedulerTime

Возвращает время планировщика. Используется при настройке задач, возможно будет переход на UTC. Для получения информации о времени планировщика следует открыть вкладку /api/Scheduler/GetSchedulerTime в разделе Scheduler и нажать кнопку "Try it out", а далее нажать на кнопку "Execute". После чего в "Response body" вы увидите время планировщика.

Результат представляет собой JSON вида:

{
	"hours": 12,
	"minutes": 34
}

• hours - компонент часа времени планировщика.
• minutes - компонент минут времени планировщика.

Метод RunTask

Принудительно запускает задачу по идентификатору, даже если она выключена или текущий момент не удовлетворяет её расписанию. Для принудительного запуска задачи следует открыть вкладку /api/Scheduler/RunTask в разделе Scheduler и нажать кнопку "Try it out", далее вписать идентификатор задачи в поле "Идентификатор задачи" и нажать на кнопку "Execute". После чего в "Response body" вы увидите информацию об успешном запуске задаче или ошибку.
Параметры:

• id - идентификатор задачи.

Если Вы не знаете идентификатор задачи Вы можете воспользоваться методом /api/Scheduler/GetAllTasks и найти задачу в списке задач.

Метод AddNewTask

Добавляет новую задачу в планировщик, возвращает идентификатор добавленных настроек. Для добавления новой задачи следует открыть вкладку /api/Scheduler/AddNewTask в разделе Scheduler и нажать кнопку "Try it out", далее добавить описание задачи по шаблону в окне "Описание запланированной задачи" и нажать на кнопку "Execute". После чего в "Response body" вы увидите идентификатор задачи, если добавление прошло успешно или сообщение об ошибке если что-то пошло не так.

Параметры:

• 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

Обновляет существующую задачу по идентификатору.
Для изменения существующей задачи следует открыть вкладку /api/Scheduler/EditTask в разделе Scheduler и нажать кнопку "Try it out", далее в поле "Идентификатор существующей задачи" ввести идентификатор задачи которую вы хотите изменить, добавить новое описание задачи по шаблону в окне "Описание запланированной задачи" и нажать на кнопку "Execute". После чего в "Response body" вы увидите идентификатор задачи, если добавление прошло успешно или сообщение об ошибке если что-то пошло не так.

Параметры:

• id - идентификатор задачи.
• task - описание запланированной задачи.

Описание запланированной задачи - JSON, см. Метод AddNewTask

Метод RemoveTask

Удаляет существующую задачу по идентификатору.
Для удаления существующей задачи следует открыть вкладку /api/Scheduler/RemoveTask в разделе Scheduler и нажать кнопку "Try it out", далее в поле "Идентификатор задачи." ввести идентификатор задачи которую вы хотите удалить и нажать на кнопку "Execute". После чего в "Response body" вы увидите сообщение если удаление прошло успешно или сообщение об ошибке если что-то пошло не так.

Параметры:

• id - идентификатор задачи.

Метод GetTask

Возвращает описание существующей задачи по идентификатору.
Для получения описания существующей задачи следует открыть вкладку /api/Scheduler/GetTask в разделе Scheduler и нажать кнопку "Try it out", далее в поле "Идентификатор задачи." ввести идентификатор задачи описание которой вы хотите получить и нажать на кнопку "Execute". После чего в "Response body" вы увидите описание задачи или сообщение об ошибке если что-то пошло не так.

Параметры:

• id - идентификатор задачи.

Описание существующей задачи - JSON, см. Метод AddNewTask

Метод EnableTask

Включает/выключает выполнение задачи в планировщике по идентификатору.
Для включения/выключения существующей задачи следует открыть вкладку /api/Scheduler/EnableTask в разделе Scheduler и нажать кнопку "Try it out", далее в поле "Идентификатор задачи." ввести идентификатор задачи которую вы хотите включить/выключить, далее заполнить поле "isEnable" и нажать на кнопку "Execute". После чего в "Response body" вы увтдете ******* или сообщение об ошибке если что-то пошло не так.

Параметры:

• id - идентификатор задачи.
• isEnable - Признак включения. true - задача будет включена, false - задача будет выключена

Метод ResetTask

Сбрасывает состояние выполнения задачи (последний запуск и количество).
Параметры:

• id - идентификатор задачи.

Метод GetTaskExample

Возвращает пример описания задачи, которая совершает post-запрос с параметрами в теле запроса.

Описание запланированной задачи - JSON, см. Метод AddNewTask

Метод GetCalcTaskExample

Возвращает пример описания задачи расчета методики с параметрами.

Описание запланированной задачи - JSON, см. Метод AddNewTask