/Methods/GetTasks

<< Click to Display Table of Contents >>

Navigation:  API MasterSCADA 4D > Подключение к исполнительной системе по JSON > HTTP API MasterPLC > Работа со стандартным расписанием >

/Methods/GetTasks

Возвращает события заданного расписания или всех расписаний.

HTTP: POST /Methods/GetTasks

Запрос

{
  "scheduleId": 123,
  "path": "path.To.Item"
}

Поля запроса

Поле

Тип

Обязательное

По умолчанию

Описание

scheduleId

integer

нет

0

Id расписания

path

string

нет

""

Путь к item расписания

При scheduleId: 0 и пустом path возвращаются события всех расписаний.

Ответ

{
  "status": "success",
  "scheduleId": 123,
  "path": "Path.To.Item",
  "tasks": [
    {
      "id": 101,
      "parentId": 0,
      "name": "Generate Daily Report",
      "priority": 1,
      "rrule": "FREQ=DAILY;BYHOUR=8",
      "exdate": ["20250812T080000"],
      "userSettings": { "execute": "weekdays" },
      "enabled": true,
      "startDate": "20250801T080000",
      "endDate": "20250802T080002",
      "lastRun": "20250804T080003",
      "nextRun": "2025-08-06T08:00:00",
      "action": {
        "type": "setParameter",
        "parameter": "Объекты.Насос.Пуск",
        "parameterId": 30818,
        "pulseDuration": 0,
        "value": "false"
      },
      "comment": "Daily report generation",
      "color": "rgba(0,0,0,1)",
      "writeToArchive": false,
      "message": ""
    }
  ],
  "code": 0
}

Поля ответа

Поле

Тип

Условие

Описание

status

string

всегда

"success"

scheduleId

integer

всегда

Эхо запроса

path

string

всегда

Эхо запроса

tasks

array

всегда

События

tasks[].id

integer

в записи

Id события в БД

tasks[].parentId

integer

в записи

Id родительского события (для ряда событий)

tasks[].name

string

в записи

Имя события

tasks[].priority

integer

в записи

Приоритет

tasks[].rrule

string

в записи

Правило повторения (RRULE)

tasks[].exdate

array<string>

в записи

Даты-исключения повторения (iCal-строки)

tasks[].userSettings.execute

string

в записи

"weekdays", "weekends" или ""

tasks[].enabled

bool

в записи

Активность события

tasks[].startDate

string

в записи

Дата начала

tasks[].endDate

string

в записи

Дата окончания

tasks[].lastRun

string

в записи

Последнее срабатывание

tasks[].nextRun

string

в записи

Следующее срабатывание (вычисляется)

tasks[].action.type

string

в записи

Тип действия (setParameter, giveAnImpulse)

tasks[].action.parameter

string

в записи

Путь к параметру

tasks[].action.parameterId

integer

в записи

Идентификатор параметра HMI

tasks[].action.pulseDuration

integer

в записи

Длительность импульса, мс

tasks[].action.value

string

в записи

Значение для параметра (строкой)

tasks[].comment

string

в записи

Комментарий

tasks[].color

string

в записи

Цвет события в HMI

tasks[].writeToArchive

bool

в записи

Писать срабатывания в архив

tasks[].message

string

в записи

Сообщение события

code

integer

всегда

Результат метода

Поведение и ограничения

action.value — строка (в старой справке — булево). Для type: "giveAnImpulse" значение всегда "true".

Поля parameterId, writeToArchive, message и exdate события в старой справке отсутствовали; поле fullPath внутри события не возвращается.