Api session items netclusters: 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
46,429 edits
No edit summary
No edit summary
 
(42 intermediate revisions by the same user not shown)
Line 1: Line 1:
api session items [[Net Cluster]]s Endpoints.
API Endpoint: /api/session/items/netclusters/
Manipulate items with event: [[editornetcluster]].
 
==Limit Queries==version=100:  
Edit items with events described at [[Api session event editor netcluster]].
<pre>https://engine.tygron.com/api/session/items/netclusters/?version=100&token=API_TOKEN</pre>
 
==Limit Queries==max version:  
Default Query:
<pre>https://engine.tygron.com/api/session/items/netclusters/version/?token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netclusters/?f=JSON&token=API_TOKEN</syntaxhighlight>
size:  
Example Response:
<pre>https://engine.tygron.com/api/session/items/netclusters/size/?token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>[ {
==Limit Queries==HTML:  
  "firstTimeConnect" : true,
<pre>https://engine.tygron.com/api/session/items/netclusters/?f=HTML&token=API_TOKEN</pre>
  "fractionConnectedOverride" : null,
  "id" : 0,
  "loadIDs" : [ 1, 146 ],
  "name" : "",
  "ownerID" : 0,
  "scenarioID" : 0,
  "version" : 1
}, {
  "firstTimeConnect" : true,
  "fractionConnectedOverride" : null,
  "id" : 1,
  "loadIDs" : [ 34, 284 ],
  "name" : "",
  "ownerID" : 4,
  "scenarioID" : 0,
  "version" : 7
} ]</syntaxhighlight>
==Limit Queries==
version=100:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netclusters/?version=100&token=API_TOKEN</syntaxhighlight>
==Get Queries==
attributes:
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netclusters/attributes/?token=API_TOKEN</syntaxhighlight>
max version:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netclusters/version/?token=API_TOKEN</syntaxhighlight>
count:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netclusters/count/?token=API_TOKEN</syntaxhighlight>
==Formats==
HTML:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netclusters/?f=HTML&token=API_TOKEN</syntaxhighlight>
JSON:  
JSON:  
<pre>https://engine.tygron.com/api/session/items/netclusters/?f=JSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netclusters/?f=JSON&token=API_TOKEN</syntaxhighlight>
CSV:  
CSV:  
<pre>https://engine.tygron.com/api/session/items/netclusters/?f=CSV&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netclusters/?f=CSV&token=API_TOKEN</syntaxhighlight>
SSV:  
SSV:  
<pre>https://engine.tygron.com/api/session/items/netclusters/?f=SSV&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netclusters/?f=SSV&token=API_TOKEN</syntaxhighlight>
SMILE:  
SMILE:  
<pre>https://engine.tygron.com/api/session/items/netclusters/?f=SMILE&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netclusters/?f=SMILE&token=API_TOKEN</syntaxhighlight>
ZIPJSON:  
ZIPJSON:  
<pre>https://engine.tygron.com/api/session/items/netclusters/?f=ZIPJSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netclusters/?f=ZIPJSON&token=API_TOKEN</syntaxhighlight>
ZIPSMILE:  
ZIPSMILE:  
<pre>https://engine.tygron.com/api/session/items/netclusters/?f=ZIPSMILE&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netclusters/?f=ZIPSMILE&token=API_TOKEN</syntaxhighlight>
{{article end|seealso=*[[Api Content Items]]}}
==Api Model NetCluster==
API Model description of NetCluster
 
{|class=wikitable
!Name
!Type
!Description
|-
| firstTimeConnect
| boolean
|
|-
| fractionConnectedOverride
| double
|
|-
| id
| int
|
|-
| loadIDs
| int<nowiki>[]</nowiki>
| [[Net Load]]s ID
|-
| name
| String
|
|-
| ownerID
| int
| [[Stakeholder]] ID
|-
| scenarioID
| int
| [[Scenario]] ID
|-
| version
| int
|
|}
 
{{article end|seealso=*[[Api Content Items]]
*[[Api session event editor netcluster]]
}}


[[Category:API]]
[[Category:API]]
[[Category:Items]]

Latest revision as of 07:06, 14 July 2026

API Endpoint: /api/session/items/netclusters/

Edit items with events described at Api session event editor netcluster.

Default Query: 

https://engine.tygron.com/api/session/items/netclusters/?f=JSON&token=API_TOKEN

Example Response: 

[ {
  "firstTimeConnect" : true,
  "fractionConnectedOverride" : null,
  "id" : 0,
  "loadIDs" : [ 1, 146 ],
  "name" : "",
  "ownerID" : 0,
  "scenarioID" : 0,
  "version" : 1
}, {
  "firstTimeConnect" : true,
  "fractionConnectedOverride" : null,
  "id" : 1,
  "loadIDs" : [ 34, 284 ],
  "name" : "",
  "ownerID" : 4,
  "scenarioID" : 0,
  "version" : 7
} ]

Limit Queries

version=100: 

https://engine.tygron.com/api/session/items/netclusters/?version=100&token=API_TOKEN

Get Queries

attributes: 

https://engine.tygron.com/api/session/items/netclusters/attributes/?token=API_TOKEN

max version: 

https://engine.tygron.com/api/session/items/netclusters/version/?token=API_TOKEN

count: 

https://engine.tygron.com/api/session/items/netclusters/count/?token=API_TOKEN

Formats

HTML: 

https://engine.tygron.com/api/session/items/netclusters/?f=HTML&token=API_TOKEN

JSON: 

https://engine.tygron.com/api/session/items/netclusters/?f=JSON&token=API_TOKEN

CSV: 

https://engine.tygron.com/api/session/items/netclusters/?f=CSV&token=API_TOKEN

SSV: 

https://engine.tygron.com/api/session/items/netclusters/?f=SSV&token=API_TOKEN

SMILE: 

https://engine.tygron.com/api/session/items/netclusters/?f=SMILE&token=API_TOKEN

ZIPJSON: 

https://engine.tygron.com/api/session/items/netclusters/?f=ZIPJSON&token=API_TOKEN

ZIPSMILE: 

https://engine.tygron.com/api/session/items/netclusters/?f=ZIPSMILE&token=API_TOKEN

Api Model NetCluster

API Model description of NetCluster

Name Type Description
firstTimeConnect boolean
fractionConnectedOverride double
id int
loadIDs int[] Net Loads ID
name String
ownerID int Stakeholder ID
scenarioID int Scenario ID
version int

See also

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