Api session event editor scenario: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (15 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
<noinclude lang="text" copy>API Endpoint: api/session/event/editorscenario/ | |||
</noinclude><noinclude lang="text" copy> | |||
API Endpoints for [[Scenario]] editing. | API Endpoints for [[Scenario]] editing. | ||
{|class=wikitable | </noinclude>{|class=wikitable | ||
!Name | !Name | ||
!Description | !Description | ||
|- | |- | ||
|[[Api session event editor scenario add|add]] | | [[Api session event editor scenario add|add]] | ||
|Add new [[Scenario]] | | Add new [[Scenario]] | ||
|- | |- | ||
|[[Api session event editor scenario append attribute|append_attribute]] | | [[Api session event editor scenario append attribute|append_attribute]] | ||
|Appended to existing [[Scenario]] | | Appended to existing [[Scenario]] numeric [[Attribute]] value | ||
|- | |- | ||
|[[Api session event editor scenario duplicate|duplicate]] | | [[Api session event editor scenario duplicate|duplicate]] | ||
|Duplicate existing [[Scenario]] | | Duplicate existing [[Scenario]] | ||
|- | |- | ||
|[[Api session event editor scenario remove|remove]] | | [[Api session event editor scenario remove|remove]] | ||
|Remove existing [[Scenario]] | | Remove existing [[Scenario]] | ||
|- | |- | ||
|[[Api session event editor scenario remove attribute|remove_attribute]] | | [[Api session event editor scenario remove attribute|remove_attribute]] | ||
|Remove | | Remove numeric [[Attribute]] from [[Scenario]] | ||
|- | |- | ||
|[[Api session event editor scenario set active|set_active]] | | [[Api session event editor scenario set active|set_active]] | ||
|Activate [[Scenario]] | | Activate [[Scenario]]. If a test run is active, the [[Scenario]] can restart it | ||
|- | |- | ||
|[[Api session event editor scenario set attribute|set_attribute]] | | [[Api session event editor scenario set attribute|set_attribute]] | ||
|Set [[Scenario]] | | Set [[Scenario]] numeric [[Attribute]] value | ||
|- | |- | ||
|[[Api session event editor scenario set attributes|set_attributes]] | | [[Api session event editor scenario set attributes|set_attributes]] | ||
|Set multiple [[Scenario]] | | Set multiple [[Scenario]] numeric [[Attribute]] values | ||
|- | |- | ||
|[[Api session event editor scenario set name|set_name]] | | [[Api session event editor scenario set name|set_name]] | ||
|Set | | Set the name of a [[Scenario]] | ||
|} | |} | ||
<noinclude lang="text" copy> | |||
Additional API Endpoints: | Additional API Endpoints: | ||
{|class=wikitable | </noinclude>{|class=wikitable | ||
!Name | !Name | ||
!Description | !Description | ||
|- | |- | ||
|[[Api session event editor scenario add event|add_event]] | | [[Api session event editor scenario add event|add_event]] | ||
|Add | | Add a new [[Coded Event]] that is [[Trigger]]ed on [[Scenario]] activation | ||
|- | |- | ||
|[[Api session event editor scenario add measure|add_measure]] | | [[Api session event editor scenario add measure|add_measure]] | ||
|Add a [[Measure]] that is [[Trigger]]ed on [[Scenario]] activation | | Add a [[Measure]] that is [[Trigger]]ed on [[Scenario]] activation | ||
|- | |- | ||
|[[Api session event editor scenario remove cinematic|remove_cinematic]] | | [[Api session event editor scenario remove cinematic|remove_cinematic]] | ||
|Remove [[Cinematic]] | | Remove the starting [[Cinematic]] of a [[Stakeholder]] for a [[Scenario]] | ||
|- | |- | ||
|[[Api session event editor scenario remove event|remove_event]] | | [[Api session event editor scenario remove event|remove_event]] | ||
|Remove Event | | Remove a [[Coded Event]] from a [[Scenario]] | ||
|- | |- | ||
|[[Api session event editor scenario remove measure|remove_measure]] | | [[Api session event editor scenario remove measure|remove_measure]] | ||
|Remove [[Measure]] | | Remove the activated [[Measure]] of a [[Scenario]] | ||
|- | |- | ||
|[[Api session event editor scenario set cinematic|set_cinematic]] | | [[Api session event editor scenario set cinematic|set_cinematic]] | ||
|Set [[Cinematic]] | | Set the starting [[Cinematic]] of a [[Stakeholder]] for a [[Scenario]] | ||
|- | |- | ||
|[[Api session event editor scenario set description|set_description]] | | [[Api session event editor scenario set description|set_description]] | ||
|Set | | Set the description of a [[Scenario]] | ||
|- | |- | ||
|[[Api session event editor scenario set event|set_event]] | | [[Api session event editor scenario set event|set_event]] | ||
| | | Replace the [[Coded Event]] of a [[Scenario]] | ||
|- | |- | ||
|[[Api session event editor scenario set limit neighborhoods|set_limit_neighborhoods]] | | [[Api session event editor scenario set limit neighborhoods|set_limit_neighborhoods]] | ||
|Set | | Set the [[Neighborhood]]s a [[Scenario]] is limited to | ||
|- | |- | ||
|[[Api session event editor scenario set limit type|set_limit_type]] | | [[Api session event editor scenario set limit type|set_limit_type]] | ||
|Set | | Set the spatial limitation of a [[Scenario]] | ||
|- | |- | ||
|[[Api session event editor scenario set restart testrun|set_restart_testrun]] | | [[Api session event editor scenario set restart testrun|set_restart_testrun]] | ||
| | | If true, the test run is restarted on [[Scenario]] activation. Deprecated in favor of multiple maps | ||
|} | |} | ||
{{article end|seealso=*[[Api | <noinclude lang="text" copy>{{article end|seealso=*[[Api Session Endpoints]] | ||
*[[Api session items scenarios]] | *[[Api session items scenarios]] | ||
}} | }} | ||
</noinclude> | |||
[[Category:API]] | [[Category:API]] | ||
Latest revision as of 15:50, 16 November 2026
API Endpoint: api/session/event/editorscenario/
API Endpoints for Scenario editing.
| Name | Description |
|---|---|
| add | Add new Scenario |
| append_attribute | Appended to existing Scenario numeric Attribute value |
| duplicate | Duplicate existing Scenario |
| remove | Remove existing Scenario |
| remove_attribute | Remove numeric Attribute from Scenario |
| set_active | Activate Scenario. If a test run is active, the Scenario can restart it |
| set_attribute | Set Scenario numeric Attribute value |
| set_attributes | Set multiple Scenario numeric Attribute values |
| set_name | Set the name of a Scenario |
Additional API Endpoints:
| Name | Description |
|---|---|
| add_event | Add a new Coded Event that is Triggered on Scenario activation |
| add_measure | Add a Measure that is Triggered on Scenario activation |
| remove_cinematic | Remove the starting Cinematic of a Stakeholder for a Scenario |
| remove_event | Remove a Coded Event from a Scenario |
| remove_measure | Remove the activated Measure of a Scenario |
| set_cinematic | Set the starting Cinematic of a Stakeholder for a Scenario |
| set_description | Set the description of a Scenario |
| set_event | Replace the Coded Event of a Scenario |
| set_limit_neighborhoods | Set the Neighborhoods a Scenario is limited to |
| set_limit_type | Set the spatial limitation of a Scenario |
| set_restart_testrun | If true, the test run is restarted on Scenario activation. Deprecated in favor of multiple maps |