|
<< Click to Display Table of Contents >> Navigation: API MasterSCADA 4D > Подключение к исполнительной системе по JSON > HTTP API MasterPLC > Общие методы > /Methods/GetState |
Возвращает состояние сервера и, если передан действующий sessionId, сведения о сессии. Предназначен для периодического опроса связи с сервером.
HTTP: POST /Methods/GetState
{ "sessionId": 1234 }
Поле |
Тип |
Обязательное |
По умолчанию |
Описание |
|---|---|---|---|---|
sessionId |
integer |
нет |
0 |
Идентификатор сессии; при действующей сессии в ответ добавляются её поля |
{
"projectId": "b1f0…",
"projectVersion": 12,
"projectSessionId": 3,
"isMaster": true,
"status": 20,
"features": 0,
"currentOperator": "sa",
"sessionId": 319824816,
"user": "sa",
"fullName": "",
"clientAddress": "127.0.0.1",
"hostName": "",
"sessionExpireTime": 0,
"sessionIdleTime": 0,
"currentShift": { "ShiftName": "", "WorkDays": 0, "StartTime": 0, "EndTime": 0 },
"code": 0
}
Поля состояния сервера и сессии — см. общий контракт. Дополнительно:
Поле |
Тип |
Условие |
Описание |
|---|---|---|---|
currentOperator |
string |
всегда |
Логин оператора действующей сессии либо пустая строка (устаревшее поле, помечено на удаление) |
поля блока сессии |
— |
передан действующий sessionId |
См. общий контракт |
code |
integer |
всегда |
Состояние проекта |
•code отражает состояние проекта, а не сессии: OpcUa_Good — проект запущен; OpcUa_BadShutdown — идёт перезагрузка; OpcUa_BadServiceUnsupported — визуализация недоступна (текст в errorText). Недействительный sessionId не меняет code (вопреки старой справке) — при нём лишь не заполняются поля сессии, а currentOperator пуст.