Api session event editor update with id: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
API Endpoint: api/session/event/editor/update_with_id/ | API Endpoint: api/session/event/editor/update_with_id/ | ||
Description: Waits for update of all active [[Overlay]]s, [[Indicator]]s, [[Panel]]s and [[Trigger]]s with unique ID. Note: for long-running updates use: set_scheduled_update/ to schedule an update | Description: Waits for update of all active [[Overlay]]s, [[Indicator]]s, [[Panel]]s and [[Trigger]]s with unique ID. Note: for long-running updates use: set_scheduled_update/ to schedule an update | ||
{|class=wikitable | {|class=wikitable | ||
| Line 35: | Line 35: | ||
===Example POST=== | ===Example POST=== | ||
Curl example POST | Curl example POST | ||
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editor/update_with_id/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ true, | <syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editor/update_with_id/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ true, 10 ]' | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Curl example multi item POST | Curl example multi item POST | ||
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editor/update_with_id/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ true, | <syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editor/update_with_id/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ true, 4 ]' | ||
</syntaxhighlight> | </syntaxhighlight> | ||
JavaScript example POST | JavaScript example POST | ||
| Line 44: | Line 44: | ||
method: "POST", | method: "POST", | ||
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" }, | headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" }, | ||
body: '[ true, | body: '[ true, 10 ]' | ||
}; | }; | ||
fetch("https://engine.tygron.com/api/session/event/editor/update_with_id/", options) | fetch("https://engine.tygron.com/api/session/event/editor/update_with_id/", options) | ||
Latest revision as of 14:51, 11 November 2026
API Endpoint: api/session/event/editor/update_with_id/
Description: Waits for update of all active Overlays, Indicators, Panels and Triggers with unique ID. Note: for long-running updates use: set_scheduled_update/ to schedule an update
| Index | Importance | Type | Description | Values |
|---|---|---|---|---|
| 0 | REQUIRED | (true, false) | Reset all X-Queries | true or false |
| 1 | REQUIRED | (Integer number) | Unique Update ID to prevent multiple updates |
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_with_id/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ true, 10 ]'Curl example multi item POST
curl 'https://engine.tygron.com/api/session/event/editor/update_with_id/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ true, 4 ]'JavaScript example POST
var options = {
method: "POST",
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
body: '[ true, 10 ]'
};
fetch("https://engine.tygron.com/api/session/event/editor/update_with_id/", options)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));