Получение информации о состоянии группы устройств

Запрос информации об актуальном состоянии группы устройств пользователя.

  1. Формат запроса
  2. Формат ответа
  3. Пример

Формат запроса

GET https://api.iot.yandex.net/v1.0/groups/{group_id}
group_idИдентификатор группы устройств пользователя.
group_idИдентификатор группы устройств пользователя.

Заголовки запроса

Заголовок Описание Обязательный
Authorization Авторизационный токен oauth-приложения. Да
Заголовок Описание Обязательный
Authorization Авторизационный токен oauth-приложения. Да

Формат ответа

HTTP/1.1 200 OK
            
{
	"status": "ok",
	"request_id": String,
	"id": String,
	"name": String,
	"aliases": [String],
	"type": "devices.types.{type}",
	"state": "online",
	"capabilities": [{
			"retrievable": Boolean,
			"type": "devices.capabilities.{capability}",
			"parameters": {},
			"state": {}
		},
		{
			"retrievable": Boolean,
			"type": "devices.capabilities.{capability}",
			"parameters": {},
			"state": {}
		}
	],
	"devices": [{
			"id": String,
			"name": String,
			"type": "devices.types.{type}"
		},
		{
			"id": String,
			"name": String,
			"type": "devices.types.{type}"
		}
	]
}
Параметр Тип Описание Обязательный
status String Статус обработки запроса. Допустимые значения:
  • ok.
Да
request_id String Идентификатор запроса. Необходимо логировать для расследования инцидентов. Да
id String Идентификатор группы устройств. Да
name String Имя группы устройств. Да
aliases Array of Strings Массив с дополнительными именами устройств. Да
type String Тип группы устройств. Совпадает с типом устройств, входящих в группу. Да
state String Состояние группы устройств. Допустимые значения:
  • online;
  • offline;
  • split — устройства в группе находятся в разных состояниях.
Да
capabilities Array of CapabilityObjects Массив с информацией об умениях группы устройств. Да
devices Array of GroupDeviceInfoObjects Массив с информацией об устройствах в группе. Да
Массив capabilities
capability1 CapabilityObject Описание умения. Подробнее со списком доступных умений и их параметрами можно ознакомиться в разделе Умения. Нет
capability2 CapabilityObject Описание умения. Подробнее со списком доступных умений и их параметрами можно ознакомиться в разделе Умения. Нет
Тип CapabilityObject
type String Тип умения. Да
retrievable Boolean Доступен ли для данного умения запрос состояния Да
parameters CapabilityParametersObject Параметры умения. Соответствует значению поля parameters из описания умения. Да
state CapabilityStateObject Текущее состояние умения. Если значение null, значит это умение не находится в одинаковом состоянии на устройствах в группе. Соответствует значению поля state из описания умения. Да
Массив devices
device1 GroupDeviceInfoObject Описание устройства в группе. Нет
device2 GroupDeviceInfoObject Описание устройства в группе. Нет
Тип GroupDeviceInfoObject
id String Идентификатор устройства. Да
name String Имя устройства. Да
type String Тип устройства. Да
Параметр Тип Описание Обязательный
status String Статус обработки запроса. Допустимые значения:
  • ok.
Да
request_id String Идентификатор запроса. Необходимо логировать для расследования инцидентов. Да
id String Идентификатор группы устройств. Да
name String Имя группы устройств. Да
aliases Array of Strings Массив с дополнительными именами устройств. Да
type String Тип группы устройств. Совпадает с типом устройств, входящих в группу. Да
state String Состояние группы устройств. Допустимые значения:
  • online;
  • offline;
  • split — устройства в группе находятся в разных состояниях.
Да
capabilities Array of CapabilityObjects Массив с информацией об умениях группы устройств. Да
devices Array of GroupDeviceInfoObjects Массив с информацией об устройствах в группе. Да
Массив capabilities
capability1 CapabilityObject Описание умения. Подробнее со списком доступных умений и их параметрами можно ознакомиться в разделе Умения. Нет
capability2 CapabilityObject Описание умения. Подробнее со списком доступных умений и их параметрами можно ознакомиться в разделе Умения. Нет
Тип CapabilityObject
type String Тип умения. Да
retrievable Boolean Доступен ли для данного умения запрос состояния Да
parameters CapabilityParametersObject Параметры умения. Соответствует значению поля parameters из описания умения. Да
state CapabilityStateObject Текущее состояние умения. Если значение null, значит это умение не находится в одинаковом состоянии на устройствах в группе. Соответствует значению поля state из описания умения. Да
Массив devices
device1 GroupDeviceInfoObject Описание устройства в группе. Нет
device2 GroupDeviceInfoObject Описание устройства в группе. Нет
Тип GroupDeviceInfoObject
id String Идентификатор устройства. Да
name String Имя устройства. Да
type String Тип устройства. Да

Пример

curl -i -X GET 'https://api.iot.yandex.net/v1.0/groups/lamp-group-id-1' \
-H 'Authorization: Bearer 123qwe456a...'