Api session event editor: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (17 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
<noinclude lang="text" copy>API Endpoint: api/session/event/editor/ | |||
</noinclude><noinclude lang="text" copy> | |||
Generic Editor | API Endpoints for Generic Editor Endpoints for creating and updating a Project | ||
{|class=wikitable | </noinclude>{|class=wikitable | ||
!Name | !Name | ||
!Description | !Description | ||
|- | |- | ||
|[[ | | [[Api session event editor activate testrun|activate_testrun]] | ||
|Start or stop a [[Scenario]] Testrun | | Start or stop a [[Scenario]] Testrun | ||
|- | |- | ||
|[[ | | [[Api session event editor clear map|clear_map]] | ||
|Remove all geospatial data of the Project, such as [[Building]], [[Area]], etc | | Remove all geospatial data of the Project, such as [[Building]]s, [[Area]]s, etc | ||
|- | |- | ||
|[[ | | [[Api session event editor set initial map size|set_initial_map_size]] | ||
|Set the size of the map. This can only be done once | | Set the size of the map. This can only be done once | ||
|- | |- | ||
|[[ | | [[Api session event editor set scheduled update|set_scheduled_update]] | ||
|Schedule a long-running update of all active [[Overlay]], [[Indicator]], [[Panel]] and [[Trigger]] | | Schedule a long-running update of all active [[Overlay]]s, [[Indicator]]s, [[Panel]]s and [[Trigger]]s | ||
|- | |- | ||
|[[ | | [[Api session event editor start map creation|start_map_creation]] | ||
|Set the Project's georeference center | | Set the Project's georeference center [[Point]] to the provided coordinates and begin automatically loading available data | ||
|- | |- | ||
|[[ | | [[Api session event editor update|update]] | ||
| | | Calculate all active [[Overlay]]s, [[Indicator]]s, [[Panel]]s and [[Trigger]]s and wait for the update. Note: for long-running calculations use: set_scheduled_update/ to schedule an update | ||
|- | |- | ||
|[[ | | [[Api session event editor update with id|update_with_id]] | ||
|Waits for update of all active [[Overlay]], [[Indicator]], [[Panel]] and [[Trigger]] with unique ID. Note: for long-running updates use: set_scheduled_update/ to schedule an update | | Waits for update of all active [[Overlay]]s, [[Indicator]]s, [[Panel]]s and [[Trigger]]s with unique ID. Note: for long-running updates use: set_scheduled_update/ to schedule an update | ||
|} | |} | ||
{{article end|seealso=*[[Api | <noinclude lang="text" copy>{{article end|seealso=*[[Api Session Endpoints]] | ||
}} | }} | ||
</noinclude> | |||
[[Category:API]] | [[Category:API]] | ||
Latest revision as of 10:25, 13 November 2026
API Endpoint: api/session/event/editor/
API Endpoints for Generic Editor Endpoints for creating and updating a Project
| Name | Description |
|---|---|
| activate_testrun | Start or stop a Scenario Testrun |
| clear_map | Remove all geospatial data of the Project, such as Buildings, Areas, etc |
| set_initial_map_size | Set the size of the map. This can only be done once |
| set_scheduled_update | Schedule a long-running update of all active Overlays, Indicators, Panels and Triggers |
| start_map_creation | Set the Project's georeference center Point to the provided coordinates and begin automatically loading available data |
| update | Calculate all active Overlays, Indicators, Panels and Triggers and wait for the update. Note: for long-running calculations use: set_scheduled_update/ to schedule an update |
| update_with_id | Waits for update of all active Overlays, Indicators, Panels and Triggers with unique ID. Note: for long-running updates use: set_scheduled_update/ to schedule an update |