/Methods/GetSchedules

<< Click to Display Table of Contents >>

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

/Methods/GetSchedules

Возвращает список расписаний: всех либо принадлежащих объекту, заданному itemId/path.

HTTP: POST /Methods/GetSchedules

Запрос

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

Поля запроса

Поле

Тип

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

По умолчанию

Описание

itemId

integer

нет

0

Идентификатор объекта, чьи расписания нужны

path

string

нет

""

Путь к itemId

При itemId: 0 и пустом path возвращаются все расписания.

Ответ

{
  "status": "success",
  "itemId": 123,
  "path": "path.To.Item",
  "schedules": [
    {
      "scheduleId": 1,
      "path": "path",
      "fullPath": "fullPath",
      "name": "Daily Reports",
      "description": "Schedule for generating daily reports",
      "enabled_hmi": true,
      "enabled_fb": false,
      "locked": true
    }
  ],
  "code": 0
}

Поля ответа

Поле

Тип

Условие

Описание

status

string

всегда

"success"

itemId

integer

всегда

Эхо запроса

path

string

всегда

Эхо запроса

schedules

array

всегда

Список расписаний

schedules[].scheduleId

integer

в записи

Id item расписания в VMInfo

schedules[].path

string

в записи

Путь к item расписания внутри экземпляра объекта

schedules[].fullPath

string

в записи

Полный путь к item расписания

schedules[].name

string

в записи

Имя расписания

schedules[].description

string

в записи

Описание

schedules[].enabled_hmi

bool

в записи

Активность из HMI

schedules[].enabled_fb

bool

в записи

Активность из ScheduleFB

schedules[].locked

bool

в записи

Состояние «замочка» в HMI

code

integer

всегда

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