API - Список событий
Материал из WebHMI Wiki
Версия от 11:55, 31 января 2015; Alexander.kuzmuk (обсуждение | вклад) (Новая страница: «Для получения списка всех событий необходимо выполнить GET-запрос на URL вида '''http://192.168.1.1/ap…»)
Для получения списка всех событий необходимо выполнить GET-запрос на URL вида http://192.168.1.1/api/events.
Для получения информации о конкретном событии необходимо выполнить GET-запрос на URL вида http://192.168.1.1/api/events/1. Здесь 1 - это ID нужного события.
В заголовках запроса необходимо передать API key. Например:
X-WH-APIKEY: F3C74230818DA487BB2017CE5D0290F4DABCAFD7
Также в заголовках необходимо указать желаемый формат обмена данными. Сейчас поддерживатеся работа только с форматом JSON.
Accept: application/json Content-Type: application/json
Пример запроса списка всех событий:
URL: http://192.168.1.1/api/events
Method: GET
Заголовки:
Accept: application/json Content-Type: application/json Accept-Encoding: gzip, deflate, sdch X-WH-APIKEY: F3C74230818DA487BB2017CE5D0290F4DABCAFD7
Пример ответа:
[ { "id": "2", "title": "Интервал", "hasDuration": "1", "start": "<xml xmlns=\"http://www.w3.org/1999/xhtml\"><block type=\"wh_rules\" id=\"1\" inline=\"false\" deletable=\"false\" x=\"-499\" y=\"14\"><value name=\"IF\"><block type=\"logic_compare\" id=\"2\" inline=\"true\"><field name=\"OP\">EQ</field><value name=\"A\"><block type=\"wh_reg\" id=\"3\"><field name=\"REG\">8</field></block></value><value name=\"B\"><block type=\"math_number\" id=\"4\"><field name=\"NUM\">5</field></block></value></block></value></block></xml>", "end": "<xml xmlns=\"http://www.w3.org/1999/xhtml\"><block type=\"wh_rules\" id=\"1\" inline=\"false\" deletable=\"false\" x=\"-596\" y=\"16\"><value name=\"IF\"><block type=\"logic_compare\" id=\"2\" inline=\"true\"><field name=\"OP\">EQ</field><value name=\"A\"><block type=\"wh_reg\" id=\"3\"><field name=\"REG\">8</field></block></value><value name=\"B\"><block type=\"math_number\" id=\"4\"><field name=\"NUM\">10</field></block></value></block></value></block></xml>", "hasEndCondition": "1", "saveToLog": "1", "report_title": "Отчет \"интервал\"", "report_menu_title": "Интервал", "extra_regs": "-1^last^^Y-m-d H:i:s|2^last^^Y-m-d H:i:s", "color": "#ff0000", "savetologtype": "0", "loginterval": "", "parentid": "0", "showontimeline": "0", "description": "" }, { "id": "3", "title": "Нажата кнопка А", "hasDuration": "1", "start": "<xml xmlns=\"http://www.w3.org/1999/xhtml\"><block type=\"wh_rules\" id=\"1\" inline=\"false\" deletable=\"false\" x=\"-613\" y=\"10\"><value name=\"IF\"><block type=\"logic_compare\" id=\"2\" inline=\"true\"><field name=\"OP\">EQ</field><value name=\"A\"><block type=\"wh_reg\" id=\"4\"><field name=\"REG\">2</field></block></value><value name=\"B\"><block type=\"math_number\" id=\"11\"><field name=\"NUM\">1</field></block></value></block></value></block></xml>", "end": "<xml xmlns=\"http://www.w3.org/1999/xhtml\"><block type=\"wh_rules\" id=\"1\" inline=\"false\" deletable=\"false\" x=\"10\" y=\"10\"><value name=\"IF\"><block type=\"logic_compare\" id=\"2\" inline=\"true\"><field name=\"OP\">EQ</field></block></value></block></xml>", "hasEndCondition": "0", "saveToLog": "1", "report_title": "Нажатие кнопки А", "report_menu_title": "Кнопка А", "extra_regs": "-1^last^^Y-m-d H:i:s|-2^last^^Y-m-d H:i:s", "color": "#0084ff", "savetologtype": "0", "loginterval": "", "parentid": "0", "showontimeline": "1", "description": "Событие срабатывает при нажатии на кнопку А" } ]
Пример запроса информации о событии номер 2:
URL: http://192.168.1.1/api/events/2
Method: GET
Заголовки:
Accept: application/json Content-Type: application/json Accept-Encoding: gzip, deflate, sdch X-WH-APIKEY: F3C74230818DA487BB2017CE5D0290F4DABCAFD7
Пример ответа:
{ "id": "2", "title": "Интервал", "hasDuration": "1", "start": "<xml xmlns=\"http://www.w3.org/1999/xhtml\"><block type=\"wh_rules\" id=\"1\" inline=\"false\" deletable=\"false\" x=\"-499\" y=\"14\"><value name=\"IF\"><block type=\"logic_compare\" id=\"2\" inline=\"true\"><field name=\"OP\">EQ</field><value name=\"A\"><block type=\"wh_reg\" id=\"3\"><field name=\"REG\">8</field></block></value><value name=\"B\"><block type=\"math_number\" id=\"4\"><field name=\"NUM\">5</field></block></value></block></value></block></xml>", "end": "<xml xmlns=\"http://www.w3.org/1999/xhtml\"><block type=\"wh_rules\" id=\"1\" inline=\"false\" deletable=\"false\" x=\"-596\" y=\"16\"><value name=\"IF\"><block type=\"logic_compare\" id=\"2\" inline=\"true\"><field name=\"OP\">EQ</field><value name=\"A\"><block type=\"wh_reg\" id=\"3\"><field name=\"REG\">8</field></block></value><value name=\"B\"><block type=\"math_number\" id=\"4\"><field name=\"NUM\">10</field></block></value></block></value></block></xml>", "hasEndCondition": "1", "saveToLog": "1", "report_title": "Отчет \"интервал\"", "report_menu_title": "Интервал", "extra_regs": "-1^last^^Y-m-d H:i:s|2^last^^Y-m-d H:i:s", "color": "#ff0000", "savetologtype": "0", "loginterval": "", "parentid": "0", "showontimeline": "0", "description": "" }
Атрибуты события:
id | int | Уникальный идентификатор тренда |
title | string | Название тренда |
regsid | string | Список идентификаторов регистров которые необходимо отображать на тренде. Регистры разделены запятыми. |
height | int | Высота тренда в пикселях |
min_val | double | Минимальное значение оси Y |
max_val | double | Максимальное значение оси Y |