Работа со стандартным расписанием

<< Click to Display Table of Contents >>

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

Работа со стандартным расписанием

Методы этого раздела читают и изменяют стандартные расписания и их события (задачи), а также даты-исключения рабочих/выходных дней.

Общий контракт

Все методы вызываются POST-запросом с JSON-объектом в теле.

Обработчики раздела не проверяют сессию и права; поле sessionId в теле не читается.

serverTime в ответ не добавляется.

Каждый ответ содержит собственные поля status ("success" или "error") и обычно message, а также инфраструктурное поле code (0 при успехе).

Прикладной результат возвращается с HTTP-статусом 200, в том числе при ненулевом code.

При ошибке метод пишет status: "error" и message, возвращает соответствующий OPC UA код, а оболочка core/mplcshare добавляет hex и codeDescription. Список кодов — в формате запросов и ответов.

Расписание адресуется парой scheduleId (числовой id item в VMInfo) и path (путь к item внутри экземпляра объекта). Многие методы допускают scheduleId: 0 и path: "" для работы со всеми расписаниями.

Общие поля ответа:

Поле

Когда присутствует

Описание

status

всегда

"success" или "error"

message

все методы, кроме GetSchedules/GetScheduleInfo/GetTasks/GetExceptionDates при успехе

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

code

всегда

Числовой прикладной результат; 0 означает успех

hex

code0

Код в шестнадцатеричном виде

codeDescription

code — ошибочный OPC UA status

Локализованное описание кода

Форматы дат: startDate, endDate, lastRun и элементы exdate — строки iCal (YYYYMMDDThhmmss); nextRun — вычисляемая строка даты-времени; date в датах-исключениях — строка YYYY-MM-DD.