Api session items netclusters: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(One intermediate revision by the same user not shown)
Line 14: Line 14:
   "ownerID" : 0,
   "ownerID" : 0,
   "scenarioID" : 0,
   "scenarioID" : 0,
   "version" : 3
   "version" : 2
}, {
}, {
   "firstTimeConnect" : true,
   "firstTimeConnect" : true,
Line 23: Line 23:
   "ownerID" : 4,
   "ownerID" : 4,
   "scenarioID" : 0,
   "scenarioID" : 0,
   "version" : 2
   "version" : 1
} ]</syntaxhighlight>
} ]</syntaxhighlight>
==Limit Queries==
==Limit Queries==
Line 94: Line 94:


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

Latest revision as of 14:13, 24 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" : 1
} ]

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