Api session event editor overlay set visible: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
Line 12: Line 12:
| 0
| 0
| REQUIRED
| REQUIRED
| (OVERLAY Integer ID or multiple values in array [1, 2, 3])
| (OVERLAY Integer ID or multiple integer values in array [1, 2, 3])
| [[Overlay]] ID
| [[Overlay]] ID
|  
|  
Line 18: Line 18:
| 1
| 1
| REQUIRED
| REQUIRED
| (Boolean or multiple values in array [true, false, true])
| (Boolean or multiple boolean values in array [true, false, true])
| Visualized
| Visualized
|  
|  

Latest revision as of 12:23, 17 June 2026

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

Description: Visualizes or hides an Overlay in the navigation Panel.

Index Importance Type Description Values
0 REQUIRED (OVERLAY Integer ID or multiple integer values in array [1, 2, 3]) Overlay ID
1 REQUIRED (Boolean or multiple boolean values in array [true, false, true]) Visualized

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_visible/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, true ]'

Curl example multi item POST

curl 'https://engine.tygron.com/api/session/event/editoroverlay/set_visible/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1, 2, 3 ], [ true, false, true ] ]'

JavaScript example POST

var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ 1, true ]'
};
fetch("https://engine.tygron.com/api/session/event/editoroverlay/set_visible/", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));