API - Список графиков — различия между версиями
Материал из WebHMI Wiki
(Новая страница: «Для получения списка всех графиков необходимо выполнить GET-запрос на URL вида '''http://192.168.1.1/…») |
|||
(не показаны 3 промежуточные версии 2 участников) | |||
Строка 1: | Строка 1: | ||
+ | <languages/> | ||
+ | <translate> | ||
+ | <!--T:1--> | ||
Для получения списка всех графиков необходимо выполнить GET-запрос на URL вида '''http://192.168.1.1/api/graphs'''. | Для получения списка всех графиков необходимо выполнить GET-запрос на URL вида '''http://192.168.1.1/api/graphs'''. | ||
+ | <!--T:2--> | ||
Для получения информации о конкретном графике необходимо выполнить GET-запрос на URL вида '''http://192.168.1.1/api/graphs/1'''. Здесь 1 - это ID нужного графика. | Для получения информации о конкретном графике необходимо выполнить GET-запрос на URL вида '''http://192.168.1.1/api/graphs/1'''. Здесь 1 - это ID нужного графика. | ||
+ | <!--T:3--> | ||
В заголовках запроса необходимо передать API key. Например: | В заголовках запроса необходимо передать API key. Например: | ||
<pre> | <pre> | ||
Строка 8: | Строка 13: | ||
</pre> | </pre> | ||
+ | <!--T:4--> | ||
Также в заголовках необходимо указать желаемый формат обмена данными. Сейчас поддерживатеся работа только с форматом [https://ru.wikipedia.org/wiki/JSON JSON]. | Также в заголовках необходимо указать желаемый формат обмена данными. Сейчас поддерживатеся работа только с форматом [https://ru.wikipedia.org/wiki/JSON JSON]. | ||
<pre> | <pre> | ||
Строка 16: | Строка 22: | ||
+ | <!--T:5--> | ||
Пример запроса списка всех графиков: | Пример запроса списка всех графиков: | ||
+ | <!--T:6--> | ||
'''URL''': http://192.168.1.1/api/graphs<br> | '''URL''': http://192.168.1.1/api/graphs<br> | ||
'''Method''': GET | '''Method''': GET | ||
+ | <!--T:7--> | ||
Заголовки: | Заголовки: | ||
<pre> | <pre> | ||
Строка 29: | Строка 38: | ||
</pre> | </pre> | ||
+ | <!--T:8--> | ||
Пример ответа: | Пример ответа: | ||
<pre> | <pre> | ||
Строка 53: | Строка 63: | ||
+ | <!--T:9--> | ||
Пример запроса информации о графике номер 2: | Пример запроса информации о графике номер 2: | ||
+ | <!--T:10--> | ||
'''URL''': http://192.168.1.1/api/graphs/2<br> | '''URL''': http://192.168.1.1/api/graphs/2<br> | ||
'''Method''': GET | '''Method''': GET | ||
+ | <!--T:11--> | ||
Заголовки: | Заголовки: | ||
<pre> | <pre> | ||
Строка 66: | Строка 79: | ||
</pre> | </pre> | ||
+ | <!--T:12--> | ||
Пример ответа: | Пример ответа: | ||
<pre> | <pre> | ||
Строка 80: | Строка 94: | ||
+ | <!--T:13--> | ||
Атрибуты графика: | Атрибуты графика: | ||
+ | <!--T:14--> | ||
<table> | <table> | ||
− | <tr><td>'''id'''</td><td>int</td><td>Уникальный идентификатор | + | <tr><td>'''id'''</td><td>int</td><td>Уникальный идентификатор графика</td></tr> |
− | <tr><td>'''title'''</td><td>string</td><td>Название | + | <tr><td>'''title'''</td><td>string</td><td>Название графика</td></tr> |
− | <tr><td>''' | + | <tr><td>'''regsid'''</td><td>string</td><td>Список идентификаторов регистров которые необходимо отображать на графике. Регистры разделены запятыми.</td></tr> |
+ | <tr><td>'''height'''</td><td>int</td><td>Высота графика в пикселях</td></tr> | ||
+ | <tr><td>'''min_val'''</td><td>double</td><td>Минимальное значение оси Y</td></tr> | ||
+ | <tr><td>'''max_val'''</td><td>double</td><td>Максимальное значение оси Y</td></tr> | ||
</table> | </table> | ||
+ | </translate> |
Текущая версия на 07:46, 16 апреля 2018
Для получения списка всех графиков необходимо выполнить 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 | Название графика |
regsid | string | Список идентификаторов регистров которые необходимо отображать на графике. Регистры разделены запятыми. |
height | int | Высота графика в пикселях |
min_val | double | Минимальное значение оси Y |
max_val | double | Максимальное значение оси Y |