API - Список блоков панелей — различия между версиями
Материал из WebHMI Wiki
(Новая страница: «Для получения списка всех панелей необходимо выполнить GET-запрос на URL вида '''http://192.168.1.1/ap…») |
|||
Строка 1: | Строка 1: | ||
− | Для получения списка всех панелей необходимо выполнить GET-запрос на URL вида '''http://192.168.1.1/api/ | + | Для получения списка всех блоков панелей необходимо выполнить GET-запрос на URL вида '''http://192.168.1.1/api/blocks'''. |
− | Для получения информации о | + | Для получения информации о конкретном блоке необходимо выполнить GET-запрос на URL вида '''http://192.168.1.1/api/blocks/12'''. Здесь 12 - это ID нужного блока. |
В заголовках запроса ноебходимо передать API key. Например: | В заголовках запроса ноебходимо передать API key. Например: | ||
Строка 16: | Строка 16: | ||
− | Пример запроса списка | + | Пример запроса списка всех блоков: |
− | '''URL''': http://192.168.1.1/api/ | + | '''URL''': http://192.168.1.1/api/blocks<br> |
'''Method''': GET | '''Method''': GET | ||
Строка 34: | Строка 34: | ||
{ | { | ||
"id": "1", | "id": "1", | ||
− | " | + | "dashboard_id": "1", |
− | " | + | "zindex": "1", |
− | " | + | "pos_left": "0", |
− | " | + | "pos_top": "0", |
+ | "pos_width": "896", | ||
+ | "pos_height": "445", | ||
+ | "block_type": "Indicator", | ||
+ | "title": "Фон", | ||
+ | "url": "", | ||
+ | "imageid": "1", | ||
+ | "label": "", | ||
+ | "align": "", | ||
+ | "fontsize": "", | ||
+ | "regid": "", | ||
+ | "is_button": "false", | ||
+ | "hide_value": "false", | ||
+ | "start_value": "", | ||
+ | "end_value": "", | ||
+ | "colorize": "false" | ||
}, | }, | ||
{ | { | ||
"id": "2", | "id": "2", | ||
− | "title": " | + | "dashboard_id": "1", |
− | " | + | "zindex": "3", |
− | " | + | "pos_left": "714", |
− | " | + | "pos_top": "277", |
+ | "pos_width": "85", | ||
+ | "pos_height": "25", | ||
+ | "block_type": "TextValue", | ||
+ | "title": "", | ||
+ | "url": "", | ||
+ | "imageid": "", | ||
+ | "label": "", | ||
+ | "align": "center", | ||
+ | "fontsize": "4", | ||
+ | "regid": "3", | ||
+ | "is_button": "false", | ||
+ | "hide_value": "false", | ||
+ | "start_value": "", | ||
+ | "end_value": "", | ||
+ | "colorize": "false" | ||
+ | }, | ||
+ | { | ||
+ | "id": "3", | ||
+ | "dashboard_id": "1", | ||
+ | "zindex": "3", | ||
+ | "pos_left": "450", | ||
+ | "pos_top": "277", | ||
+ | "pos_width": "110", | ||
+ | "pos_height": "25", | ||
+ | "block_type": "TextValue", | ||
+ | "title": "", | ||
+ | "url": "", | ||
+ | "imageid": "", | ||
+ | "label": "", | ||
+ | "align": "left", | ||
+ | "fontsize": "4", | ||
+ | "regid": "5", | ||
+ | "is_button": "", | ||
+ | "hide_value": "", | ||
+ | "start_value": "", | ||
+ | "end_value": "" | ||
} | } | ||
] | ] | ||
Строка 51: | Строка 102: | ||
− | Пример запроса информации | + | Пример запроса информации о блоке номер 1: |
− | '''URL''': http://192.168.1.1/api/ | + | '''URL''': http://192.168.1.1/api/blocks/1<br> |
'''Method''': GET | '''Method''': GET | ||
Строка 68: | Строка 119: | ||
{ | { | ||
"id": "1", | "id": "1", | ||
− | " | + | "dashboard_id": "1", |
− | " | + | "zindex": "1", |
− | " | + | "pos_left": "0", |
− | " | + | "pos_top": "0", |
+ | "pos_width": "896", | ||
+ | "pos_height": "445", | ||
+ | "block_type": "Indicator", | ||
+ | "title": "Фон", | ||
+ | "url": "", | ||
+ | "imageid": "1", | ||
+ | "label": "", | ||
+ | "align": "", | ||
+ | "fontsize": "", | ||
+ | "regid": "", | ||
+ | "is_button": "false", | ||
+ | "hide_value": "false", | ||
+ | "start_value": "", | ||
+ | "end_value": "", | ||
+ | "colorize": "false" | ||
} | } | ||
</pre> | </pre> | ||
Строка 77: | Строка 143: | ||
− | Атрибуты | + | Атрибуты блоков: |
<table> | <table> |
Версия 13:57, 31 января 2015
Для получения списка всех блоков панелей необходимо выполнить GET-запрос на URL вида http://192.168.1.1/api/blocks.
Для получения информации о конкретном блоке необходимо выполнить GET-запрос на URL вида http://192.168.1.1/api/blocks/12. Здесь 12 - это ID нужного блока.
В заголовках запроса ноебходимо передать API key. Например:
X-WH-APIKEY: F3C74230818DA487BB2017CE5D0290F4DABCAFD7
Также в заголовках необходимо указать желаемый формат обмена данными. Сейчас поддерживатеся работа только с форматом JSON.
Accept: application/json Content-Type: application/json
Пример запроса списка всех блоков:
URL: http://192.168.1.1/api/blocks
Method: GET
Заголовки:
Accept: application/json Content-Type: application/json Accept-Encoding: gzip, deflate, sdch X-WH-APIKEY:F3C74230818DA487BB2017CE5D0290F4DABCAFD7
Пример ответа:
[ { "id": "1", "dashboard_id": "1", "zindex": "1", "pos_left": "0", "pos_top": "0", "pos_width": "896", "pos_height": "445", "block_type": "Indicator", "title": "Фон", "url": "", "imageid": "1", "label": "", "align": "", "fontsize": "", "regid": "", "is_button": "false", "hide_value": "false", "start_value": "", "end_value": "", "colorize": "false" }, { "id": "2", "dashboard_id": "1", "zindex": "3", "pos_left": "714", "pos_top": "277", "pos_width": "85", "pos_height": "25", "block_type": "TextValue", "title": "", "url": "", "imageid": "", "label": "", "align": "center", "fontsize": "4", "regid": "3", "is_button": "false", "hide_value": "false", "start_value": "", "end_value": "", "colorize": "false" }, { "id": "3", "dashboard_id": "1", "zindex": "3", "pos_left": "450", "pos_top": "277", "pos_width": "110", "pos_height": "25", "block_type": "TextValue", "title": "", "url": "", "imageid": "", "label": "", "align": "left", "fontsize": "4", "regid": "5", "is_button": "", "hide_value": "", "start_value": "", "end_value": "" } ]
Пример запроса информации о блоке номер 1:
URL: http://192.168.1.1/api/blocks/1
Method: GET
Заголовки:
Accept: application/json Content-Type: application/json Accept-Encoding: gzip, deflate, sdch X-WH-APIKEY:F3C74230818DA487BB2017CE5D0290F4DABCAFD7
Пример ответа:
{ "id": "1", "dashboard_id": "1", "zindex": "1", "pos_left": "0", "pos_top": "0", "pos_width": "896", "pos_height": "445", "block_type": "Indicator", "title": "Фон", "url": "", "imageid": "1", "label": "", "align": "", "fontsize": "", "regid": "", "is_button": "false", "hide_value": "false", "start_value": "", "end_value": "", "colorize": "false" }
Атрибуты блоков:
id | int | Уникальный идентификатор панели |
title | string | Название панели |
hide_title | int | 0 = отображать название панели, 1 = спрятать название панели |
width | int | Ширина рабочей области панели в пикселях |
height | int | Высота рабочей области панели в пикселях |