Api session event editor area: 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 area add|add]]
| [[Api session event editor area add|add]]
|Add new [[Area]]
| Add new [[Area]]
|-
|-
|[[Api session event editor area add polygons|add_polygons]]
| [[Api session event editor area add polygons|add_polygons]]
|Add [[#Api Model Polygon|Polygon]]s to existing [[Area]]
| Add [[#Api Model Polygon|Polygon]]s to existing [[Area]]
|-
|-
|[[Api session event editor area append attribute|append_attribute]]
| [[Api session event editor area append attribute|append_attribute]]
|Appended to existing [[Area]] [[Attribute]] value
| Appended to existing [[Area]] [[Attribute]] value
|-
|-
|[[Api session event editor area duplicate|duplicate]]
| [[Api session event editor area duplicate|duplicate]]
|Duplicate existing [[Area]]
| Duplicate existing [[Area]]
|-
|-
|[[Api session event editor area import|import]]
| [[Api session event editor area import|import]]
|Import [[Area]] Collection
| Import [[Area]] Collection
|-
|-
|[[Api session event editor area remove|remove]]
| [[Api session event editor area remove|remove]]
|Remove existing [[Area]]
| Remove existing [[Area]]
|-
|-
|[[Api session event editor area remove attribute|remove_attribute]]
| [[Api session event editor area remove attribute|remove_attribute]]
|Remove [[Attribute]] from [[Area]]
| Remove [[Attribute]] from [[Area]]
|-
|-
|[[Api session event editor area remove polygons|remove_polygons]]
| [[Api session event editor area remove polygons|remove_polygons]]
|Remove [[#Api Model Polygon|Polygon]]s from existing [[Area]]
| Remove [[#Api Model Polygon|Polygon]]s from existing [[Area]]
|-
|-
|[[Api session event editor area set active|set_active]]
| [[Api session event editor area set active|set_active]]
|Set [[Area]] active
| Set [[Area]] active
|-
|-
|[[Api session event editor area set attribute|set_attribute]]
| [[Api session event editor area set attribute|set_attribute]]
|Set [[Area]] [[Attribute]] value
| Set [[Area]] [[Attribute]] value
|-
|-
|[[Api session event editor area set attributes|set_attributes]]
| [[Api session event editor area set attributes|set_attributes]]
|Set multiple [[Area]] [[Attribute]] values
| Set multiple [[Area]] [[Attribute]] values
|-
|-
|[[Api session event editor area set color|set_color]]
| [[Api session event editor area set color|set_color]]
|Set new color of existing [[Area]]
| Set new color of existing [[Area]]
|-
|-
|[[Api session event editor area set name|set_name]]
| [[Api session event editor area set name|set_name]]
|Set new name of existing [[Area]]
| Set new name of existing [[Area]]
|-
|-
|[[Api session event editor area set polygons|set_polygons]]
| [[Api session event editor area set polygons|set_polygons]]
|Set [[#Api Model Polygon|Polygon]]s to existing [[Area]]
| Set [[#Api Model Polygon|Polygon]]s to existing [[Area]]
|}
|}


Line 54: Line 54:
!Description
!Description
|-
|-
|[[Api session event editor area add group|add_group]]
| [[Api session event editor area add group|add_group]]
|Add Group
| Add Group
|-
|-
|[[Api session event editor area add relation|add_relation]]
| [[Api session event editor area add relation|add_relation]]
|Add [[Relation]]
| Add [[Relation]]
|-
|-
|[[Api session event editor area add with attribute|add_with_attribute]]
| [[Api session event editor area add with attribute|add_with_attribute]]
|Add With [[Attribute]]
| Add With [[Attribute]]
|-
|-
|[[Api session event editor area generate border areas|generate_border_areas]]
| [[Api session event editor area generate border areas|generate_border_areas]]
|Generate Border [[Area]]s
| Generate Border [[Area]]s
|-
|-
|[[Api session event editor area generate inundation areas|generate_inundation_areas]]
| [[Api session event editor area generate inundation areas|generate_inundation_areas]]
|Generate Inundation [[Area]]s
| Generate Inundation [[Area]]s
|-
|-
|[[Api session event editor area generate sewer areas|generate_sewer_areas]]
| [[Api session event editor area generate sewer areas|generate_sewer_areas]]
|Generate Sewer [[Area]]s for [[Neighborhood]]s
| Generate Sewer [[Area]]s for [[Neighborhood]]s
|-
|-
|[[Api session event editor area generate water areas|generate_water_areas]]
| [[Api session event editor area generate water areas|generate_water_areas]]
|Generate Water [[Area]]s
| Generate Water [[Area]]s
|-
|-
|[[Api session event editor area remove all attributes|remove_all_attributes]]
| [[Api session event editor area remove all attributes|remove_all_attributes]]
|Remove All [[Attribute]]s
| Remove All [[Attribute]]s
|-
|-
|[[Api session event editor area remove group|remove_group]]
| [[Api session event editor area remove group|remove_group]]
|Remove Group
| Remove Group
|-
|-
|[[Api session event editor area remove relations|remove_relations]]
| [[Api session event editor area remove relations|remove_relations]]
|Remove [[Relation]]s
| Remove [[Relation]]s
|-
|-
|[[Api session event editor area set relation|set_relation]]
| [[Api session event editor area set relation|set_relation]]
|Set [[Relation]]
| Set [[Relation]]
|}
|}
{{article end|seealso=*[[Api Session Endpoints]]
{{article end|seealso=*[[Api Session Endpoints]]

Revision as of 11:37, 8 June 2026

API Endpoint: api/session/event/editorarea/

API endpoints for Area editing.

Name Description
add Add new Area
add_polygons Add Polygons to existing Area
append_attribute Appended to existing Area Attribute value
duplicate Duplicate existing Area
import Import Area Collection
remove Remove existing Area
remove_attribute Remove Attribute from Area
remove_polygons Remove Polygons from existing Area
set_active Set Area active
set_attribute Set Area Attribute value
set_attributes Set multiple Area Attribute values
set_color Set new color of existing Area
set_name Set new name of existing Area
set_polygons Set Polygons to existing Area

Additional API endpoints:

Name Description
add_group Add Group
add_relation Add Relation
add_with_attribute Add With Attribute
generate_border_areas Generate Border Areas
generate_inundation_areas Generate Inundation Areas
generate_sewer_areas Generate Sewer Areas for Neighborhoods
generate_water_areas Generate Water Areas
remove_all_attributes Remove All Attributes
remove_group Remove Group
remove_relations Remove Relations
set_relation Set Relation