Api session event editor update: Difference between revisions
Jump to navigation
Jump to search
Created page with "API Event to Waits for update of all active overlays, indicators, panels and triggers. Note: for long-running updates use: set_scheduled_update/ to schedule an update. {|class=wikitable !Name !Importance !Type !Description !Values |- |0 |OPTIONAL |(true, false) |Reset all X-Queries (optional) | |} ===Response Codes=== {|class=wikitable !Response Code: !Description |- |200 |Boolean (Content was updated) |- |300-600 |Codes Overview |} ===Example POST=== Example POST: https..." |
No edit summary |
||
| (26 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
API | API Endpoint: api/session/event/editor/update/ | ||
Description: Calculate all active [[Overlay]]s, [[Indicator]]s, [[Panel]]s and [[Trigger]]s and wait for the update. Note: for long-running calculations use: set_scheduled_update/ to schedule an update. | |||
{|class=wikitable | {|class=wikitable | ||
! | !Index | ||
!Importance | !Importance | ||
!Type | !Type | ||
| Line 7: | Line 10: | ||
!Values | !Values | ||
|- | |- | ||
|0 | | 0 | ||
|OPTIONAL | | OPTIONAL | ||
|(true, false) | | (true, false) | ||
|Reset all X-Queries (optional) | | Reset all X-Queries (optional) | ||
| | | | ||
|} | |} | ||
===Response Codes=== | ===Response Codes=== | ||
| Line 18: | Line 21: | ||
!Description | !Description | ||
|- | |- | ||
|200 | | 200 | ||
|Boolean (Content was updated) | | Boolean (Content was updated) | ||
|- | |- | ||
|300-600 | | 300-600 | ||
|Codes Overview | | Codes Overview | ||
|} | |} | ||
===Example POST=== | ===Example POST=== | ||
Curl example POST | |||
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editor/update/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '' | |||
</syntaxhighlight> | |||
JavaScript example POST | |||
</ | <syntaxhighlight lang="text" copy>var options = { | ||
{{article end|seealso=*[[ | method: "POST", | ||
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" }, | |||
body: '' | |||
}; | |||
fetch("https://engine.tygron.com/api/session/event/editor/update/", options) | |||
.then(response => response.text()) | |||
.then(result => console.log(result)) | |||
.catch(error => console.log('error', error)); | |||
</syntaxhighlight> | |||
{{article end|seealso=*[[Api session event editor]] | |||
}} | |||
[[Category:API]] | [[Category:API]] | ||
Latest revision as of 12:01, 15 June 2026
API Endpoint: api/session/event/editor/update/
Description: Calculate all active Overlays, Indicators, Panels and Triggers and wait for the update. Note: for long-running calculations use: set_scheduled_update/ to schedule an update.
| Index | Importance | Type | Description | Values |
|---|---|---|---|---|
| 0 | OPTIONAL | (true, false) | Reset all X-Queries (optional) |
Response Codes
| Response Code: | Description |
|---|---|
| 200 | Boolean (Content was updated) |
| 300-600 | Codes Overview |
Example POST
Curl example POST
curl 'https://engine.tygron.com/api/session/event/editor/update/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d ''JavaScript example POST
var options = {
method: "POST",
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
body: ''
};
fetch("https://engine.tygron.com/api/session/event/editor/update/", options)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));