Api session event editor set scheduled update: Difference between revisions
Jump to navigation
Jump to search
Created page with "API Event to Schedule a long-running update of all active overlays, indicators, panels and triggers. {|class=wikitable !Name !Importance !Type !Description !Values |- |0 |OPTIONAL |(Integer number) |Scheduled time in milliseconds since epoch 1970. Note: 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 Co..." |
No edit summary |
||
| (7 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
API Event to Schedule a long-running update of all active | API Event to Schedule a long-running update of all active [[Overlay]], [[Indicator]], [[Panel]] and [[Trigger]]. | ||
{|class=wikitable | {|class=wikitable | ||
!Name | !Name | ||
| Line 10: | Line 10: | ||
|OPTIONAL | |OPTIONAL | ||
|(Integer number) | |(Integer number) | ||
|Scheduled | |Scheduled [[Time]] in milliseconds since epoch 1970. Note: use 0 for direct execution or -1 to cancel | ||
| | | | ||
|- | |- | ||
| Line 16: | Line 16: | ||
|OPTIONAL | |OPTIONAL | ||
|(String) | |(String) | ||
|Send Email to this | |Send Email to this [[Address]] when finished (optional) | ||
| | | | ||
|- | |- | ||
| Line 37: | Line 37: | ||
|} | |} | ||
===Example POST=== | ===Example POST=== | ||
Example POST: https://engine.tygron.com/api/session/event/editor/set_scheduled_update/?f= | Example POST: https://engine.tygron.com/api/session/event/editor/set_scheduled_update/?f=JSON&token=API_TOKEN | ||
with content: | with content: | ||
<pre>[ 0, "", "" ] | <pre>[ 0, "", "" ] | ||
</pre> | </pre> | ||
{{article end|seealso=*[[ | {{article end|seealso=*[[Api session event editor]] | ||
}} | |||
[[Category:API]] | [[Category:API]] | ||
Latest revision as of 12:03, 1 April 2026
API Event to Schedule a long-running update of all active Overlay, Indicator, Panel and Trigger.
| Name | Importance | Type | Description | Values |
|---|---|---|---|---|
| 0 | OPTIONAL | (Integer number) | Scheduled Time in milliseconds since epoch 1970. Note: 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
Example POST: https://engine.tygron.com/api/session/event/editor/set_scheduled_update/?f=JSON&token=API_TOKEN
with content:
[ 0, "", "" ]