Start a conversation

Schedule

1) schedule/operation/delete

Method - POST

URL - https://.../main-app/schedule/operation/delete

Request parameters

Parameter Type Mandatory field Note
id
Integer Yes Operation ID

2) schedule/operation/get-list

List of operations that can be scheduled.

Method - GET

URL - https://.../main-app/schedule/operation/get-list

Request parameters

Parameter Type Mandatory field Default value Note
onlyAvailable
Boolean No true Accessibility operations filter for scheduling


3) schedule/operation/save

Adding / editing operation that can be scheduled.

Method - POST

URL - https://.../main-app/schedule/operation/save

Request parameters

Parameter Type Mandatory field Default value Note
id
Integer No   If the parameter is passed, the existing operation is searched for and updated, otherwise a new operation is added.
title
String Yes   Operation name
description
String No   Description
executorClass
String Yes   The class that will be instantiated and executed on schedule. The class must be implemented according to the app \ commands \ ScheduleTasks \ TaskInterface interface.
params
String No   Parameters that will be used during execution
isAvailable
Boolean No true The flag that determines the operation availability for inclusion it in the schedule


4) schedule/task/delete

Deleting a task from the schedule.

Method - POST

Request parameters

Parameter Type Mandatory field Note
id
Integer Yes Task ID

5) schedule/task/get-list

List of tasks in the schedule.

Method - GET

Request parameters

Parameter Type Mandatory
field
Default value Note
onlyEnabled
Boolean No true Filter tasks by feature enabled / disabled

6) schedule/task/save

Adding / editing a task that will be executed according to a schedule.
Method - POST

Request parameters

Parameter Type Mandatory field Default value Note
id
Integer No   If the parameter is passed, the existing task is searched for and updated, otherwise a new task is added.
operationId
Integer Yes   Operation ID
periodicity
String Yes   The following values are possible: hourly, daily, weekly, monthly
minutes
Integer Yes   The minute the task will be called for execution
hours
Integer Yes, if periodicity is equal to daily or weekly or monthly
0 The hour the task will be called for execution
weekday
Integer Yes, if periodicity is equal weekly
0 The day of the week the task will be called for execution 0 - monday, 6 - sunday
dayOfMonth
Integer Yes, if periodicity is equal monthly
0 The day of month the task will be called for execution
isEnabled
Boolean No true Task is enabled/disabled
Choose files or drag and drop files
Was this article helpful?
Yes
No
  1. Daria Tsirelnikova

  2. Posted
  3. Updated

Comments