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 1: Line 1:
API Endpoint: api/session/event/editorarea/
<noinclude lang="text" copy>API Endpoint: api/session/event/editorarea/
 
</noinclude>
API Endpoints for [[Area]] editing.
API Endpoints for [[Area]] editing.
{|class=wikitable
{|class=wikitable

Revision as of 10:22, 13 November 2026

API Endpoint: api/session/event/editorarea/

API Endpoints for Area editing.

Name Description
add Add one or more Areas
add_polygons Add Polygons to existing Area
append_attribute Appended to existing Area numeric Attribute value
duplicate Duplicate existing Area
import Import Area Collection
remove Remove existing Area
remove_attribute Remove numeric Attribute from Area
remove_polygons Remove Polygons from existing Area
set_active Set Area active
set_attribute Set Area numeric Attribute value
set_attributes Set multiple Area numeric 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 a group Attribute for Areas
add_relation Add Relation
add_with_attribute Add an Area with the provided Attribute and value
generate_border_areas Generate new Areas with a specified Border Attribute and a particular width, at borders of nearby Areas, identified by a Filter Attribute
generate_inundation_areas Generate Water Inundation Area(s) with the Inundation Level Attribute set to the provided value
generate_sewer_areas Generate Sewer Areas for Neighborhoods, with a Sewer Storage depending on the Neighborhood's degree of Urbanization. A Sewer Overflow is generated for an overlapping Water Level Area identified by the provided Water Level Attribute
generate_water_areas Generate Water Level Area(s) with the Water Level Attribute set to the provided value
remove_all_attributes Remove all Attributes of an Area
remove_group Remove the provided group Attributes
remove_relations Remove Relations from an Area
set_relation Set an Area Relation to an Item ID