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

Материал из WebHMI Wiki
Перейти к: навигация, поиск
(Новая страница: «Example of requesting a list of all trends:»)
(Новая страница: «Headers: <pre> Accept: application/json Content-Type: application/json Accept-Encoding: gzip, deflate, sdch X-WH-APIKEY: F3C74230818DA487BB2017CE5D0290F4DABCAFD7…»)
Строка 21: Строка 21:
 
'''Method''': GET
 
'''Method''': GET
  
Заголовки:
+
Headers:
 
<pre>
 
<pre>
 
Accept: application/json
 
Accept: application/json

Версия 07:26, 16 апреля 2018

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

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

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


Example of requesting a list of all trends:

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

Headers:

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

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

[
  {
    "id": "1",
    "regsid": "16",
    "title": "Горелка",
    "height": "350",
    "min_val": "0",
    "max_val": ""
  },
  {
    "id": "2",
    "regsid": "11,12,13",
    "title": "Токи A, B, C",
    "height": "350",
    "min_val": "0",
    "max_val": "1500"
  }
]


Пример запроса информации о тренде номер 2:

URL: http://192.168.1.1/api/trends/2
Method: GET

Заголовки:

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

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

{
  "id": "2",
  "regsid": "11,12,13",
  "title": "Токи A, B, C",
  "height": "350",
  "min_val": "0",
  "max_val": "1500"
}


Атрибуты тренда:

idintУникальный идентификатор тренда
titlestringНазвание тренда
regsidstringСписок идентификаторов регистров которые необходимо отображать на тренде. Регистры разделены запятыми.
heightintВысота тренда в пикселях
min_valdoubleМинимальное значение оси Y
max_valdoubleМаксимальное значение оси Y