Api session event editor update: Difference between revisions

From Tygron Support wiki
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..."
 
Maxim@tygron.com (talk | contribs)
No edit summary
 
(23 intermediate revisions by one other user not shown)
Line 1: Line 1:
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.
API Endpoint: api/session/event/editor/update/
 
Description: Calculate all active [[Overlay]], [[Indicator]], [[Panel]] and [[Trigger]] and wait for the update. Note: for long-running calculations use: set_scheduled_update/ to schedule an update.
 
{|class=wikitable
{|class=wikitable
!Name
!Name
Line 25: Line 28:
|}
|}
===Example POST===
===Example POST===
Example POST: https://engine.tygron.com/api/session/event/editor/update/?f=HTML&token=API_TOKEN
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:


with content:  
<syntaxhighlight lang="text" copy>var options = {
<pre>[ false ]
 method: "POST",
</pre>
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
{{article end|seealso=*[[api session event editor]]}}
 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:22, 19 May 2026

API Endpoint: api/session/event/editor/update/

Description: Calculate all active Overlay, Indicator, Panel and Trigger and wait for the update. Note: for long-running calculations use: set_scheduled_update/ to schedule an update.

Name 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));