Api session event editor overlay add legend entry
Jump to navigation
Jump to search
This functionality is deprecated and will be removed in the future.
API Endpoint: api/session/event/editoroverlay/add_legend_entry/
Description: Add a Legend Entry to a specified Overlay. The Overlay must have a custom legend before entries can be added to it.
| 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]) | Add to custom difference legend (false adds the entry to the normal custom legend) | |
| 2 | OPTIONAL | (String or multiple values in array ["a", "b", "c"]) | Name (optional) | |
| 3 | OPTIONAL | (TColor or multiple values in array [a, b, c]) | Color (optional) | |
| 4 | OPTIONAL | (Floating point number or multiple values in array [1.0, 2.0, 3.0]) | Value (optional) |
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/add_legend_entry/' -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/add_legend_entry/' -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/add_legend_entry/", options)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));