API - Список панелей/en — различия между версиями

Материал из WebHMI Wiki
Перейти к: навигация, поиск
(Новая страница: «Headers: <pre> Accept: application/json Content-Type: application/json Accept-Encoding: gzip, deflate, sdch X-WH-APIKEY:F3C74230818DA487BB2017CE5D0290F4DABCAFD7 <…»)
(Новая страница: «Example of response: <pre> [ { "id": "1", "title": "Упаковка", "hide_title": "0", "width": "900", "height": "450" }, { "id":…»)
Строка 29: Строка 29:
 
</pre>
 
</pre>
  
Пример ответа:
+
Example of response:
 
<pre>
 
<pre>
 
[
 
[

Версия 09:31, 18 апреля 2018

To get a list of all panels, you must perform a GET request on the URL like this: http://192.168.1.1/api/dashboards.

To obtain information about a particular dashboard, you must perform a following GET request on a URL 'http://192.168.1.1/api/graphs/12' . Here "12" is the ID of the desired graph.

In the headers, it is necessary to pass API key. For example:

X-WH-APIKEY: F3C74230818DA487BB2017CE5D0290F4DABCAFD7

Also, in the headers, you must specify the desired data exchange format. Currently, only the JSON format is supported.

Accept: application/json
Content-Type: application/json


An example of querying a list of dashboards:

URL: http://192.168.1.1/api/dashboards
Method: GET

Headers:

Accept: application/json
Content-Type: application/json
Accept-Encoding: gzip, deflate, sdch
X-WH-APIKEY:F3C74230818DA487BB2017CE5D0290F4DABCAFD7

Example of response:

[
  {
    "id": "1",
    "title": "Упаковка",
    "hide_title": "0",
    "width": "900",
    "height": "450"
  },
  {
    "id": "2",
    "title": "Расход воды",
    "hide_title": "1",
    "width": "1024",
    "height": "800"
  }
]


Пример запроса информации об соединений номер 1:

URL: http://192.168.1.1/api/dashboards/1
Method: GET

Заголовки:

Accept: application/json
Content-Type: application/json
Accept-Encoding: gzip, deflate, sdch
X-WH-APIKEY:F3C74230818DA487BB2017CE5D0290F4DABCAFD7

Пример ответа:

{
  "id": "1",
  "title": "Упаковка",
  "hide_title": "0",
  "width": "900",
  "height": "450"
}


Атрибуты панелей:

idintУникальный идентификатор панели
titlestringНазвание панели
hide_titleint0 = отображать название панели, 1 = спрятать название панели
widthintШирина рабочей области панели в пикселях
heightintВысота рабочей области панели в пикселях