Api session event logic zones set attributes: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older edit
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Interface administrators, Administrators
43,025 edits
No edit summary
No edit summary
 
(2 intermediate revisions by the same user not shown)
Line 4: Line 4:


{|class=wikitable
{|class=wikitable
!Name
!Index
!Importance
!Importance
!Type
!Type
Line 10: Line 10:
!Values
!Values
|-
|-
|0
| 0
|REQUIRED
| REQUIRED
|(ZONE Integer ID or multiple values in array [1, 2, 3])
| (ZONE Integer ID or multiple integer values in array [1, 2, 3])
|[[Zone]] IDs
| [[Zone]] IDs
|
|  
|-
|-
|1
| 1
|REQUIRED
| REQUIRED
|(String or multiple values in array ["a", "b", "c"])
| (String or multiple values in array ["a", "b", "c"])
|Valid [[Attribute]] names
| Valid [[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
| [[Attribute]] values
|
|  
|}
|}
===Response Codes===
===Response Codes===
Line 33: Line 33:
!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/logic/zones_set_attributes/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "Valid attribute name 1", [ 1.0, 2.0 ] ]'
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/logic/zones_set_attributes/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "Valid 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/logic/zones_set_attributes/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1, 2, 3 ], [ "Valid attribute name 1", "Valid attribute name 2", "Valid 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/zones_set_attributes/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1, 2, 3 ], [ "Valid attribute name 1", "Valid attribute name 2", "Valid 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:24, 17 June 2026

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

Description: Set Attributes to values for Zones.

Index Importance Type Description Values
0 REQUIRED (ZONE Integer ID or multiple integer values in array [1, 2, 3]) Zone IDs
1 REQUIRED (String or multiple values in array ["a", "b", "c"]) Valid 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]]) Attribute 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/zones_set_attributes/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "Valid attribute name 1", [ 1.0, 2.0 ] ]'

Curl example multi item POST 

curl 'https://engine.tygron.com/api/session/event/logic/zones_set_attributes/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1, 2, 3 ], [ "Valid attribute name 1", "Valid attribute name 2", "Valid 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, "Valid attribute name 1", [ 1.0, 2.0 ] ]'
};
fetch("https://engine.tygron.com/api/session/event/logic/zones_set_attributes/", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));

See also

Retrieved from "https://support.tygron.com/w/index.php?title=Api_session_event_logic_zones_set_attributes&oldid=86961"