Api session event editor overlay add result child
Jump to navigation
Jump to search
API Endpoint: editoroverlay/add_result_child.
Description: Add a specified result type as a child Overlay to a specified grid Overlay. The child Overlay's result will be based on the parent's calculation, allowing you to get multiple types of results from the same calculation.
| Name | Importance | Type | Description | Values |
|---|---|---|---|---|
| 0 | REQUIRED | (OVERLAY Integer ID) | Overlay ID (must relate to a grid Overlay with result types) | |
| 1 | REQUIRED | (String) | Result type for new child Overlay (must be a valid result for the parent Overlay type) |
Response Codes
| Response Code: | Description |
|---|---|
| 200 | Integer (Overlay ID) |
| 300-600 | Codes Overview |
Example POST
Curl example POST:
curl 'https://engine.tygron.com/api/session/event/editoroverlay/add_result_child/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "Result type for new child Overlay" ]'JavaScript example POST:
var options = {
method: "POST",
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
body: '[ 1, "Result type for new child Overlay" ]'
};
fetch("https://engine.tygron.com/api/session/event/editoroverlay/add_result_child/", options)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));