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

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

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

GET https://api.iot.yandex.net/v1.0/groups/{group_id}

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

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

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

HTTP/1.1 404 Not Found

{
    "request_id": String,
    "status": "error",
    "message": String
}

ПримерПример

Запрос

Успешный ответ

Ответ с ошибкой

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

HTTP/1.1 200 OK

{
	"status": "ok",
	"request_id": "4ea5619b-c4c5-41af-930b-4b317f7bdad6",
	"id": "light-group-id-1",
	"name": "Люстра",
	"aliases": ["Верхний свет"],
	"type": "devices.types.light",
	"state": "online",
	"capabilities": [{
			"retrievable": true,
			"type": "devices.capabilities.on_off",
			"parameters": {
				"split": false
			},
			"state": {
				"instance": "on",
				"value": false
			}
		},
		{
			"retrievable": true,
			"type": "devices.capabilities.range",
			"parameters": {
				"instance": "brightness",
				"unit": "unit.percent",
				"random_access": true,
				"range": {
					"min": 1,
					"max": 100,
					"precision": 1
				}
			},
			"state": {
				"instance": "brightness",
				"value": 100
			}
		},
		{
			"retrievable": true,
			"type": "devices.capabilities.color_setting",
			"parameters": {
				"color_model": "hsv",
				"temperature_k": {
					"min": 1700,
					"max": 6500
				}
			},
			"state": {
				"instance": "temperature_k",
				"value": 3400
			}
		}
	],
	"devices": [{
			"id": "lamp-id-1",
			"name": "Лампочка 1",
			"type": "devices.types.light"
		},
		{
			"id": "lamp-id-2",
			"name": "Лампочка 2",
			"type": "devices.types.light"
		},
		{
			"id": "lamp-id-3",
			"name": "Лампочка 3",
			"type": "devices.types.light"
		}
	]
}

HTTP/1.1 404 Not Found

{
    "request_id": "667b3e0f-47a8-4136-9211-b4ff59062315",
    "status": "error",
    "message": "Группа устройств не найдена"
}