/Methods/GetScheduleInfo

<< Click to Display Table of Contents >>

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

/Methods/GetScheduleInfo

Возвращает флаги активности одного расписания; предназначен для периодического опроса.

HTTP: POST /Methods/GetScheduleInfo

Запрос

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

Поля запроса

Поле

Тип

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

По умолчанию

Описание

scheduleId

integer

нет

0

Id расписания

path

string

нет

""

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

Ответ

{
  "status": "success",
  "scheduleId": 123,
  "path": "Path.To.Item",
  "enabled_hmi": true,
  "enabled_fb": false,
  "locked": true,
  "code": 0
}

Ответ при ошибке

{
  "status": "error",
  "message": "Invalid request value",
  "code": 2147745792
}

Поля ответа

Поле

Тип

Условие

Описание

status

string

всегда

"success" или "error"

scheduleId

integer

успех

Эхо запроса

path

string

успех

Эхо запроса

enabled_hmi

bool

успех

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

enabled_fb

bool

успех

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

locked

bool

успех

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

message

string

ошибка

Текст ошибки

code

integer

всегда

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

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

Если расписание не найдено (менеджер вернул OpcUa_Bad), метод возвращает OpcUa_BadInvalidArgument и message: "Invalid request value".