Api session event editor overlay remove legend entry
API Endpoint: editoroverlay/remove_legend_entry.
Description: Remove the specified legend entries from a specified Overlay. The Overlay must have a custom legend before entries can be removed from it.
| Name | Importance | Type | Description | Values |
|---|---|---|---|---|
| 0 | REQUIRED | (OVERLAY Integer ID) | Overlay ID | |
| 1 | REQUIRED | (true, false) | Remove from custom difference legend (false removes the entry from the normal custom legend) | true or false |
| 2 | REQUIRED | (Integer number or multiple values in array [1, 2, 3]) | Ids of entries which should be removed |
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/remove_legend_entry/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, false, 1 ]'Curl example multi item POST:
curl 'https://engine.tygron.com/api/session/event/editoroverlay/remove_legend_entry/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, false, [ 1, 2, 3 ] ]'JavaScript example POST:
var options = {
method: "POST",
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
body: '[ 1, false, 1 ]'
};
fetch("https://engine.tygron.com/api/session/event/editoroverlay/remove_legend_entry/", options)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));