Api session event editor overlay set parent: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
API Endpoint: api/session/event/editoroverlay/set_parent/
API Endpoint: api/session/event/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]].
Description: Set a parent [[Overlay]] for an [[Overlay]]. An [[Overlay]] with a parent cannot be assigned as a parent to another [[Overlay]]


{|class=wikitable
{|class=wikitable
Line 13: Line 13:
| REQUIRED
| REQUIRED
| (OVERLAY Integer ID)
| (OVERLAY Integer ID)
| [[Overlay]] ID
| [[Overlay]]
|  
|  
|-
|-
Line 19: Line 19:
| REQUIRED
| REQUIRED
| (Integer number)
| (Integer number)
| [[Overlay]] ID of parent ([[Overlay]]s without a parent should have their parent [[Overlay]] ID set to -1)
| Parent [[Overlay]]
|  
|  
|}
|}

Latest revision as of 14:54, 11 November 2026

API Endpoint: api/session/event/editoroverlay/set_parent/

Description: Set a parent Overlay for an Overlay. An Overlay with a parent cannot be assigned as a parent to another Overlay

Index Importance Type Description Values
0 REQUIRED (OVERLAY Integer ID) Overlay
1 REQUIRED (Integer number) Parent Overlay

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));