Api session event editor update with id: 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 with unique ID. Note: for long-running updates use: set_scheduled_update/ to schedule an update. {|class=wikitable !Name !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=== {|class=wikitable !Response Code: !Description |- |200..."
 
No edit summary
 
(29 intermediate revisions by the same user not shown)
Line 1: Line 1:
API Event to 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.
API Endpoint: api/session/event/editor/update_with_id/
 
Description: Waits for update of all active [[Overlay]], [[Indicator]], [[Panel]] and [[Trigger]] with unique ID. Note: for long-running updates use: set_scheduled_update/ to schedule an update.
 
{|class=wikitable
{|class=wikitable
!Name
!Name
Line 31: Line 34:
|}
|}
===Example POST===
===Example POST===
Example POST: https://engine.tygron.com/api/session/event/editor/update_with_id/?f=HTML&token=API_TOKEN
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, 82 ]'
</syntaxhighlight>
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, 13 ]'
</syntaxhighlight>
JavaScript example POST:


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


[[Category:API]]
[[Category:API]]

Latest revision as of 11:25, 19 May 2026

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

Description: Waits for update of all active Overlay, Indicator, Panel and Trigger with unique ID. Note: for long-running updates use: set_scheduled_update/ to schedule an update.

Name 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, 82 ]'

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, 13 ]'

JavaScript example POST:

var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ true, 82 ]'
};
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));