Api session event editor building set attributes: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
API Endpoint: api/session/event/editorbuilding/set_attributes/ | API Endpoint: api/session/event/editorbuilding/set_attributes/ | ||
Description: Set multiple [[Building]] [[Attribute]] values | Description: Set multiple [[Building]] numeric [[Attribute]] values | ||
{|class=wikitable | {|class=wikitable | ||
! | !Index | ||
!Importance | !Importance | ||
!Type | !Type | ||
| Line 10: | Line 10: | ||
!Values | !Values | ||
|- | |- | ||
|0 | | 0 | ||
|REQUIRED | | REQUIRED | ||
|(BUILDING Integer ID or multiple values in array [1, 2, 3]) | | (BUILDING Integer ID or multiple integer values in array [1, 2, 3]) | ||
|[[Building]]s | | [[Building]]s | ||
| | | | ||
|- | |- | ||
|1 | | 1 | ||
|REQUIRED | | REQUIRED | ||
|(String or multiple values in array ["a", "b", "c"]) | | (String or multiple values in array ["a", "b", "c"]) | ||
|[[Attribute]] Names | | [[Attribute]] Names | ||
| | | | ||
|- | |- | ||
|2 | | 2 | ||
|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 | ||
| | | | ||
|- | |- | ||
|3 | | 3 | ||
|OPTIONAL | | OPTIONAL | ||
|(SOURCE Integer ID) | | (SOURCE Integer ID) | ||
|[[Source]] (optional) | | [[Source]] (optional) | ||
| | | | ||
|} | |} | ||
===Response Codes=== | ===Response Codes=== | ||
| Line 39: | Line 39: | ||
!Description | !Description | ||
|- | |- | ||
|204 | | 204 | ||
|No Content | | No Content | ||
|- | |- | ||
|300-600 | | 300-600 | ||
|Codes Overview | | Codes Overview | ||
|} | |} | ||
===Example POST=== | ===Example POST=== | ||
Curl example POST | Curl example POST | ||
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorbuilding/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/editorbuilding/set_attributes/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "Attribute Name 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/editorbuilding/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/editorbuilding/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> | </syntaxhighlight> | ||
JavaScript example POST | JavaScript example POST | ||
<syntaxhighlight lang="text" copy>var options = { | <syntaxhighlight lang="text" copy>var options = { | ||
method: "POST", | method: "POST", | ||
Latest revision as of 12:21, 17 June 2026
API Endpoint: api/session/event/editorbuilding/set_attributes/
Description: Set multiple Building numeric Attribute values
| 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"]) | 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/editorbuilding/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/editorbuilding/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/editorbuilding/set_attributes/", options)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));