Api session event editor update with id: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 10: | 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 27: | 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=== | ||
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, 33 ]' | ||
</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, 75 ]' | ||
</syntaxhighlight> | </syntaxhighlight> | ||
JavaScript example POST: | JavaScript example POST: | ||
| Line 47: | Line 47: | ||
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, 33 ]' | ||
}; | }; | ||
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) | ||
Revision as of 11:37, 8 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.
| 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, 33 ]'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, 75 ]'JavaScript example POST:
var options = {
method: "POST",
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
body: '[ true, 33 ]'
};
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));