Api session event logic building set attributes: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 13: Line 13:
| REQUIRED
| REQUIRED
| (BUILDING Integer ID or multiple integer values in array [1, 2, 3])
| (BUILDING Integer ID or multiple integer values in array [1, 2, 3])
| Array of [[Building]] IDs
| [[Building]]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]] Names
| [[Attribute]]s
|  
|  
|-
|-
Line 41: Line 41:
===Example POST===
===Example POST===
Curl example POST
Curl example POST
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/logic/building_set_attributes/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "Attribute Name 1", [ 1.0, 2.0 ] ]'
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/logic/building_set_attributes/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "Attribute 1", [ 1.0, 2.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/building_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 ] ] ]'
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/logic/building_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, 4.0 ], [ 5.0, 6.0 ] ] ]'
</syntaxhighlight>
</syntaxhighlight>
JavaScript example POST
JavaScript example POST
Line 50: Line 50:
 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", [ 1.0, 2.0 ] ]'
 body: '[ 1, "Attribute 1", [ 1.0, 2.0 ] ]'
};
};
fetch("https://engine.tygron.com/api/session/event/logic/building_set_attributes/", options)
fetch("https://engine.tygron.com/api/session/event/logic/building_set_attributes/", options)

Revision as of 15:32, 10 November 2026

API Endpoint: api/session/event/logic/building_set_attributes/

Description: Per entry in the array, set the values of the Attribute for the Building.

Index Importance Type Description Values
0 REQUIRED (BUILDING Integer ID or multiple integer values in array [1, 2, 3]) Buildings
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] or matrix [[1.0, 2.0], [3.0, 4.0], [5.0, 6.0]]) Array of values

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/building_set_attributes/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "Attribute 1", [ 1.0, 2.0 ] ]'

Curl example multi item POST

curl 'https://engine.tygron.com/api/session/event/logic/building_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, 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 1", [ 1.0, 2.0 ] ]'
};
fetch("https://engine.tygron.com/api/session/event/logic/building_set_attributes/", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));