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
39,237 edits
No edit summary
No edit summary
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
Api session items [[Net Cluster]]s Endpoint: /api/session/items/netclusters/
API Endpoint: /api/session/items/netclusters/


Edit items with events described at [[Api session event editor netcluster]].
Edit items with events described at [[Api session event editor netcluster]].
Line 70: Line 70:
|loadIDs
|loadIDs
|int<nowiki>[]</nowiki>
|int<nowiki>[]</nowiki>
|[[Net Load]] ID  
|[[Net Load]]s ID  
|-
|-
|name
|name

Latest revision as of 09:05, 3 June 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" : 2
} ]

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 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=83339"