mirror of
https://github.com/home-assistant/developers.home-assistant.git
synced 2025-11-14 13:30:55 +00:00
Add docs for extract_from_target websocket api (#2749)
This commit is contained in:
@@ -529,6 +529,57 @@ The server will respond with the validation results. Only fields will be include
|
||||
}
|
||||
```
|
||||
|
||||
## Extract from target
|
||||
|
||||
This command allows you to extract entities, devices, and areas from one or multiple targets.
|
||||
|
||||
```json
|
||||
{
|
||||
"id": 19,
|
||||
"type": "extract_from_target",
|
||||
"target": {
|
||||
"entity_id": ["group.kitchen"],
|
||||
"device_id": ["device_abc123"],
|
||||
"area_id": ["kitchen"],
|
||||
"label_id": ["smart_lights"]
|
||||
},
|
||||
// Optional: expand group entities to their members (default: false)
|
||||
"expand_group": true
|
||||
}
|
||||
```
|
||||
|
||||
The target parameter follows the same structure as service call targets.
|
||||
|
||||
The server will respond with the information extracted from the target:
|
||||
|
||||
```json
|
||||
{
|
||||
"id": 19,
|
||||
"type": "result",
|
||||
"success": true,
|
||||
"result": {
|
||||
"referenced_entities": ["light.kitchen", "switch.kitchen", "light.living_room", "switch.bedroom"],
|
||||
"referenced_devices": ["device_abc123", "device_def456"],
|
||||
"referenced_areas": ["kitchen", "living_room"],
|
||||
"missing_devices": [],
|
||||
"missing_areas": [],
|
||||
"missing_floors": [],
|
||||
"missing_labels": []
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
The response includes:
|
||||
- `referenced_entities`: All entity IDs that would be targeted (includes entities from devices/areas/labels)
|
||||
- `referenced_devices`: All device IDs that were referenced
|
||||
- `referenced_areas`: All area IDs that were referenced
|
||||
- `missing_devices`: Device IDs that don't exist
|
||||
- `missing_areas`: Area IDs that don't exist
|
||||
- `missing_floors`: Floor IDs that don't exist
|
||||
- `missing_labels`: Label IDs that don't exist
|
||||
|
||||
When `expand_group` is set to `true`, group entities will be expanded to include their member entities instead of the group entity itself.
|
||||
|
||||
## Error handling
|
||||
|
||||
If an error occurs, the `success` key in the `result` message will be set to `false`. It will contain an `error` key containing an object with two keys: `code` and `message`.
|
||||
|
||||
Reference in New Issue
Block a user