Api session event editor overlay set custom legend
Jump to navigation
Jump to search
API Endpoint: editoroverlay/set_custom_legend.
Description: Set whether the specified Overlay has a custom legend. If the specified Overlay is reverted to use a default Overlay, any custom legend information for the Overlay is removed.
| Name | Importance | Type | Description | Values |
|---|---|---|---|---|
| 0 | REQUIRED | (OVERLAY Integer ID) | Overlay ID | |
| 1 | REQUIRED | (true, false) | Has a custom legend (false sets the Overlay to use the default legend) | 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_custom_legend/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, false ]'JavaScript example POST:
var options = {
method: "POST",
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
body: '[ 1, false ]'
};
fetch("https://engine.tygron.com/api/session/event/editoroverlay/set_custom_legend/", options)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));