Api session event logic areas set attributes: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
Created page with "API Endpoint: api/session/event/logic/areas_set_attributes/ Description: Per entry in the array, set the value of the attribute for the Area. {|class=wikitable !Name !Importance !Type !Description !Values |- |0 |REQUIRED |(AREA Integer ID or multiple values in array [1, 2, 3]) |Array of Area IDs | |- |1 |REQUIRED |(String or multiple values in array ["a", "b", "c"]) |Array of Attributes | |- |2 |REQUIRED |(Floating point number or multiple values in array [1.0,..."
 
No edit summary
 
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 19: Line 19:
|REQUIRED
|REQUIRED
|(String or multiple values in array ["a", "b", "c"])
|(String or multiple values in array ["a", "b", "c"])
|Array of Attributes
|Array of [[Attribute]]s
|
|
|-
|-
Line 31: Line 31:
|OPTIONAL
|OPTIONAL
|(true, false)
|(true, false)
|Update [[Indicator]] (optional)
|Update [[Indicator]]s (optional)
|
|
|}
|}

Latest revision as of 14:49, 2 June 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.

Name Importance Type Description Values
0 REQUIRED (AREA Integer ID or multiple values in array [1, 2, 3]) Array of Area IDs
1 REQUIRED (String or multiple values in array ["a", "b", "c"]) Array of Attributes
2 REQUIRED (Floating point number or multiple values in array [1.0, 2.0, 3.0]) Array of Values
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, "Array of 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 ], [ "Array of Attribute 1", "Array of Attribute 2", "Array of 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, "Array of 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));