Api session event editor overlay set prequel: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
API Endpoint: api/session/event/editoroverlay/set_prequel/ | API Endpoint: api/session/event/editoroverlay/set_prequel/ | ||
Description: Set | Description: Set Prequel [[Overlay]] for a [[Grid Overlay]] and a Prequel Type supported by the [[Grid Overlay]]. Optionally a specific [[Timeframe]] is used to obtain [[Grid]] values, with the last [[Timeframe]] of the Prequel [[Overlay]] as default.Optionally [[Grid]] Values are obtain from a previous [[Simulation Core|Iteration]], allowing cyclic dependencies between [[Grid Overlay]]s. | ||
{|class=wikitable | {|class=wikitable | ||
| Line 13: | Line 13: | ||
| REQUIRED | | REQUIRED | ||
| (OVERLAY Integer ID) | | (OVERLAY Integer ID) | ||
| [[Overlay]] | | [[Grid Overlay]] | ||
| | | | ||
|- | |- | ||
| Line 19: | Line 19: | ||
| REQUIRED | | REQUIRED | ||
| (OVERLAY Integer ID) | | (OVERLAY Integer ID) | ||
| Prequel [[Overlay]] | | Prequel [[Overlay]] | ||
| | | | ||
|- | |- | ||
Revision as of 15:31, 10 November 2026
API Endpoint: api/session/event/editoroverlay/set_prequel/
Description: Set Prequel Overlay for a Grid Overlay and a Prequel Type supported by the Grid Overlay. Optionally a specific Timeframe is used to obtain Grid values, with the last Timeframe of the Prequel Overlay as default.Optionally Grid Values are obtain from a previous Iteration, allowing cyclic dependencies between Grid Overlays.
| Index | Importance | Type | Description | Values |
|---|---|---|---|---|
| 0 | REQUIRED | (OVERLAY Integer ID) | Grid Overlay | |
| 1 | REQUIRED | (OVERLAY Integer ID) | Prequel Overlay | |
| 2 | REQUIRED | (String) | Prequel Type Name | |
| 3 | OPTIONAL | (Integer number) | Prequel Timeframe ID (optional) | |
| 4 | OPTIONAL | (true, false) | Previous Iteration (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/editoroverlay/set_prequel/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, 1, "Prequel Type Name" ]'JavaScript example POST
var options = {
method: "POST",
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
body: '[ 1, 1, "Prequel Type Name" ]'
};
fetch("https://engine.tygron.com/api/session/event/editoroverlay/set_prequel/", options)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));