Api session event logic areas set attributes: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
API Endpoint: api/session/event/logic/areas_set_attributes/ | API Endpoint: api/session/event/logic/areas_set_attributes/ | ||
Description: Per entry in the array, set the value of the [[Attribute]] for the [[Area]] | Description: Per entry in the array, set the value of the [[Attribute]] for the [[Area]] | ||
{|class=wikitable | {|class=wikitable | ||
| Line 13: | Line 13: | ||
| REQUIRED | | REQUIRED | ||
| (AREA Integer ID or multiple integer values in array [1, 2, 3]) | | (AREA Integer ID or multiple integer values in array [1, 2, 3]) | ||
| | | [[Area]]s | ||
| | | | ||
|- | |- | ||
| Line 19: | Line 19: | ||
| REQUIRED | | REQUIRED | ||
| (String or multiple values in array ["a", "b", "c"]) | | (String or multiple values in array ["a", "b", "c"]) | ||
| | | [[Attribute]]s | ||
| | | | ||
|- | |- | ||
| 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]) | ||
| Array | | Value Array | ||
| | | | ||
|- | |- | ||
| Line 47: | Line 47: | ||
===Example POST=== | ===Example POST=== | ||
Curl example POST | Curl example POST | ||
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/logic/areas_set_attributes/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, " | <syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/logic/areas_set_attributes/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "Attribute 1", 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/logic/areas_set_attributes/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1, 2, 3 ], [ " | <syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/logic/areas_set_attributes/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1, 2, 3 ], [ "Attribute 1", "Attribute 2", "Attribute 3" ], [ 1.0, 2.0, 3.0 ] ]' | ||
</syntaxhighlight> | </syntaxhighlight> | ||
JavaScript example POST | JavaScript example POST | ||
| Line 56: | Line 56: | ||
method: "POST", | method: "POST", | ||
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" }, | headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" }, | ||
body: '[ 1, " | body: '[ 1, "Attribute 1", 1.0 ]' | ||
}; | }; | ||
fetch("https://engine.tygron.com/api/session/event/logic/areas_set_attributes/", options) | fetch("https://engine.tygron.com/api/session/event/logic/areas_set_attributes/", options) | ||
Latest revision as of 14:55, 11 November 2026
API Endpoint: api/session/event/logic/areas_set_attributes/
Description: Per entry in the array, set the value of the Attribute for the Area
| Index | Importance | Type | Description | Values |
|---|---|---|---|---|
| 0 | REQUIRED | (AREA Integer ID or multiple integer values in array [1, 2, 3]) | Areas | |
| 1 | REQUIRED | (String or multiple values in array ["a", "b", "c"]) | Attributes | |
| 2 | REQUIRED | (Floating point number or multiple values in array [1.0, 2.0, 3.0]) | Value Array | |
| 3 | OPTIONAL | (true, false) | Update Indicators (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/logic/areas_set_attributes/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "Attribute 1", 1.0 ]'Curl example multi item POST
curl 'https://engine.tygron.com/api/session/event/logic/areas_set_attributes/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1, 2, 3 ], [ "Attribute 1", "Attribute 2", "Attribute 3" ], [ 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 1", 1.0 ]'
};
fetch("https://engine.tygron.com/api/session/event/logic/areas_set_attributes/", options)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));