Api session event editor measure: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 31: | Line 31: | ||
|- | |- | ||
| [[Api session event editor measure add geotiff|add_geotiff]] | | [[Api session event editor measure add geotiff|add_geotiff]] | ||
| Add a new [[GeoTIFF]] | | Add a new [[GeoTIFF Spatial]] to a [[Measure]]. | ||
|- | |- | ||
| [[Api session event editor measure add geotiff polygons|add_geotiff_polygons]] | | [[Api session event editor measure add geotiff polygons|add_geotiff_polygons]] | ||
| Add [[Polygon]]s to pre-existing [[Polygon]]s of a [[GeoTIFF]] | | Add [[Polygon]]s to pre-existing [[Polygon]]s of a [[GeoTIFF Spatial]] of a [[Measure]]. | ||
|- | |- | ||
| [[Api session event editor measure add grid|add_grid]] | | [[Api session event editor measure add grid|add_grid]] | ||
| Add a new [[Grid]] | | Add a new [[Grid Spatial]] to a [[Measure]]. | ||
|- | |- | ||
| [[Api session event editor measure add grid polygons|add_grid_polygons]] | | [[Api session event editor measure add grid polygons|add_grid_polygons]] | ||
| Add [[Polygon]]s to pre-existing [[Polygon]]s of a [[Grid]] | | Add [[Polygon]]s to pre-existing [[Polygon]]s of a [[Grid Spatial]] of a [[Measure]]. | ||
|- | |- | ||
| [[Api session event editor measure add levee|add_levee]] | | [[Api session event editor measure add levee|add_levee]] | ||
| Line 49: | Line 49: | ||
|- | |- | ||
| [[Api session event editor measure add terrain|add_terrain]] | | [[Api session event editor measure add terrain|add_terrain]] | ||
| Add a new [[Terrain]] | | Add a new [[Terrain Spatial]] to a [[Measure]]. | ||
|- | |- | ||
| [[Api session event editor measure add terrain polygons|add_terrain_polygons]] | | [[Api session event editor measure add terrain polygons|add_terrain_polygons]] | ||
| Add [[Polygon]]s to pre-existing outer (or inner) [[Polygon]]s of a [[Terrain]] | | Add [[Polygon]]s to pre-existing outer (or inner) [[Polygon]]s of a [[Terrain Spatial]] of a [[Measure]]. | ||
|- | |- | ||
| [[Api session event editor measure add upgrade|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|add_upgrade_polygons]] | | [[Api session event editor measure add upgrade polygons|add_upgrade_polygons]] | ||
| Add [[Polygon]]s to pre-existing [[Polygon]]s of an Upgrade Spatial of a [[Measure]]. | | Add [[Polygon]]s to pre-existing [[Polygon]]s of an [[Upgrade Spatial]] of a [[Measure]]. | ||
|- | |- | ||
| [[Api session event editor measure duplicate building|duplicate_building]] | | [[Api session event editor measure duplicate building|duplicate_building]] | ||
| Line 85: | Line 85: | ||
|- | |- | ||
| [[Api session event editor measure remove geotiff|remove_geotiff]] | | [[Api session event editor measure remove geotiff|remove_geotiff]] | ||
| Remove specified [[GeoTIFF]] | | Remove specified [[GeoTIFF Spatial]] from a [[Measure]]. | ||
|- | |- | ||
| [[Api session event editor measure remove geotiff polygons|remove_geotiff_polygons]] | | [[Api session event editor measure remove geotiff polygons|remove_geotiff_polygons]] | ||
| Remove [[Polygon]]s from pre-existing [[Polygon]]s of a [[GeoTIFF]] | | Remove [[Polygon]]s from pre-existing [[Polygon]]s of a [[GeoTIFF Spatial]] of a [[Measure]]. | ||
|- | |- | ||
| [[Api session event editor measure remove geotiff terrain type|remove_geotiff_terrain_type]] | | [[Api session event editor measure remove geotiff terrain type|remove_geotiff_terrain_type]] | ||
| Remove the [[Terrain Type]] of a [[GeoTIFF]] | | Remove the [[Terrain Type]] of a [[GeoTIFF Spatial]] of a [[Measure]]. | ||
|- | |- | ||
| [[Api session event editor measure remove grid|remove_grid]] | | [[Api session event editor measure remove grid|remove_grid]] | ||
| Remove specified [[Grid]] | | Remove specified [[Grid Spatial]] from a [[Measure]]. | ||
|- | |- | ||
| [[Api session event editor measure remove grid polygons|remove_grid_polygons]] | | [[Api session event editor measure remove grid polygons|remove_grid_polygons]] | ||
| Remove [[Polygon]]s from pre-existing [[Polygon]]s of a [[Grid]] | | Remove [[Polygon]]s from pre-existing [[Polygon]]s of a [[Grid Spatial]] of a [[Measure]]. | ||
|- | |- | ||
| [[Api session event editor measure remove grid terrain type|remove_grid_terrain_type]] | | [[Api session event editor measure remove grid terrain type|remove_grid_terrain_type]] | ||
| Remove the [[Terrain Type]] of a [[Grid]] | | Remove the [[Terrain Type]] of a [[Grid Spatial]] of a [[Measure]]. | ||
|- | |- | ||
| [[Api session event editor measure remove levee|remove_levee]] | | [[Api session event editor measure remove levee|remove_levee]] | ||
| Line 109: | Line 109: | ||
|- | |- | ||
| [[Api session event editor measure remove terrain|remove_terrain]] | | [[Api session event editor measure remove terrain|remove_terrain]] | ||
| Remove specified [[Terrain]] | | Remove specified [[Terrain Spatial]]s from a [[Measure]]. | ||
|- | |- | ||
| [[Api session event editor measure remove terrain polygons|remove_terrain_polygons]] | | [[Api session event editor measure remove terrain polygons|remove_terrain_polygons]] | ||
| Remove [[Polygon]]s from pre-existing outer (or inner) [[Polygon]]s of a [[Terrain]] | | Remove [[Polygon]]s from pre-existing outer (or inner) [[Polygon]]s of a [[Terrain Spatial]] of a [[Measure]]. | ||
|- | |- | ||
| [[Api session event editor measure remove upgrade|remove_upgrade]] | | [[Api session event editor measure remove upgrade|remove_upgrade]] | ||
| Remove specified Upgrade | | Remove specified [[Upgrade Spatial]]s from a [[Measure]]. | ||
|- | |- | ||
| [[Api session event editor measure remove upgrade polygons|remove_upgrade_polygons]] | | [[Api session event editor measure remove upgrade polygons|remove_upgrade_polygons]] | ||
| Remove [[Polygon]]s from an Upgrade Spatial of a [[Measure]]. | | Remove [[Polygon]]s from an [[Upgrade Spatial]] of a [[Measure]]. | ||
|- | |- | ||
| [[Api session event editor measure set cost|set_cost]] | | [[Api session event editor measure set cost|set_cost]] | ||
| Line 133: | Line 133: | ||
|- | |- | ||
| [[Api session event editor measure set geotiff automatic polygons|set_geotiff_automatic_polygons]] | | [[Api session event editor measure set geotiff automatic polygons|set_geotiff_automatic_polygons]] | ||
| Let the [[Polygon]]s be calculated automatically based on the [[GeoTIFF]]s specified in the [[GeoTIFF]] | | Let the [[Polygon]]s 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|set_geotiff_terrain_type]] | | [[Api session event editor measure set geotiff terrain type|set_geotiff_terrain_type]] | ||
| Set the [[Terrain Type]] for a [[GeoTIFF]] | | Set the [[Terrain Type]] for a [[GeoTIFF Spatial]] of a [[Measure]]. | ||
|- | |- | ||
| [[Api session event editor measure set grid|set_grid]] | | [[Api session event editor measure set grid|set_grid]] | ||
| Line 142: | Line 142: | ||
|- | |- | ||
| [[Api session event editor measure set grid automatic polygons|set_grid_automatic_polygons]] | | [[Api session event editor measure set grid automatic polygons|set_grid_automatic_polygons]] | ||
| Automatically calculate [[Polygon]]s based on the [[Overlay]] specified in the [[Grid]] | | Automatically calculate [[Polygon]]s based on the [[Overlay]] specified in the [[Grid Spatial]] of a [[Measure]]. | ||
|- | |- | ||
| [[Api session event editor measure set grid terrain type|set_grid_terrain_type]] | | [[Api session event editor measure set grid terrain type|set_grid_terrain_type]] | ||
| Set the [[Terrain Type]] for a [[Grid]] | | Set the [[Terrain Type]] for a [[Grid Spatial]] of a [[Measure]]. | ||
|- | |- | ||
| [[Api session event editor measure set image|set_image]] | | [[Api session event editor measure set image|set_image]] | ||
| Line 169: | Line 169: | ||
|- | |- | ||
| [[Api session event editor measure set terrain edit type|set_terrain_edit_type]] | | [[Api session event editor measure set terrain edit type|set_terrain_edit_type]] | ||
| Set the Edit Type of a [[Terrain]] | | 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|set_terrain_height]] | | [[Api session event editor measure set terrain height|set_terrain_height]] | ||
| Set the inner height of a [[Terrain]] | | Set the inner height of a [[Terrain Spatial]] of a [[Measure]]. | ||
|- | |- | ||
| [[Api session event editor measure set terrain height relative|set_terrain_height_relative]] | | [[Api session event editor measure set terrain height relative|set_terrain_height_relative]] | ||
| Set whether the inner height of a [[Terrain]] | | Set whether the inner height of a [[Terrain Spatial]] of a [[Measure]] is considered relative. | ||
|- | |- | ||
| [[Api session event editor measure set terrain type|set_terrain_type]] | | [[Api session event editor measure set terrain type|set_terrain_type]] | ||
| Set the [[Terrain Type]] for a [[Terrain]] | | Set the [[Terrain Type]] for a [[Terrain Spatial]] of a [[Measure]]. | ||
|- | |- | ||
| [[Api session event editor measure set upgrade type|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]]. | ||
|} | |} | ||
{{article end|seealso=*[[Api Session Endpoints]] | {{article end|seealso=*[[Api Session Endpoints]] | ||
Revision as of 16:04, 10 November 2026
API Endpoint: api/session/event/editormeasure/
API Endpoints for Measure editing.
| Name | Description |
|---|---|
| add | Add Measure for Stakeholder |
| duplicate | Duplicate specified Measures. |
| remove | Remove existing Measure |
| set_name | Set the name of a Measure. |
Additional API Endpoints:
| Name | Description |
|---|---|
| add_building | Add a new Building to specified Measures |
| 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 pre-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 pre-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 pre-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 pre-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 pre-existing Polygons of an Upgrade Spatial of a Measure. |
| duplicate_building | Duplicate specified Measure Buildings. |
| 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 | Remove a specific Server or Client side Coded Event from a Measure for a specific Action Type |
| remove_geotiff | Remove specified GeoTIFF Spatial from a Measure. |
| remove_geotiff_polygons | Remove Polygons from pre-existing Polygons of a GeoTIFF 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 pre-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 pre-existing Polygons of a Levee Spatial of a Measure. |
| remove_terrain | Remove specified Terrain Spatials from a Measure. |
| remove_terrain_polygons | Remove Polygons from pre-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 an Upgrade Spatial of a Measure. |
| set_cost | Set the Cost of a Measure for a specific Cost type (construction, demolition) and whether it is fixed or per cubic meter. |
| set_description | Set the description of a Measure. |
| set_event | Change an pre-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 | Automatically calculate Polygons 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 a Levee Spatial of a Measure. |
| set_levee_height | Set the inner height of a Levee Spatial of a Measure. |
| set_levee_height_relative | Set whether the inner height of a 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 Stakeholders. |
| 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 a Terrain Spatial of a Measure. |
| set_terrain_height_relative | Set whether the inner height of a 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. |