Api session event editor overlay set image: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 57: Line 57:
</syntaxhighlight>
</syntaxhighlight>
{{article end|seealso=*[[Api session event editor overlay]]
{{article end|seealso=*[[Api session event editor overlay]]
*[[Api session items overlays]]
}}
}}


[[Category:API]]
[[Category:API]]

Revision as of 11:57, 10 April 2026

API Endpoint: editoroverlay/set_image.

API Endpoint name is Api session event editor overlay set image.

Use this endpoint to Change the icon displayed in the navigation window by the Overlay. Only existing Overlay Project Asset are allowed.

Name Importance Type Description Values
0 REQUIRED (OVERLAY Integer ID or multiple values in array [1, 2, 3]) Overlay ID
1 REQUIRED (String or multiple values in array ["a", "b", "c"]) Project asset name, omitting the directory

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/set_image/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "Project asset name, omitting the directory 1" ]'

Curl example multi item POST:

curl 'https://engine.tygron.com/api/session/event/editoroverlay/set_image/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1, 2, 3 ], [ "Project asset name, omitting the directory 1", "Project asset name, omitting the directory 2", "Project asset name, omitting the directory 3" ] ]'

JavaScript example POST:

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