Api session event editor netfunction import: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older editNewer edit →
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Interface administrators, Administrators
51,321 edits
No edit summary
No edit summary
Line 1: Line 1:
API Endpoint: api/session/event/editornetfunction/import/
API Endpoint: api/session/event/editornetfunction/import/


Description: Import multiple [[Net Function]]s
Description: Import [[Net Function]]s by providing names, [[Net Type]]s and [[Attribute]]s with accompanying values.


{|class=wikitable
{|class=wikitable
Line 13: Line 13:
| REQUIRED
| REQUIRED
| (String or multiple values in array ["a", "b", "c"])
| (String or multiple values in array ["a", "b", "c"])
| String[]
| Names
|  
|  
|-
|-
Line 19: Line 19:
| REQUIRED
| REQUIRED
| (NetType or multiple values in array [a, b, c])
| (NetType or multiple values in array [a, b, c])
| [[Net Type]][]
| [[Net Type]]s
|  
|  
|-
|-
Line 25: Line 25:
| REQUIRED
| REQUIRED
| (String or multiple values in array ["a", "b", "c"])
| (String or multiple values in array ["a", "b", "c"])
| String[]
| [[Attribute]]s
|  
|  
|-
|-
Line 31: Line 31:
| 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]])
| double[][]
| [[Attribute]] Values
|  
|  
|-
|-
Line 37: Line 37:
| REQUIRED
| REQUIRED
| (SOURCE Integer ID)
| (SOURCE Integer ID)
| [[Source]]s
| [[Source]]
|  
|  
|}
|}
Line 53: Line 53:
===Example POST===
===Example POST===
Curl example POST
Curl example POST
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editornetfunction/import/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ "Text 1", "ELECTRICITY", "Text 1", [ 1.0, 2.0 ], 1 ]'
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editornetfunction/import/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ "Name 1", "ELECTRICITY", "Attribute 1", [ 1.0, 2.0 ], 1 ]'
</syntaxhighlight>
</syntaxhighlight>
Curl example multi item POST
Curl example multi item POST
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editornetfunction/import/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ "Text 1", "Text 2", "Text 3" ], [ "ELECTRICITY", "GAS", "HEAT" ], [ "Text 1", "Text 2", "Text 3" ], [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ], 1 ]'
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editornetfunction/import/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ "Name 1", "Name 2", "Name 3" ], [ "ELECTRICITY", "GAS", "HEAT" ], [ "Attribute 1", "Attribute 2", "Attribute 3" ], [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ], 1 ]'
</syntaxhighlight>
</syntaxhighlight>
JavaScript example POST
JavaScript example POST
Line 62: Line 62:
 method: "POST",
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ "Text 1", "ELECTRICITY", "Text 1", [ 1.0, 2.0 ], 1 ]'
 body: '[ "Name 1", "ELECTRICITY", "Attribute 1", [ 1.0, 2.0 ], 1 ]'
};
};
fetch("https://engine.tygron.com/api/session/event/editornetfunction/import/", options)
fetch("https://engine.tygron.com/api/session/event/editornetfunction/import/", options)

Revision as of 15:30, 10 November 2026

API Endpoint: api/session/event/editornetfunction/import/

Description: Import Net Functions by providing names, Net Types and Attributes with accompanying values.

Index Importance Type Description Values
0 REQUIRED (String or multiple values in array ["a", "b", "c"]) Names
1 REQUIRED (NetType or multiple values in array [a, b, c]) Net Types
2 REQUIRED (String or multiple values in array ["a", "b", "c"]) Attributes
3 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
4 REQUIRED (SOURCE Integer ID) Source

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

Curl example multi item POST 

curl 'https://engine.tygron.com/api/session/event/editornetfunction/import/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ "Name 1", "Name 2", "Name 3" ], [ "ELECTRICITY", "GAS", "HEAT" ], [ "Attribute 1", "Attribute 2", "Attribute 3" ], [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ], 1 ]'

JavaScript example POST 

var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ "Name 1", "ELECTRICITY", "Attribute 1", [ 1.0, 2.0 ], 1 ]'
};
fetch("https://engine.tygron.com/api/session/event/editornetfunction/import/", 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_editor_netfunction_import&oldid=96779"