Api session event editor overlay add entry

From Tygron Support wiki
Revision as of 13:19, 3 November 2026 by Frank@tygron.nl (talk | contribs) (Created page with "API Endpoint: api/session/event/editoroverlay/add_entry/ Description: Add an entry to the legend of to a specified Overlay. {|class=wikitable !Index !Importance !Type !Description !Values |- | 0 | REQUIRED | (OVERLAY Integer ID or multiple integer values in array [1, 2, 3]) | Overlay ID | |- | 1 | OPTIONAL | (String or multiple values in array ["a", "b", "c"]) | Name (optional) | |- | 2 | OPTIONAL | (TColor or multiple values in array [a, b, c]) | Color (opti...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

API Endpoint: api/session/event/editoroverlay/add_entry/

Description: Add an entry to the legend of to a specified Overlay.

Index Importance Type Description Values
0 REQUIRED (OVERLAY Integer ID or multiple integer values in array [1, 2, 3]) Overlay ID
1 OPTIONAL (String or multiple values in array ["a", "b", "c"]) Name (optional)
2 OPTIONAL (TColor or multiple values in array [a, b, c]) Color (optional)
3 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_entry/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '1'

Curl example multi item POST

curl 'https://engine.tygron.com/api/session/event/editoroverlay/add_entry/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, 2, 3 ]'

JavaScript example POST

var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '1'
};
fetch("https://engine.tygron.com/api/session/event/editoroverlay/add_entry/", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));