Api session event editor netcluster: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
API Endpoint: api/session/event/editornetcluster/ | <noinclude lang="text" copy>API Endpoint: api/session/event/editornetcluster/ | ||
</noinclude><noinclude lang="text" copy> | |||
API Endpoints for [[Net Cluster]] editing. | API Endpoints for [[Net Cluster]] editing. | ||
{|class=wikitable | </noinclude>{|class=wikitable | ||
!Name | !Name | ||
!Description | !Description | ||
| Line 15: | Line 15: | ||
| Set the name of a [[Net Cluster]] | | Set the name of a [[Net Cluster]] | ||
|} | |} | ||
<noinclude lang="text" copy> | |||
Additional API Endpoints: | Additional API Endpoints: | ||
{|class=wikitable | </noinclude>{|class=wikitable | ||
!Name | !Name | ||
!Description | !Description | ||
| Line 45: | Line 45: | ||
| Set the [[Scenario]] in which this [[Net Cluster]] is active | | Set the [[Scenario]] in which this [[Net Cluster]] is active | ||
|} | |} | ||
{{article end|seealso=*[[Api Session Endpoints]] | <noinclude lang="text" copy>{{article end|seealso=*[[Api Session Endpoints]] | ||
*[[Api session items netclusters]] | *[[Api session items netclusters]] | ||
}} | }} | ||
</noinclude> | |||
[[Category:API]] | [[Category:API]] | ||
Latest revision as of 10:26, 13 November 2026
API Endpoint: api/session/event/editornetcluster/
API Endpoints for Net Cluster editing.
| Name | Description |
|---|---|
| add | Add new Net Cluster |
| remove | Remove existing Net Cluster |
| set_name | Set the name of a Net Cluster |
Additional API Endpoints:
| Name | Description |
|---|---|
| add_loads_in_area_to_net_cluster | Add unclustered Net Loads to a Net Cluster given a MultiPolygon |
| generate_clusters | Generate Net Clusters for a set of Net Types, using a Clustering Type, a Region, allowed owners of Buildings, cluster area size, default Stakeholder for created Net Clusters. A default Stakeholder for Net Loads without an associated Building. A Cluster Attribute and optional specific value can be used to only include specific Net Loads. Optionally, Net Loads identified as Collective can be clustered separately |
| remove_all_clusters | Remove all Net Clusters with Net Loads belonging only to a particular Net Type |
| remove_loads_in_area_from_net_cluster | Remove Net Loads from a Net Cluster given a MultiPolygon |
| remove_network | Remove a Network of a particular Net Type, with the option to keep the Root Load |
| set_fraction_connected | Set the fraction with Net Loads of this Cluster that are set to connected |
| set_owner | Set the owner of a Net Cluster |
| set_scenario | Set the Scenario in which this Net Cluster is active |