Api session event editor overlay set attributes: 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_attributes/ | API Endpoint: api/session/event/editoroverlay/set_attributes/ | ||
Description: Set multiple [[Overlay]] [[Attribute]] values | Description: Set multiple [[Overlay]] numeric [[Attribute]] values | ||
{|class=wikitable | {|class=wikitable | ||
| Line 12: | Line 12: | ||
| 0 | | 0 | ||
| REQUIRED | | REQUIRED | ||
| (OVERLAY Integer ID or multiple values in array [1, 2, 3]) | | (OVERLAY Integer ID or multiple integer values in array [1, 2, 3]) | ||
| [[Overlay]]s | | [[Overlay]]s | ||
| | | | ||
| Line 25: | Line 25: | ||
| REQUIRED | | REQUIRED | ||
| (Floating point number or multiple values in array [1.0, 2.0, 3.0] or matrix [[1.0, 2.0], [3.0, 4.0], [5.0, 6.0]]) | | (Floating point number or multiple values in array [1.0, 2.0, 3.0] or matrix [[1.0, 2.0], [3.0, 4.0], [5.0, 6.0]]) | ||
| [[Attribute]] Values | | Numeric [[Attribute]] Values | ||
| | | | ||
|- | |- | ||
Latest revision as of 12:22, 17 June 2026
API Endpoint: api/session/event/editoroverlay/set_attributes/
Description: Set multiple Overlay numeric Attribute values
| Index | Importance | Type | Description | Values |
|---|---|---|---|---|
| 0 | REQUIRED | (OVERLAY Integer ID or multiple integer values in array [1, 2, 3]) | Overlays | |
| 1 | REQUIRED | (String or multiple values in array ["a", "b", "c"]) | Attribute Names | |
| 2 | REQUIRED | (Floating point number or multiple values in array [1.0, 2.0, 3.0] or matrix [[1.0, 2.0], [3.0, 4.0], [5.0, 6.0]]) | Numeric 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_attributes/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "Attribute Name 1", [ 1.0, 2.0 ] ]'Curl example multi item POST
curl 'https://engine.tygron.com/api/session/event/editoroverlay/set_attributes/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1, 2, 3 ], [ "Attribute Name 1", "Attribute Name 2", "Attribute Name 3" ], [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ] ]'JavaScript example POST
var options = {
method: "POST",
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
body: '[ 1, "Attribute Name 1", [ 1.0, 2.0 ] ]'
};
fetch("https://engine.tygron.com/api/session/event/editoroverlay/set_attributes/", options)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));