Api session event editor netcluster
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 |