API - Список панелей

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

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

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

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

X-WH-APIKEY: F3C74230818DA487BB2017CE5D0290F4DABCAFD7

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

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

Пример запроса списка панелей:

URL: http://192.168.1.1/api/dashboards
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"
  },
  {
    "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"
}

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

  • id int Уникальный идентификатор панели
  • title string Название панели
  • hide_title int 0 = отображать название панели, 1 = спрятать название панели
  • width int Ширина рабочей области панели в пикселях
  • height int Высота рабочей области панели в пикселях