Api session event editor netcluster generate clusters
API Endpoint: api/session/event/editornetcluster/generate_clusters/
Description: 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.
| Index | Importance | Type | Description | Values |
|---|---|---|---|---|
| 0 | REQUIRED | (NetType or multiple values in array [a, b, c]) | Net Types | |
| 1 | REQUIRED | (Enumeration) | Clustering Type | ADD_TO_EXISTING_FOR_BUILDINGS, MAP_SECTORS, PER_ATTRIBUTE, PER_BUILDING, PER_LOAD or PER_LOAD_UNIQUE_OWNER |
| 2 | REQUIRED | (MultiPolygon with crs: EPSG:3857) | Region | |
| 3 | REQUIRED | (STAKEHOLDER Integer ID or multiple integer values in array [1, 2, 3]) | Stakeholders (allowed Building owners) | |
| 4 | REQUIRED | (Floating point number) | Cluster area size | |
| 5 | REQUIRED | (STAKEHOLDER Integer ID) | Stakeholder (default Cluster owner) | |
| 6 | REQUIRED | (String) | Cluster Attribute | |
| 7 | REQUIRED | (true, false) | Cluster Collective Loads Separately | true or false |
| 8 | OPTIONAL | (Floating point number) | Specific Cluster Attribute Value |
Response Codes
| Response Code: | Description |
|---|---|
| 204 | No Content |
| 300-600 | Codes Overview |
Example POST
Curl example POST
curl 'https://engine.tygron.com/api/session/event/editornetcluster/generate_clusters/?crs=3857' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '
[ "ELECTRICITY", "PER_LOAD", {
"type" : "MultiPolygon",
"coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ]
}, 1, 17, 1, "Cluster Attribute", true ]
'Curl example multi item POST
curl 'https://engine.tygron.com/api/session/event/editornetcluster/generate_clusters/?crs=3857' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '
[ [ "ELECTRICITY", "GAS", "HEAT" ], "PER_LOAD", {
"type" : "MultiPolygon",
"coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ]
}, [ 1, 2, 3 ], 86, 1, "Cluster Attribute", true ]
'JavaScript example POST
var options = {
method: "POST",
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
body: '[ "ELECTRICITY", "PER_LOAD", { "type" : "MultiPolygon", "coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ]}, 1, 17, 1, "Cluster Attribute", true ]'
};
fetch("https://engine.tygron.com/api/session/event/editornetcluster/generate_clusters/?crs=3857", options)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));