API - Запись нового значения в регистр

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

Для записи нового значения в регистр необходимо выполнить PUT-запрос на URL вида http://192.168.1.1/api/register-values/23. Здесь 23 - это ID регистра для которого необходимо изменить значение.

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

X-WH-APIKEY: F3C74230818DA487BB2017CE5D0290F4DABCAFD7

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

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

В теле запроса необходимо передать json-объект с единственным свойством "value":

{"value":"12"}

Пример записи значения 15 в регистр c ID = 5:

URL: http://192.168.1.1/api/register-values/5
Method: PUT

Заголовки:

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

Тело запроса:

{"value":"15"}

Если запрос валидный то API вернет HTTP-код 200.