Api session event editor overlay set show system visualization
API Endpoint: editoroverlay/set_show_system_visualization.
Description: Set whether a specified Overlay visualizes the graph of systems which dictates its calculation. Pipes, center points of Area, etc.
| Name | Importance | Type | Description | Values |
|---|---|---|---|---|
| 0 | REQUIRED | (OVERLAY Integer ID) | Overlay ID (must relate to a water Overlay) | |
| 1 | REQUIRED | (Enumeration) | Visual Type | AREAS or OBJECTS |
| 2 | REQUIRED | (true, false) | Show | true or false |
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_show_system_visualization/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "OBJECTS", true ]'JavaScript example POST:
var options = {
method: "POST",
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
body: '[ 1, "OBJECTS", true ]'
};
fetch("https://engine.tygron.com/api/session/event/editoroverlay/set_show_system_visualization/", options)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));