Структура запросов🔗

При составлении API-запроса нужно указать:

Тип запроса. Если вы хотите изменить параметры устройства, то нужно отправить запрос publish (публикации). Для получения информации об оборудовании отправьте запрос subscribe (подписки).
Тему запроса (топик) — используется в качестве ссылки (пути), по которой передаются команды или информация.
Тело запроса — параметры оборудования в формате JSON. Обязательный параметр для запроса публикации.

Параметры топиков🔗

Топики представляют собой ссылки следующего вида:

Spread/{Topic_Type}/{Project_ID}/{Entity}/{Object_Type}/{Object_ID}/{Function}

Параметр	Значение
Topic_Type	Тип топика: `Set` — топик изменения. Используется в запросах публикации (publish). `State` — топик информации (статуса). Используется в запросах подписки (subscribe).
Project_ID	ID проекта AWADA.
Entity	Сущность: `Location` — локация `Equipment` — инженерный объект (оборудование) `Hardware` — контроллер (менеджер, провайдер)
Object_Type	Тип объекта
Object_ID	ID объекта
Function	Параметр, который нужно изменить (или узнать текущий статус).

Примечание

До параметра {Entity} параметры топиков одинаковые, а после могут отличаться в зависимости от сущности. В статье приведен пример топика для инженерных объектов.