Api session event editor measure: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
Api session event editor measure Events. | Api session event editor measure Events. | ||
[[Measure]] editing. | API Endpoints for [[Measure]] editing. | ||
{|class=wikitable | {|class=wikitable | ||
!Name | !Name | ||
!Description | !Description | ||
|- | |- | ||
|[[Api session event editor measure add| | |[[Api session event editor measure add|add]] | ||
|Add [[Measure]] for [[Stakeholder]] | |Add [[Measure]] for [[Stakeholder]] | ||
|- | |- | ||
|[[Api session event editor measure duplicate| | |[[Api session event editor measure duplicate|duplicate]] | ||
|Duplicate specified [[Measure]]. | |Duplicate specified [[Measure]]. | ||
|- | |- | ||
|[[Api session event editor measure remove| | |[[Api session event editor measure remove|remove]] | ||
|Remove specified [[Measure]]. | |Remove specified [[Measure]]. | ||
|- | |- | ||
|[[Api session event editor measure set name| | |[[Api session event editor measure set name|set_name]] | ||
|Set the name of a [[Measure]]. | |Set the name of a [[Measure]]. | ||
|} | |} | ||
Additional API Endpoints: | |||
{|class=wikitable | {|class=wikitable | ||
!Name | !Name | ||
!Description | !Description | ||
|- | |- | ||
|[[Api session event editor measure add building| | |[[Api session event editor measure add building|add_building]] | ||
|Add a new [[Building]] to specified [[Measure]] | |Add a new [[Building]] to specified [[Measure]] | ||
|- | |- | ||
|[[Api session event editor measure add event| | |[[Api session event editor measure add event|add_event]] | ||
|Add a new event to a [[Measure]] for a specific [[Action]] Type. | |Add a new event to a [[Measure]] for a specific [[Action]] Type. | ||
|- | |- | ||
|[[Api session event editor measure add geotiff| | |[[Api session event editor measure add geotiff|add_geotiff]] | ||
|Add a new [[GeoTIFF]] Spatial to a [[Measure]]. | |Add a new [[GeoTIFF]] Spatial to a [[Measure]]. | ||
|- | |- | ||
|[[Api session event editor measure add geotiff polygons| | |[[Api session event editor measure add geotiff polygons|add_geotiff_polygons]] | ||
|Add polygons to existing polygons of a [[GeoTIFF]] Spatial of a [[Measure]]. | |Add polygons to existing polygons of a [[GeoTIFF]] Spatial of a [[Measure]]. | ||
|- | |- | ||
|[[Api session event editor measure add grid| | |[[Api session event editor measure add grid|add_grid]] | ||
|Add a new Grid Spatial to a [[Measure]]. | |Add a new Grid Spatial to a [[Measure]]. | ||
|- | |- | ||
|[[Api session event editor measure add grid polygons| | |[[Api session event editor measure add grid polygons|add_grid_polygons]] | ||
|Add polygons to existing polygons of a Grid Spatial of a [[Measure]]. | |Add polygons to existing polygons of a Grid Spatial of a [[Measure]]. | ||
|- | |- | ||
|[[Api session event editor measure add levee| | |[[Api session event editor measure add levee|add_levee]] | ||
|Add a new [[Levee]] Spatial of a specified [[Levee]] to a [[Measure]]. | |Add a new [[Levee]] Spatial of a specified [[Levee]] to a [[Measure]]. | ||
|- | |- | ||
|[[Api session event editor measure add levee polygons| | |[[Api session event editor measure add levee polygons|add_levee_polygons]] | ||
|Add polygons to existing outer (or inner) polygons of a [[Levee]] Spatial of a [[Measure]]. | |Add polygons to existing outer (or inner) polygons of a [[Levee]] Spatial of a [[Measure]]. | ||
|- | |- | ||
|[[Api session event editor measure add terrain| | |[[Api session event editor measure add terrain|add_terrain]] | ||
|Add a new [[Terrain]] Spatial to a [[Measure]]. | |Add a new [[Terrain]] Spatial to a [[Measure]]. | ||
|- | |- | ||
|[[Api session event editor measure add terrain polygons| | |[[Api session event editor measure add terrain polygons|add_terrain_polygons]] | ||
|Add polygons to existing outer (or inner) polygons of a [[Terrain]] Spatial of a [[Measure]]. | |Add polygons to existing outer (or inner) polygons of a [[Terrain]] Spatial of a [[Measure]]. | ||
|- | |- | ||
|[[Api session event editor measure add upgrade| | |[[Api session event editor measure add upgrade|add_upgrade]] | ||
|Add a new Upgrade Spatial to a [[Measure]]. | |Add a new Upgrade Spatial to a [[Measure]]. | ||
|- | |- | ||
|[[Api session event editor measure add upgrade polygons| | |[[Api session event editor measure add upgrade polygons|add_upgrade_polygons]] | ||
|Add polygons to existing polygons of an Upgrade Spatial of a [[Measure]]. | |Add polygons to existing polygons of an Upgrade Spatial of a [[Measure]]. | ||
|- | |- | ||
|[[Api session event editor measure duplicate building| | |[[Api session event editor measure duplicate building|duplicate_building]] | ||
|Duplicate specified [[Measure]] [[Building]]. | |Duplicate specified [[Measure]] [[Building]]. | ||
|- | |- | ||
|[[Api session event editor measure import buildings| | |[[Api session event editor measure import buildings|import_buildings]] | ||
|Import [[Measure]] [[Building]] Collection | |Import [[Measure]] [[Building]] Collection | ||
|- | |- | ||
|[[Api session event editor measure import geotiffs| | |[[Api session event editor measure import geotiffs|import_geotiffs]] | ||
|Import [[Measure]] [[GeoTIFF]] Collection | |Import [[Measure]] [[GeoTIFF]] Collection | ||
|- | |- | ||
|[[Api session event editor measure import grids| | |[[Api session event editor measure import grids|import_grids]] | ||
|Import [[Measure]] Grid Collection | |Import [[Measure]] Grid Collection | ||
|- | |- | ||
|[[Api session event editor measure import levees| | |[[Api session event editor measure import levees|import_levees]] | ||
|Import [[Measure]] [[Levee]] Collection | |Import [[Measure]] [[Levee]] Collection | ||
|- | |- | ||
|[[Api session event editor measure import terrains| | |[[Api session event editor measure import terrains|import_terrains]] | ||
|Import [[Measure]] [[Terrain]] Collection | |Import [[Measure]] [[Terrain]] Collection | ||
|- | |- | ||
|[[Api session event editor measure import upgrades| | |[[Api session event editor measure import upgrades|import_upgrades]] | ||
|Import [[Measure]] Upgrade Collection | |Import [[Measure]] Upgrade Collection | ||
|- | |- | ||
|[[Api session event editor measure remove event| | |[[Api session event editor measure remove event|remove_event]] | ||
|Add a specific event of a [[Measure]] for a specific [[Action]] Type. | |Add a specific event of a [[Measure]] for a specific [[Action]] Type. | ||
|- | |- | ||
|[[Api session event editor measure remove geotiff| | |[[Api session event editor measure remove geotiff|remove_geotiff]] | ||
|Remove specified [[GeoTIFF]] Spatial from a [[Measure]]. | |Remove specified [[GeoTIFF]] Spatial from a [[Measure]]. | ||
|- | |- | ||
|[[Api session event editor measure remove geotiff polygons| | |[[Api session event editor measure remove geotiff polygons|remove_geotiff_polygons]] | ||
|Remove polygons from existing polygons of a [[GeoTIFF]]s Spatial of a [[Measure]]. | |Remove polygons from existing polygons of a [[GeoTIFF]]s Spatial of a [[Measure]]. | ||
|- | |- | ||
|[[Api session event editor measure remove geotiff terrain type| | |[[Api session event editor measure remove geotiff terrain type|remove_geotiff_terrain_type]] | ||
|Remove the [[Terrain Type]] of a [[GeoTIFF]] Spatial of a [[Measure]]. | |Remove the [[Terrain Type]] of a [[GeoTIFF]] Spatial of a [[Measure]]. | ||
|- | |- | ||
|[[Api session event editor measure remove grid| | |[[Api session event editor measure remove grid|remove_grid]] | ||
|Remove specified Grid Spatial from a [[Measure]]. | |Remove specified Grid Spatial from a [[Measure]]. | ||
|- | |- | ||
|[[Api session event editor measure remove grid polygons| | |[[Api session event editor measure remove grid polygons|remove_grid_polygons]] | ||
|Remove polygons from existing polygons of a Grid Spatial of a [[Measure]]. | |Remove polygons from existing polygons of a Grid Spatial of a [[Measure]]. | ||
|- | |- | ||
|[[Api session event editor measure remove grid terrain type| | |[[Api session event editor measure remove grid terrain type|remove_grid_terrain_type]] | ||
|Remove the [[Terrain Type]] of a Grid Spatial of a [[Measure]]. | |Remove the [[Terrain Type]] of a Grid Spatial of a [[Measure]]. | ||
|- | |- | ||
|[[Api session event editor measure remove levee| | |[[Api session event editor measure remove levee|remove_levee]] | ||
|Remove specified [[Levee]] Spatials from a [[Measure]]. | |Remove specified [[Levee]] Spatials from a [[Measure]]. | ||
|- | |- | ||
|[[Api session event editor measure remove levee polygons| | |[[Api session event editor measure remove levee polygons|remove_levee_polygons]] | ||
|Remove polygons from existing polygons of a [[Levee]] Spatial of a [[Measure]]. | |Remove polygons from existing polygons of a [[Levee]] Spatial of a [[Measure]]. | ||
|- | |- | ||
|[[Api session event editor measure remove terrain| | |[[Api session event editor measure remove terrain|remove_terrain]] | ||
|Remove specified [[Terrain]] Spatials from a [[Measure]]. | |Remove specified [[Terrain]] Spatials from a [[Measure]]. | ||
|- | |- | ||
|[[Api session event editor measure remove terrain polygons| | |[[Api session event editor measure remove terrain polygons|remove_terrain_polygons]] | ||
|Remove polygons from existing outer (or inner) polygons of a [[Terrain]] Spatial of a [[Measure]]. | |Remove polygons from existing outer (or inner) polygons of a [[Terrain]] Spatial of a [[Measure]]. | ||
|- | |- | ||
|[[Api session event editor measure remove upgrade| | |[[Api session event editor measure remove upgrade|remove_upgrade]] | ||
|Remove specified Upgrade Spatials from a [[Measure]]. | |Remove specified Upgrade Spatials from a [[Measure]]. | ||
|- | |- | ||
|[[Api session event editor measure remove upgrade polygons| | |[[Api session event editor measure remove upgrade polygons|remove_upgrade_polygons]] | ||
|Remove polygons from existing polygons of a Upgrade Spatial of a [[Measure]]. | |Remove polygons from existing polygons of a Upgrade Spatial of a [[Measure]]. | ||
|- | |- | ||
|[[Api session event editor measure set cost| | |[[Api session event editor measure set cost|set_cost]] | ||
|Set the [[Cost]] of a [[Measure]] of a particular [[Cost]] type (construction, demolition) and wether it is fixed or [[Cost]] per cubic meter. | |Set the [[Cost]] of a [[Measure]] of a particular [[Cost]] type (construction, demolition) and wether it is fixed or [[Cost]] per cubic meter. | ||
|- | |- | ||
|[[Api session event editor measure set description| | |[[Api session event editor measure set description|set_description]] | ||
|Set the description of a [[Measure]]. | |Set the description of a [[Measure]]. | ||
|- | |- | ||
|[[Api session event editor measure set event| | |[[Api session event editor measure set event|set_event]] | ||
|Change an existing event of a specific [[Action]] Type of a [[Measure]]. | |Change an existing event of a specific [[Action]] Type of a [[Measure]]. | ||
|- | |- | ||
|[[Api session event editor measure set geotiff| | |[[Api session event editor measure set geotiff|set_geotiff]] | ||
|Change the [[GeoTIFF]]s applied by a specified [[Measure]]. | |Change the [[GeoTIFF]]s applied by a specified [[Measure]]. | ||
|- | |- | ||
|[[Api session event editor measure set geotiff automatic polygons| | |[[Api session event editor measure set geotiff automatic polygons|set_geotiff_automatic_polygons]] | ||
|Let the polygons be calculated automatically based on the [[GeoTIFF]]s specified in the [[GeoTIFF]] spatial of a [[Measure]]. | |Let the polygons be calculated automatically based on the [[GeoTIFF]]s specified in the [[GeoTIFF]] spatial of a [[Measure]]. | ||
|- | |- | ||
|[[Api session event editor measure set geotiff terrain type| | |[[Api session event editor measure set geotiff terrain type|set_geotiff_terrain_type]] | ||
|Set the [[Terrain Type]] for a [[GeoTIFF]] Spatial of a [[Measure]]. | |Set the [[Terrain Type]] for a [[GeoTIFF]] Spatial of a [[Measure]]. | ||
|- | |- | ||
|[[Api session event editor measure set grid| | |[[Api session event editor measure set grid|set_grid]] | ||
|Change the Grids applied by a specified [[Measure]]. | |Change the Grids applied by a specified [[Measure]]. | ||
|- | |- | ||
|[[Api session event editor measure set grid automatic polygons| | |[[Api session event editor measure set grid automatic polygons|set_grid_automatic_polygons]] | ||
|Let the polygons be calculated automatically based on the [[Overlay]] specified in the Grid spatial of a [[Measure]]. | |Let the polygons be calculated automatically based on the [[Overlay]] specified in the Grid spatial of a [[Measure]]. | ||
|- | |- | ||
|[[Api session event editor measure set grid terrain type| | |[[Api session event editor measure set grid terrain type|set_grid_terrain_type]] | ||
|Set the [[Terrain Type]] for a Grid Spatial of a [[Measure]]. | |Set the [[Terrain Type]] for a Grid Spatial of a [[Measure]]. | ||
|- | |- | ||
|[[Api session event editor measure set image| | |[[Api session event editor measure set image|set_image]] | ||
|Set the image of a [[Measure]]. | |Set the image of a [[Measure]]. | ||
|- | |- | ||
|[[Api session event editor measure set levee angle| | |[[Api session event editor measure set levee angle|set_levee_angle]] | ||
|Set the angle of [[Levee]] Spatial of a [[Measure]]. | |Set the angle of [[Levee]] Spatial of a [[Measure]]. | ||
|- | |- | ||
|[[Api session event editor measure set levee height| | |[[Api session event editor measure set levee height|set_levee_height]] | ||
|Set the inner height of [[Levee]] Spatial of a [[Measure]]. | |Set the inner height of [[Levee]] Spatial of a [[Measure]]. | ||
|- | |- | ||
|[[Api session event editor measure set levee height relative| | |[[Api session event editor measure set levee height relative|set_levee_height_relative]] | ||
|Set whether the inner height of [[Levee]] Spatial of a [[Measure]] is considered relative. | |Set whether the inner height of [[Levee]] Spatial of a [[Measure]] is considered relative. | ||
|- | |- | ||
|[[Api session event editor measure set levee type| | |[[Api session event editor measure set levee type|set_levee_type]] | ||
|Set the [[Levee]] for a specified [[Levee]] Spatial of a [[Measure]]. | |Set the [[Levee]] for a specified [[Levee]] Spatial of a [[Measure]]. | ||
|- | |- | ||
|[[Api session event editor measure set owner| | |[[Api session event editor measure set owner|set_owner]] | ||
|Set the owner of a [[Measure]]. | |Set the owner of a [[Measure]]. | ||
|- | |- | ||
|[[Api session event editor measure set requires confirmation| | |[[Api session event editor measure set requires confirmation|set_requires_confirmation]] | ||
|Set whether the [[Measure]] should be confirmed by other [[Stakeholder]]. | |Set whether the [[Measure]] should be confirmed by other [[Stakeholder]]. | ||
|- | |- | ||
|[[Api session event editor measure set terrain edit type| | |[[Api session event editor measure set terrain edit type|set_terrain_edit_type]] | ||
|Set the Edit Type of a [[Terrain]] Spatial of a [[Measure]]. This changes the way the [[Terrain]] height is adjusted: lowered, flattened or raised. | |Set the Edit Type of a [[Terrain]] Spatial of a [[Measure]]. This changes the way the [[Terrain]] height is adjusted: lowered, flattened or raised. | ||
|- | |- | ||
|[[Api session event editor measure set terrain height| | |[[Api session event editor measure set terrain height|set_terrain_height]] | ||
|Set the inner height of [[Terrain]] Spatial of a [[Measure]]. | |Set the inner height of [[Terrain]] Spatial of a [[Measure]]. | ||
|- | |- | ||
|[[Api session event editor measure set terrain height relative| | |[[Api session event editor measure set terrain height relative|set_terrain_height_relative]] | ||
|Set whether the inner height of [[Terrain]] Spatial of a [[Measure]] is considered relative. | |Set whether the inner height of [[Terrain]] Spatial of a [[Measure]] is considered relative. | ||
|- | |- | ||
|[[Api session event editor measure set terrain type| | |[[Api session event editor measure set terrain type|set_terrain_type]] | ||
|Set the [[Terrain Type]] for a [[Terrain]] Spatial of a [[Measure]]. | |Set the [[Terrain Type]] for a [[Terrain]] Spatial of a [[Measure]]. | ||
|- | |- | ||
|[[Api session event editor measure set upgrade type| | |[[Api session event editor measure set upgrade type|set_upgrade_type]] | ||
|Set the [[Upgrade Type]] for an Upgrade Spatial of a [[Measure]]. | |Set the [[Upgrade Type]] for an Upgrade Spatial of a [[Measure]]. | ||
|} | |} | ||
Deprecated | Deprecated API Endpoints: | ||
{|class=wikitable | {|class=wikitable | ||
!Name | !Name | ||
!Description | !Description | ||
|- | |- | ||
|[[Api session event editor measure import building measure| | |[[Api session event editor measure import building measure|import_building_measure]] | ||
|Use IMPORT_BUILDINGS instead, same event with option to set existing [[Measure]]. | |Use IMPORT_BUILDINGS instead, same event with option to set existing [[Measure]]. | ||
|} | |} | ||
{{article end|seealso=*[[Api Events]] | {{article end|seealso=*[[Api Events]] | ||
}} | }} | ||
[[Category:API]] | [[Category:API]] | ||
Revision as of 11:26, 10 April 2026
Api session event editor measure Events.
API Endpoints for Measure editing.
| Name | Description |
|---|---|
| add | Add Measure for Stakeholder |
| duplicate | Duplicate specified Measure. |
| remove | Remove specified Measure. |
| set_name | Set the name of a Measure. |
Additional API Endpoints:
| Name | Description |
|---|---|
| add_building | Add a new Building to specified Measure |
| add_event | Add a new event to a Measure for a specific Action Type. |
| add_geotiff | Add a new GeoTIFF Spatial to a Measure. |
| add_geotiff_polygons | Add polygons to existing polygons of a GeoTIFF Spatial of a Measure. |
| add_grid | Add a new Grid Spatial to a Measure. |
| add_grid_polygons | Add polygons to existing polygons of a Grid Spatial of a Measure. |
| add_levee | Add a new Levee Spatial of a specified Levee to a Measure. |
| add_levee_polygons | Add polygons to existing outer (or inner) polygons of a Levee Spatial of a Measure. |
| add_terrain | Add a new Terrain Spatial to a Measure. |
| add_terrain_polygons | Add polygons to existing outer (or inner) polygons of a Terrain Spatial of a Measure. |
| add_upgrade | Add a new Upgrade Spatial to a Measure. |
| add_upgrade_polygons | Add polygons to existing polygons of an Upgrade Spatial of a Measure. |
| duplicate_building | Duplicate specified Measure Building. |
| import_buildings | Import Measure Building Collection |
| import_geotiffs | Import Measure GeoTIFF Collection |
| import_grids | Import Measure Grid Collection |
| import_levees | Import Measure Levee Collection |
| import_terrains | Import Measure Terrain Collection |
| import_upgrades | Import Measure Upgrade Collection |
| remove_event | Add a specific event of a Measure for a specific Action Type. |
| remove_geotiff | Remove specified GeoTIFF Spatial from a Measure. |
| remove_geotiff_polygons | Remove polygons from existing polygons of a GeoTIFFs Spatial of a Measure. |
| remove_geotiff_terrain_type | Remove the Terrain Type of a GeoTIFF Spatial of a Measure. |
| remove_grid | Remove specified Grid Spatial from a Measure. |
| remove_grid_polygons | Remove polygons from existing polygons of a Grid Spatial of a Measure. |
| remove_grid_terrain_type | Remove the Terrain Type of a Grid Spatial of a Measure. |
| remove_levee | Remove specified Levee Spatials from a Measure. |
| remove_levee_polygons | Remove polygons from existing polygons of a Levee Spatial of a Measure. |
| remove_terrain | Remove specified Terrain Spatials from a Measure. |
| remove_terrain_polygons | Remove polygons from existing outer (or inner) polygons of a Terrain Spatial of a Measure. |
| remove_upgrade | Remove specified Upgrade Spatials from a Measure. |
| remove_upgrade_polygons | Remove polygons from existing polygons of a Upgrade Spatial of a Measure. |
| set_cost | Set the Cost of a Measure of a particular Cost type (construction, demolition) and wether it is fixed or Cost per cubic meter. |
| set_description | Set the description of a Measure. |
| set_event | Change an existing event of a specific Action Type of a Measure. |
| set_geotiff | Change the GeoTIFFs applied by a specified Measure. |
| set_geotiff_automatic_polygons | Let the polygons be calculated automatically based on the GeoTIFFs specified in the GeoTIFF spatial of a Measure. |
| set_geotiff_terrain_type | Set the Terrain Type for a GeoTIFF Spatial of a Measure. |
| set_grid | Change the Grids applied by a specified Measure. |
| set_grid_automatic_polygons | Let the polygons be calculated automatically based on the Overlay specified in the Grid spatial of a Measure. |
| set_grid_terrain_type | Set the Terrain Type for a Grid Spatial of a Measure. |
| set_image | Set the image of a Measure. |
| set_levee_angle | Set the angle of Levee Spatial of a Measure. |
| set_levee_height | Set the inner height of Levee Spatial of a Measure. |
| set_levee_height_relative | Set whether the inner height of Levee Spatial of a Measure is considered relative. |
| set_levee_type | Set the Levee for a specified Levee Spatial of a Measure. |
| set_owner | Set the owner of a Measure. |
| set_requires_confirmation | Set whether the Measure should be confirmed by other Stakeholder. |
| set_terrain_edit_type | Set the Edit Type of a Terrain Spatial of a Measure. This changes the way the Terrain height is adjusted: lowered, flattened or raised. |
| set_terrain_height | Set the inner height of Terrain Spatial of a Measure. |
| set_terrain_height_relative | Set whether the inner height of Terrain Spatial of a Measure is considered relative. |
| set_terrain_type | Set the Terrain Type for a Terrain Spatial of a Measure. |
| set_upgrade_type | Set the Upgrade Type for an Upgrade Spatial of a Measure. |
Deprecated API Endpoints:
| Name | Description |
|---|---|
| import_building_measure | Use IMPORT_BUILDINGS instead, same event with option to set existing Measure. |