API - Список трендов

Материал из WebHMI
Перейти к: навигация, поиск

Для получения списка всех трендов необходимо выполнить GET-запрос на URL вида http://192.168.1.1/api/trends.

Для получения информации о конкретном тренде необходимо выполнить GET-запрос на URL вида http://192.168.1.1/api/trends/1. Здесь 1 - это ID нужного тренда.

В заголовках запроса необходимо передать API key. Например:

X-WH-APIKEY: F3C74230818DA487BB2017CE5D0290F4DABCAFD7

Также в заголовках необходимо указать желаемый формат обмена данными. Сейчас поддерживатеся работа только с форматом JSON.

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

Пример запроса списка всех трендов:

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

Заголовки:

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"
}

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

  • id int Уникальный идентификатор тренда
  • title string Название тренда
  • regsid string Список идентификаторов регистров которые необходимо отображать на тренде. Регистры разделены запятыми.
  • height int Высота тренда в пикселях
  • min_val double Минимальное значение оси Y
  • max_val double Максимальное значение оси Y