Api session event editor overlay set parent
Jump to navigation
Jump to search
API Endpoint: editoroverlay/set_parent.
Description: Set a parent Overlay for a specified Overlay. This will cause the specified Overlay to be a subselectable Overlay of the parent. It is not possible to set an Overlay which has a parent itself as a parent of another Overlay.
| Name | Importance | Type | Description | Values |
|---|---|---|---|---|
| 0 | REQUIRED | (OVERLAY Integer ID) | Overlay ID | |
| 1 | REQUIRED | (Integer number) | Overlay ID of parent (Overlay without a parent should have their parent Overlay ID set to -1) |
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_parent/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, 1 ]'JavaScript example POST:
var options = {
method: "POST",
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
body: '[ 1, 1 ]'
};
fetch("https://engine.tygron.com/api/session/event/editoroverlay/set_parent/", options)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));