Api session event editor building: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 6: Line 6:
!Description
!Description
|-
|-
|[[Api session event editor building add|add]]
| [[Api session event editor building add|add]]
|Add new [[Building]]
| Add new [[Building]]
|-
|-
|[[Api session event editor building add polygons|add_polygons]]
| [[Api session event editor building add polygons|add_polygons]]
|Add [[#Api Model Polygon|Polygon]]s for [[Building]] [[Section]]. In case the [[Building]] is empty, optionally set ownership to largest [[Plot]] Owner of provided [[#Api Model MultiPolygon|MultiPolygon]]
| Add [[#Api Model Polygon|Polygon]]s for [[Building]] [[Section]]. In case the [[Building]] is empty, optionally set ownership to largest [[Plot]] Owner of provided [[#Api Model MultiPolygon|MultiPolygon]]
|-
|-
|[[Api session event editor building append attribute|append_attribute]]
| [[Api session event editor building append attribute|append_attribute]]
|Appended to existing [[Building]] [[Attribute]] value
| Appended to existing [[Building]] [[Attribute]] value
|-
|-
|[[Api session event editor building duplicate|duplicate]]
| [[Api session event editor building duplicate|duplicate]]
|Duplicate existing [[Building]]
| Duplicate existing [[Building]]
|-
|-
|[[Api session event editor building import|import]]
| [[Api session event editor building import|import]]
|Import [[Building]] Collection
| Import [[Building]] Collection
|-
|-
|[[Api session event editor building remove|remove]]
| [[Api session event editor building remove|remove]]
|Remove existing [[Building]]
| Remove existing [[Building]]
|-
|-
|[[Api session event editor building remove attribute|remove_attribute]]
| [[Api session event editor building remove attribute|remove_attribute]]
|Remove [[Attribute]] from [[Building]]
| Remove [[Attribute]] from [[Building]]
|-
|-
|[[Api session event editor building remove polygons|remove_polygons]]
| [[Api session event editor building remove polygons|remove_polygons]]
|Delete [[#Api Model Polygon|Polygon]]s for [[Building]] [[Section]]
| Delete [[#Api Model Polygon|Polygon]]s for [[Building]] [[Section]]
|-
|-
|[[Api session event editor building set attribute|set_attribute]]
| [[Api session event editor building set attribute|set_attribute]]
|Set [[Building]] [[Attribute]] value
| Set [[Building]] [[Attribute]] value
|-
|-
|[[Api session event editor building set attributes|set_attributes]]
| [[Api session event editor building set attributes|set_attributes]]
|Set multiple [[Building]] [[Attribute]] values
| Set multiple [[Building]] [[Attribute]] values
|-
|-
|[[Api session event editor building set name|set_name]]
| [[Api session event editor building set name|set_name]]
|Set new name of existing [[Building]]
| Set new name of existing [[Building]]
|}
|}


Line 45: Line 45:
!Description
!Description
|-
|-
|[[Api session event editor building add geometry|add_geometry]]
| [[Api session event editor building add geometry|add_geometry]]
|Add a custom [[Building]] geometry
| Add a custom [[Building]] geometry
|-
|-
|[[Api session event editor building add road|add_road]]
| [[Api session event editor building add road|add_road]]
|Add Road
| Add Road
|-
|-
|[[Api session event editor building add section|add_section]]
| [[Api session event editor building add section|add_section]]
|Add [[Section]]
| Add [[Section]]
|-
|-
|[[Api session event editor building add standard|add_standard]]
| [[Api session event editor building add standard|add_standard]]
|Add Standard
| Add Standard
|-
|-
|[[Api session event editor building add underground|add_underground]]
| [[Api session event editor building add underground|add_underground]]
|Add Underground
| Add Underground
|-
|-
|[[Api session event editor building duplicate section|duplicate_section]]
| [[Api session event editor building duplicate section|duplicate_section]]
|Duplicate a [[Building]] [[Section]].
| Duplicate a [[Building]] [[Section]].
|-
|-
|[[Api session event editor building generate rotation angles|generate_rotation_angles]]
| [[Api session event editor building generate rotation angles|generate_rotation_angles]]
|Calculation a rotation angle for [[Building]]s having the identifying [[Attribute]] [[#Api Model Polygon|Polygon]]s, optionally only for specified [[Building]]s.
| Calculation a rotation angle for [[Building]]s having the identifying [[Attribute]] [[#Api Model Polygon|Polygon]]s, optionally only for specified [[Building]]s.
|-
|-
|[[Api session event editor building generate water connection|generate_water_connection]]
| [[Api session event editor building generate water connection|generate_water_connection]]
|Generate Water Connection.
| Generate Water Connection.
|-
|-
|[[Api session event editor building multi select|multi_select]]
| [[Api session event editor building multi select|multi_select]]
|Multi Select
| Multi Select
|-
|-
|[[Api session event editor building query|query]]
| [[Api session event editor building query|query]]
|Executes a single [[Tygron Query Language|TQL Query]]. Note: you can also use the [[Session]]/query endpoint to execute multiple statements and get additional in[[Format]]ion on API usage.
| Executes a single [[Tygron Query Language|TQL Query]]. Note: you can also use the [[Session]]/query endpoint to execute multiple statements and get additional in[[Format]]ion on API usage.
|-
|-
|[[Api session event editor building remove geometries|remove_geometries]]
| [[Api session event editor building remove geometries|remove_geometries]]
|Remove all custom [[Building]] geometries
| Remove all custom [[Building]] geometries
|-
|-
|[[Api session event editor building remove sections|remove_sections]]
| [[Api session event editor building remove sections|remove_sections]]
|Remove [[Section]]s
| Remove [[Section]]s
|-
|-
|[[Api session event editor building reset category values|reset_category_values]]
| [[Api session event editor building reset category values|reset_category_values]]
|Reset [[Category Value]]s
| Reset [[Category Value]]s
|-
|-
|[[Api session event editor building reset function values|reset_function_values]]
| [[Api session event editor building reset function values|reset_function_values]]
|Reset [[Function Value]]s
| Reset [[Function Value]]s
|-
|-
|[[Api session event editor building reset slanting roof height|reset_slanting_roof_height]]
| [[Api session event editor building reset slanting roof height|reset_slanting_roof_height]]
|Reset [[Slanting roof height (Function Value)|Height of the Slanting Roof]] of a [[Building]] [[Section]]
| Reset [[Slanting roof height (Function Value)|Height of the Slanting Roof]] of a [[Building]] [[Section]]
|-
|-
|[[Api session event editor building set category value|set_category_value]]
| [[Api session event editor building set category value|set_category_value]]
|Set [[Category Value]]
| Set [[Category Value]]
|-
|-
|[[Api session event editor building set decals|set_decals]]
| [[Api session event editor building set decals|set_decals]]
|Set Decals
| Set Decals
|-
|-
|[[Api session event editor building set floors|set_floors]]
| [[Api session event editor building set floors|set_floors]]
|Change amount of floors
| Change amount of floors
|-
|-
|[[Api session event editor building set function|set_function]]
| [[Api session event editor building set function|set_function]]
|Set [[Function]]
| Set [[Function]]
|-
|-
|[[Api session event editor building set function value|set_function_value]]
| [[Api session event editor building set function value|set_function_value]]
|Set [[Function Value]]
| Set [[Function Value]]
|-
|-
|[[Api session event editor building set owner|set_owner]]
| [[Api session event editor building set owner|set_owner]]
|Set Owner
| Set Owner
|-
|-
|[[Api session event editor building set slanting roof height|set_slanting_roof_height]]
| [[Api session event editor building set slanting roof height|set_slanting_roof_height]]
|Change [[Slanting roof height (Function Value)|Height of the Slanting Roof]] of a [[Building]] [[Section]]
| Change [[Slanting roof height (Function Value)|Height of the Slanting Roof]] of a [[Building]] [[Section]]
|}
|}
{{article end|seealso=*[[Api Session Endpoints]]
{{article end|seealso=*[[Api Session Endpoints]]

Revision as of 11:38, 8 June 2026

API Endpoint: api/session/event/editorbuilding/

API endpoints for Building editing.

Name Description
add Add new Building
add_polygons Add Polygons for Building Section. In case the Building is empty, optionally set ownership to largest Plot Owner of provided MultiPolygon
append_attribute Appended to existing Building Attribute value
duplicate Duplicate existing Building
import Import Building Collection
remove Remove existing Building
remove_attribute Remove Attribute from Building
remove_polygons Delete Polygons for Building Section
set_attribute Set Building Attribute value
set_attributes Set multiple Building Attribute values
set_name Set new name of existing Building

Additional API endpoints:

Name Description
add_geometry Add a custom Building geometry
add_road Add Road
add_section Add Section
add_standard Add Standard
add_underground Add Underground
duplicate_section Duplicate a Building Section.
generate_rotation_angles Calculation a rotation angle for Buildings having the identifying Attribute Polygons, optionally only for specified Buildings.
generate_water_connection Generate Water Connection.
multi_select Multi Select
query Executes a single TQL Query. Note: you can also use the Session/query endpoint to execute multiple statements and get additional inFormation on API usage.
remove_geometries Remove all custom Building geometries
remove_sections Remove Sections
reset_category_values Reset Category Values
reset_function_values Reset Function Values
reset_slanting_roof_height Reset Height of the Slanting Roof of a Building Section
set_category_value Set Category Value
set_decals Set Decals
set_floors Change amount of floors
set_function Set Function
set_function_value Set Function Value
set_owner Set Owner
set_slanting_roof_height Change Height of the Slanting Roof of a Building Section