Api session event editor overlay set show difference
Jump to navigation
Jump to search
API Endpoint: editoroverlay/set_show_difference.
Description: Set whether a specified grid Overlay has a difference option. If an Overlay has a difference option, an addition output is available computed from the difference between the CURRENT and MAQUETTE outputs.
| Name | Importance | Type | Description | Values |
|---|---|---|---|---|
| 0 | REQUIRED | (OVERLAY Integer ID or multiple values in array [1, 2, 3]) | Overlay ID (must relate to a grid Overlay) | |
| 1 | REQUIRED | (Boolean or multiple values in array [true, false, true]) | Has a difference option (false means there is no difference option for this 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_show_difference/' -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_show_difference/' -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_show_difference/", options)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));