jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-29 04:06:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation to match new implementation

Browse Source
This commit is contained in:
Jack Gaino 2024-06-20 23:04:18 -04:00 committed by GitHub
parent c5f2209e4e
commit 5e52cc2386
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 35 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
docs/api/rest.md
View File

@ -659,11 +659,44 @@ By default, a call will returns a list of states that have changed while the ser
The result will include any states that changed while the service was being executed, even if their change was the result of something else happening in the system. The result will include any states that changed while the service was being executed, even if their change was the result of something else happening in the system.
::: :::
If the service you're calling supports returning response data, you can retrieve that instead of the list of state changes by either adding `?return_response` to the URL, or by adding `"return_response": true` to the JSON body. If the service you're calling supports returning response data, you can retrieve it by adding `?return_response` to the URL. Your response will then contain both the list of changed entities and the service response data.
```json ```json
{ {
"return_response": true "changed_states": [
{
"attributes": {},
"entity_id": "sun.sun",
"last_changed": "2024-04-22T20:45:54.418320-04:00",
"state": "below_horizon"
},
{
"attributes": {},
"entity_id": "process.Dropbox",
"last_changed": "2024-04-22T20:45:54.418320-04:00",
"state": "on"
}
],
"service_response": {
"weather.new_york_forecast": {
"forecast": [
{
"condition": "clear-night",
"datetime": "2024-04-22T20:45:55.173725-04:00",
"precipitation_probability": 0,
"temperature": null,
"templow": 6.0
},
{
"condition": "rainy",
"datetime": "2024-04-23T20:45:55.173756-04:00",
"precipitation_probability": 60,
"temperature": 16.0,
"templow": 4.0
}
]
}
}
} }
``` ```