Api session event editor update with id: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older edit
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Interface administrators, Administrators
46,429 edits
No edit summary
No edit summary
 
(26 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]]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
!Name
!Index
!Importance
!Importance
!Type
!Type
Line 7: Line 10:
!Values
!Values
|-
|-
|0
| 0
|REQUIRED
| REQUIRED
|(true, false)
| (true, false)
|Reset all X-Queries
| Reset all X-Queries
|true  or  false
| true  or  false
|-
|-
|1
| 1
|REQUIRED
| REQUIRED
|(Integer number)
| (Integer number)
|Unique Update ID to prevent multiple updates
| Unique Update ID to prevent multiple updates
|
|  
|}
|}
===Response Codes===
===Response Codes===
Line 24: Line 27:
!Description
!Description
|-
|-
|200
| 200
|Boolean (Content was updated)
| Boolean (Content was updated)
|-
|-
|300-600
| 300-600
|Codes Overview
| Codes Overview
|}
|}
===Example POST===
===Example POST===
Example POST: https://power.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, 78 ]'
with content:  
</syntaxhighlight>
<pre>[ true, 62 ]
Curl example multi item POST
</pre>
<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, 30 ]'
{{article end|seealso=*[[api session event editor]]}}
</syntaxhighlight>
JavaScript example POST
<syntaxhighlight lang="text" copy>var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ true, 78 ]'
};
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 12:01, 15 June 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, 78 ]'

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

JavaScript example POST 

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

See also

Retrieved from "https://support.tygron.com/w/index.php?title=Api_session_event_editor_update_with_id&oldid=85517"