|
<< Click to Display Table of Contents >> Navigation: API MasterSCADA 4D > Подключение к исполнительной системе по JSON > HTTP API MasterPLC > Работа со стандартным расписанием > /Methods/AddTask |
Добавляет событие в расписание.
HTTP: POST /Methods/AddTask
{
"scheduleId": 1,
"schedulePath": "Schedule.Path",
"scheduleFullPath": "Schedule.Full.Path",
"parentId": 0,
"name": "New Task",
"priority": 2,
"rrule": "FREQ=HOURLY;INTERVAL=2",
"exdate": ["20250812T080000", "20250814T080000"],
"userSettings": { "execute": "weekends" },
"enabled": true,
"startDate": "20250810T080000",
"endDate": "20250820T080000",
"comment": "Test task",
"action": {
"type": "giveAnImpulse",
"parameter": "Объекты.Насос.Пуск",
"parameterId": 30818,
"pulseDuration": 1000,
"value": "true"
},
"color": "rgb(0,0,0)",
"writeToArchive": false,
"message": ""
}
Поле |
Тип |
Обязательное |
По умолчанию |
Описание |
|---|---|---|---|---|
scheduleId |
integer |
условно |
0 |
Id item расписания; обязателен, если schedulePath пуст |
schedulePath |
string |
условно |
"" |
Путь к item расписания внутри экземпляра объекта |
scheduleFullPath |
string |
нет |
"" |
Полный путь к item расписания |
parentId |
integer |
нет |
0 |
Id родительского события (для ряда событий) |
name |
string |
нет |
"" |
Имя события |
priority |
integer |
нет |
0 |
Приоритет |
rrule |
string |
да |
"" |
Правило повторения (RRULE); не должно быть пустым |
exdate |
array<string> |
нет |
[] |
Даты-исключения (iCal-строки) |
userSettings.execute |
string |
нет |
"" |
"weekdays" или "weekends" |
enabled |
bool |
нет |
true |
Активность события |
startDate |
string |
нет |
"" |
Дата начала |
endDate |
string |
нет |
"" |
Дата окончания |
comment |
string |
нет |
"" |
Комментарий |
color |
string |
нет |
"" |
Цвет события в HMI |
writeToArchive |
bool |
нет |
false |
Писать срабатывания в архив |
message |
string |
нет |
"" |
Сообщение события |
action.type |
string |
нет |
"" |
setParameter или giveAnImpulse |
action.parameter |
string |
нет |
"" |
Путь к параметру (используется для поиска item) |
action.parameterId |
integer |
нет |
0 |
Идентификатор параметра HMI |
action.pulseDuration |
integer |
нет |
0 |
Длительность импульса, мс (только для giveAnImpulse) |
action.value |
string |
нет |
"" |
Значение параметра (строкой); для giveAnImpulse принудительно "true" |
{
"status": "success",
"message": "Task added successfully",
"taskId": 105,
"code": 0
}
Поле |
Тип |
Условие |
Описание |
|---|---|---|---|
status |
string |
всегда |
"success" или "error" |
message |
string |
всегда |
Текст результата или ошибки |
taskId |
integer |
успех |
Id добавленного события в БД |
code |
integer |
всегда |
Результат метода |
•Ключи расписания — schedulePath и scheduleFullPath (не path/fullPath).
•Ошибки (все с OpcUa_BadInvalidArgument, кроме последней): пустые scheduleId и schedulePath — "Schedule ID is required"; пустой rrule — "RRule is empty"; параметр действия не найден — "Parameter not found". Сбой добавления в менеджере — "Error adding task" (OpcUa_Bad).