Api session event editor netcluster generate clusters: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
Line 76: Line 76:


with content:  
with content:  
<pre>[ [ "GAS", "HEAT", "ELECTRICITY" ], "PER_ATTRIBUTE", {
<pre>[ [ "ELECTRICITY", "ELECTRICITY", "HEAT" ], "PER_BUILDING", {
  "type" : "MultiPolygon",
  "type" : "MultiPolygon",
  "coordinates" : [ [ [ [ 658636.7618515313, 6799461.8964563515 ], [ 658636.7618515313, 6799386.640836143 ], [ 658793.0394747535, 6799386.640836143 ], [ 658793.0394747535, 6799461.8964563515 ], [ 658636.7618515313, 6799461.8964563515 ] ] ] ]
  "coordinates" : [ [ [ [ 658636.7618515313, 6799461.8964563515 ], [ 658636.7618515313, 6799445.612884254 ], [ 658712.5310485815, 6799445.612884254 ], [ 658712.5310485815, 6799461.8964563515 ], [ 658636.7618515313, 6799461.8964563515 ] ] ] ]
}, [ 1, 2, 3 ], 23, 51, "Text", false, "" ]
}, [ 1, 2, 3 ], 82, 88, "Text", false, "" ]
</pre>
</pre>
{{article end|seealso=*[[api session event editor netcluster]]
{{article end|seealso=*[[Api session event editor netcluster]]
*[[api session items netclusters]]
*[[Api session items netclusters]]
}}
}}


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

Latest revision as of 12:08, 1 April 2026

API Event to Generate Clusters

Name Importance Type Description Values
0 REQUIRED (NetType or multiple values in array [a, b, c]) NetType[]
1 REQUIRED (Enumeration) ClusteringType 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) MultiPolygon
3 REQUIRED (Integer number or multiple values in array [1, 2, 3]) Integer[]
4 REQUIRED (Floating point number) Double
5 REQUIRED (STAKEHOLDER Integer ID) Stakeholder
6 REQUIRED (String) String
7 REQUIRED (true, false) Boolean true or false
8 OPTIONAL (Floating point number) Double

Response Codes

Response Code: Description
204 No Content
300-600 Codes Overview

Example POST

Example POST: https://engine.tygron.com/api/session/event/editornetcluster/generate_clusters/?crs=3857&f=JSON&token=API_TOKEN

with content:

[ [ "ELECTRICITY", "ELECTRICITY", "HEAT" ], "PER_BUILDING", {
 "type" : "MultiPolygon",
 "coordinates" : [ [ [ [ 658636.7618515313, 6799461.8964563515 ], [ 658636.7618515313, 6799445.612884254 ], [ 658712.5310485815, 6799445.612884254 ], [ 658712.5310485815, 6799461.8964563515 ], [ 658636.7618515313, 6799461.8964563515 ] ] ] ]
}, [ 1, 2, 3 ], 82, 88, "Text", false, "" ]