Api session event editor overlay set attribute: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
API Endpoint: api/session/event/editoroverlay/set_attribute/ | API Endpoint: api/session/event/editoroverlay/set_attribute/ | ||
Description: Set [[Overlay]] | Description: Set [[Overlay]] [[Attribute]] value | ||
{|class=wikitable | {|class=wikitable | ||
| Line 13: | Line 13: | ||
|REQUIRED | |REQUIRED | ||
|(OVERLAY Integer ID or multiple values in array [1, 2, 3]) | |(OVERLAY Integer ID or multiple values in array [1, 2, 3]) | ||
|[[Overlay]] | |[[Overlay]]s | ||
| | | | ||
|- | |- | ||
| Line 19: | Line 19: | ||
|REQUIRED | |REQUIRED | ||
|(String) | |(String) | ||
|Attribute Name | |[[Attribute]] Name | ||
| | | | ||
|- | |- | ||
| Line 25: | Line 25: | ||
|REQUIRED | |REQUIRED | ||
|(Floating point number or multiple values in array [1.0, 2.0, 3.0]) | |(Floating point number or multiple values in array [1.0, 2.0, 3.0]) | ||
|Attribute Values | |[[Attribute]] Values | ||
| | | | ||
|- | |- | ||
| Line 48: | Line 48: | ||
Curl example POST: | Curl example POST: | ||
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editoroverlay/set_attribute/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "Attribute Name", 1.0 | <syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editoroverlay/set_attribute/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "Attribute Name", 1.0 ]' | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Curl example multi item POST: | Curl example multi item POST: | ||
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editoroverlay/set_attribute/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1, 2, 3 ], "Attribute Name", [ 1.0, 2.0, 3.0 ] | <syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editoroverlay/set_attribute/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1, 2, 3 ], "Attribute Name", [ 1.0, 2.0, 3.0 ] ]' | ||
</syntaxhighlight> | </syntaxhighlight> | ||
JavaScript example POST: | JavaScript example POST: | ||
| Line 59: | Line 59: | ||
method: "POST", | method: "POST", | ||
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" }, | headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" }, | ||
body: '[ 1, "Attribute Name", 1.0 | body: '[ 1, "Attribute Name", 1.0 ]' | ||
}; | }; | ||
fetch("https://engine.tygron.com/api/session/event/editoroverlay/set_attribute/", options) | fetch("https://engine.tygron.com/api/session/event/editoroverlay/set_attribute/", options) | ||
Latest revision as of 14:46, 2 June 2026
API Endpoint: api/session/event/editoroverlay/set_attribute/
Description: Set Overlay Attribute value
| Name | Importance | Type | Description | Values |
|---|---|---|---|---|
| 0 | REQUIRED | (OVERLAY Integer ID or multiple values in array [1, 2, 3]) | Overlays | |
| 1 | REQUIRED | (String) | Attribute Name | |
| 2 | REQUIRED | (Floating point number or multiple values in array [1.0, 2.0, 3.0]) | Attribute Values | |
| 3 | OPTIONAL | (SOURCE Integer ID) | Source (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/set_attribute/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "Attribute Name", 1.0 ]'Curl example multi item POST:
curl 'https://engine.tygron.com/api/session/event/editoroverlay/set_attribute/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1, 2, 3 ], "Attribute Name", [ 1.0, 2.0, 3.0 ] ]'JavaScript example POST:
var options = {
method: "POST",
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
body: '[ 1, "Attribute Name", 1.0 ]'
};
fetch("https://engine.tygron.com/api/session/event/editoroverlay/set_attribute/", options)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));