Api session event editor measure: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (12 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
<noinclude lang="text" copy>API Endpoint: api/session/event/editormeasure/ | |||
</noinclude><noinclude lang="text" copy> | |||
API | API Endpoints for [[Measure]] editing. | ||
{|class=wikitable | </noinclude>{|class=wikitable | ||
!Name | !Name | ||
!Description | !Description | ||
|- | |- | ||
|[[Api session event editor measure add|add]] | | [[Api session event editor measure add|add]] | ||
|Add [[Measure]] for [[Stakeholder]] | | Add [[Measure]] for [[Stakeholder]] | ||
|- | |- | ||
|[[Api session event editor measure duplicate|duplicate]] | | [[Api session event editor measure duplicate|duplicate]] | ||
|Duplicate specified [[Measure]]s | | Duplicate specified [[Measure]]s | ||
|- | |- | ||
|[[Api session event editor measure remove|remove]] | | [[Api session event editor measure remove|remove]] | ||
|Remove | | Remove existing [[Measure]] | ||
|- | |- | ||
|[[Api session event editor measure set name|set_name]] | | [[Api session event editor measure set name|set_name]] | ||
|Set the name of a [[Measure]] | | Set the name of a [[Measure]] | ||
|} | |} | ||
<noinclude lang="text" copy> | |||
Additional API | Additional API Endpoints: | ||
{|class=wikitable | </noinclude>{|class=wikitable | ||
!Name | !Name | ||
!Description | !Description | ||
|- | |- | ||
|[[Api session event editor measure add building|add_building]] | | [[Api session event editor measure add building|add_building]] | ||
|Add a new [[Building]] to specified [[Measure]]s | | Add a new [[Building]] to specified [[Measure]]s | ||
|- | |- | ||
|[[Api session event editor measure add event|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|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 [[ | | 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 [[ | | 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]] | ||
|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|add_levee_polygons]] | | [[Api session event editor measure add levee polygons|add_levee_polygons]] | ||
|Add [[ | | Add [[Polygon]]s to pre-existing outer (or inner) [[Polygon]]s of a [[Levee]] Spatial of a [[Measure]] | ||
|- | |- | ||
|[[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 [[ | | 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 [[ | | 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]] | ||
|Duplicate specified [[Measure]] [[Building]]s | | Duplicate specified [[Measure]] [[Building]]s | ||
|- | |- | ||
|[[Api session event editor measure import buildings|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|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|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|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|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|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|remove_event]] | | [[Api session event editor measure remove event|remove_event]] | ||
| | | Remove a specific Server or Client side Coded Event from a [[Measure]] for a specific [[Action]] Type | ||
|- | |- | ||
|[[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 [[ | | 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 [[ | | 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]] | ||
|Remove specified [[Levee]] Spatials from a [[Measure]] | | Remove specified [[Levee]] Spatials from a [[Measure]] | ||
|- | |- | ||
|[[Api session event editor measure remove levee polygons|remove_levee_polygons]] | | [[Api session event editor measure remove levee polygons|remove_levee_polygons]] | ||
|Remove [[ | | Remove [[Polygon]]s from pre-existing [[Polygon]]s of a [[Levee]] Spatial of a [[Measure]] | ||
|- | |- | ||
|[[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 [[ | | 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 [[ | | 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]] | ||
|Set the [[Cost]] | | Set the [[Cost]] of a [[Measure]] for a specific [[Cost]] type (construction, demolition) and whether it is fixed or per cubic meter | ||
|- | |- | ||
|[[Api session event editor measure set description|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|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 pre-existing event of a specific [[Action]] Type of a [[Measure]] | ||
|- | |- | ||
|[[Api session event editor measure set geotiff|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|set_geotiff_automatic_polygons]] | | [[Api session event editor measure set geotiff automatic polygons|set_geotiff_automatic_polygons]] | ||
|Let the [[ | | 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]] | ||
|Change the [[Grid]]s applied by a specified [[Measure]] | | Change the [[Grid]]s applied by a specified [[Measure]] | ||
|- | |- | ||
|[[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 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]] | ||
|Set the image of a [[Measure]] | | Set the image of a [[Measure]] | ||
|- | |- | ||
|[[Api session event editor measure set levee angle|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 a [[Levee]] Spatial of a [[Measure]] | ||
|- | |- | ||
|[[Api session event editor measure set levee height|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 a [[Levee]] Spatial of a [[Measure]] | ||
|- | |- | ||
|[[Api session event editor measure set levee height relative|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 a [[Levee]] Spatial of a [[Measure]] is considered relative | ||
|- | |- | ||
|[[Api session event editor measure set levee type|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|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|set_requires_confirmation]] | | [[Api session event editor measure set requires confirmation|set_requires_confirmation]] | ||
|Set whether the [[Measure]] should be confirmed by other [[Stakeholder]]s | | Set whether the [[Measure]] should be confirmed by other [[Stakeholder]]s | ||
|- | |- | ||
|[[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 [[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 [[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 | <noinclude lang="text" copy>{{article end|seealso=*[[Api Session Endpoints]] | ||
*[[Api session items measures]] | *[[Api session items measures]] | ||
}} | }} | ||
</noinclude> | |||
[[Category:API]] | [[Category:API]] | ||
Latest revision as of 10:26, 13 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 |