Api session event editor overlay set legend entry name

From Tygron Support wiki
Jump to navigation Jump to search

API Event to Change the name of a specified legend entry of a custom legend of a specified Overlay.

Name Importance Type Description Values
0 REQUIRED (OVERLAY Integer ID) Overlay ID
1 REQUIRED (true, false) Affect the custom difference legend (false means affect the normal custom legend) true or false
2 REQUIRED (Integer number) ID of entry which should be changed
3 REQUIRED (String) New name for the entry

Response Codes

Response Code: Description
204 No Content
300-600 Codes Overview

Example POST

Curl Example POST:

curl 'https://development.tygron.com/api/session/event/editoroverlay/set_legend_entry_name/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, false, 1, "New name for the entry" ]'

JavaScript Example POST:

var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer 31410104zAuxtcJo8WGhL6iYlCDnU5hd" },
 body: '[ 1, false, 1, "New name for the entry" ]'
};
fetch("https://development.tygron.com/api/session/event/editoroverlay/set_legend_entry_name/", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));