Api session event editor overlay remove legend entry

From Tygron Support wiki
Jump to navigation Jump to search

API Event to 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

Example POST: https://engine.tygron.com/api/session/event/editoroverlay/remove_legend_entry/?f=JSON&token=API_TOKEN

with content:

[ 62, false, [ 1, 2, 3 ] ]