/Methods/SetScheduleState

<< Click to Display Table of Contents >>

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

/Methods/SetScheduleState

Включает или выключает расписание из HMI. При закрытии «замочка» активность берётся из ФБ и возвращается клиенту.

HTTP: POST /Methods/SetScheduleState

Запрос

{
  "scheduleId": 123,
  "path": "path.To.Item",
  "enabled": false,
  "locked": true
}

Поля запроса

Поле

Тип

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

По умолчанию

Описание

scheduleId

integer

условно

0

Id расписания; обязателен, если path пуст

path

string

условно

""

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

enabled

bool

нет

false

Активность расписания

locked

bool

нет

false

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

Ответ

{
  "status": "success",
  "message": "Schedule state updated successfully",
  "enabled_fb": true,
  "code": 0
}

Поля ответа

Поле

Тип

Условие

Описание

status

string

всегда

"success" или "error"

message

string

всегда

Текст результата или ошибки

enabled_fb

bool

успех

Активность расписания по данным ФБ

code

integer

всегда

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

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

Пустые scheduleId и path"Schedule ID is required" (OpcUa_BadInvalidArgument).

Сбой обновления в менеджере — message: "Failed to update schedule state" и OpcUa_BadInternalError.