Api session items netclusters: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 23: Line 23:
   "ownerID" : 4,
   "ownerID" : 4,
   "scenarioID" : 0,
   "scenarioID" : 0,
   "version" : 1
   "version" : 3
} ]</syntaxhighlight>
} ]</syntaxhighlight>
==Limit Queries==
==Limit Queries==
Line 48: Line 48:
ZIPSMILE:  
ZIPSMILE:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netclusters/?f=ZIPSMILE&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netclusters/?f=ZIPSMILE&token=API_TOKEN</syntaxhighlight>
==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]] ID
|-
|name
|String
|
|-
|ownerID
|int
|[[Stakeholder]] ID
|-
|scenarioID
|int
|[[Scenario]] ID
|-
|version
|int
|
|}
{{article end|seealso=*[[Api Content Items]]
{{article end|seealso=*[[Api Content Items]]
*[[Api session event editor netcluster]]
*[[Api session event editor netcluster]]

Revision as of 11:52, 20 April 2026

Api session items Net Clusters Endpoints.

Edit items with event: editornetcluster.

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" : 2
}, {
  "firstTimeConnect" : true,
  "fractionConnectedOverride" : null,
  "id" : 1,
  "loadIDs" : [ 34, 284 ],
  "name" : "",
  "ownerID" : 4,
  "scenarioID" : 0,
  "version" : 3
} ]

Limit Queries

version=100:

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

Show Queries

max version:

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

size:

https://engine.tygron.com/api/session/items/netclusters/size/?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 Load ID
name String
ownerID int Stakeholder ID
scenarioID int Scenario ID
version int