Api session event editor netload set attributes: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 10: Line 10:
!Values
!Values
|-
|-
|0
| 0
|REQUIRED
| REQUIRED
|(NET_LOAD Integer ID or multiple values in array [1, 2, 3])
| (NET_LOAD Integer ID or multiple values in array [1, 2, 3])
|[[Net Load]]s
| [[Net Load]]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
| [[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===

Revision as of 11:40, 8 June 2026

API Endpoint: api/session/event/editornetload/set_attributes/

Description: Set multiple Net Load Attribute values

Name Importance Type Description Values
0 REQUIRED (NET_LOAD Integer ID or multiple values in array [1, 2, 3]) Net Loads
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]]) 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/editornetload/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/editornetload/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/editornetload/set_attributes/", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));