Api session event editor set scheduled update: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (9 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
API Endpoint: | API Endpoint: api/session/event/editor/set_scheduled_update/ | ||
Description: Schedule a long-running update of all active [[Overlay]]s, [[Indicator]]s, [[Panel]]s and [[Trigger]]s. | |||
{|class=wikitable | {|class=wikitable | ||
! | !Index | ||
!Importance | !Importance | ||
!Type | !Type | ||
| Line 12: | Line 10: | ||
!Values | !Values | ||
|- | |- | ||
|0 | | 0 | ||
|OPTIONAL | | OPTIONAL | ||
|(Integer number) | | (Integer number) | ||
|Scheduled [[Time]] in milliseconds since epoch | | Scheduled [[Time]] in milliseconds since the Unix epoch. Use 0 for direct execution or -1 to cancel. | ||
| | | | ||
|- | |- | ||
|1 | | 1 | ||
|OPTIONAL | | OPTIONAL | ||
|(String) | | (String) | ||
|Send Email to this [[Address]] when finished (optional) | | Send Email to this [[Address]] when finished (optional) | ||
| | | | ||
|- | |- | ||
|2 | | 2 | ||
|OPTIONAL | | OPTIONAL | ||
|(String) | | (String) | ||
|Send SMS to this number when finished (optional) | | Send SMS to this number when finished (optional) | ||
| | | | ||
|} | |} | ||
===Response Codes=== | ===Response Codes=== | ||
| Line 35: | Line 33: | ||
!Description | !Description | ||
|- | |- | ||
|204 | | 204 | ||
|No Content | | No Content | ||
|- | |- | ||
|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/set_scheduled_update/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '' | |||
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editor/set_scheduled_update/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d ' | |||
</syntaxhighlight> | </syntaxhighlight> | ||
JavaScript example POST | JavaScript example POST | ||
<syntaxhighlight lang="text" copy>var options = { | <syntaxhighlight lang="text" copy>var options = { | ||
method: "POST", | method: "POST", | ||
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" }, | headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" }, | ||
body: ' | body: '' | ||
}; | }; | ||
fetch("https://engine.tygron.com/api/session/event/editor/set_scheduled_update/", options) | fetch("https://engine.tygron.com/api/session/event/editor/set_scheduled_update/", options) | ||
Latest revision as of 09:57, 13 July 2026
API Endpoint: api/session/event/editor/set_scheduled_update/
Description: Schedule a long-running update of all active Overlays, Indicators, Panels and Triggers.
| Index | Importance | Type | Description | Values |
|---|---|---|---|---|
| 0 | OPTIONAL | (Integer number) | Scheduled Time in milliseconds since the Unix epoch. Use 0 for direct execution or -1 to cancel. | |
| 1 | OPTIONAL | (String) | Send Email to this Address when finished (optional) | |
| 2 | OPTIONAL | (String) | Send SMS to this number when finished (optional) |
Response Codes
| Response Code: | Description |
|---|---|
| 204 | No Content |
| 300-600 | Codes Overview |
Example POST
Curl example POST
curl 'https://engine.tygron.com/api/session/event/editor/set_scheduled_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/set_scheduled_update/", options)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));