API - Список графиков
Материал из WebHMI Wiki
Версия от 10:57, 31 января 2015; Alexander.kuzmuk (обсуждение | вклад) (Новая страница: «Для получения списка всех графиков необходимо выполнить GET-запрос на URL вида '''http://192.168.1.1/…»)
Для получения списка всех графиков необходимо выполнить GET-запрос на URL вида http://192.168.1.1/api/graphs.
Для получения информации о конкретном графике необходимо выполнить GET-запрос на URL вида http://192.168.1.1/api/graphs/1. Здесь 1 - это ID нужного графика.
В заголовках запроса необходимо передать API key. Например:
X-WH-APIKEY: F3C74230818DA487BB2017CE5D0290F4DABCAFD7
Также в заголовках необходимо указать желаемый формат обмена данными. Сейчас поддерживатеся работа только с форматом JSON.
Accept: application/json Content-Type: application/json
Пример запроса списка всех графиков:
URL: http://192.168.1.1/api/graphs
Method: GET
Заголовки:
Accept: application/json Content-Type: application/json Accept-Encoding: gzip, deflate, sdch X-WH-APIKEY: F3C74230818DA487BB2017CE5D0290F4DABCAFD7
Пример ответа:
[ { "id": "1", "regsid": "10,11", "title": "Горелка 1 и 2", "height": "350", "min_val": "0", "max_val": "" }, { "id": "2", "regsid": "8", "title": "Температура в печи", "height": "350", "min_val": "0", "max_val": "200" } ]
Пример запроса информации о графике номер 2:
URL: http://192.168.1.1/api/graphs/2
Method: GET
Заголовки:
Accept: application/json Content-Type: application/json Accept-Encoding: gzip, deflate, sdch X-WH-APIKEY: F3C74230818DA487BB2017CE5D0290F4DABCAFD7
Пример ответа:
{ "id": "2", "regsid": "8", "title": "Температура в печи", "height": "350", "min_val": "0", "max_val": "200" }
Атрибуты графика:
id | int | Уникальный идентификатор словаря |
title | string | Название словаря |
value | string | Содержание словаря. Записи словаря разделены тегом <br>. Каждая запись содержит пару ключ-значение разделенные запятой. Например: 1,Green Tea. Это значит что при значении регистра = 1 будет отображаться строка "Green Tea" |