Api session event editor scenario: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 6: | Line 6: | ||
!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]] [[Attribute]] value | | Appended to existing [[Scenario]] [[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 [[Attribute]] from [[Scenario]] | | Remove [[Attribute]] from [[Scenario]] | ||
|- | |- | ||
|[[Api session event editor scenario set active|set_active]] | | [[Api session event editor scenario set active|set_active]] | ||
|Activate [[Scenario]], when testrun is active the Scenerio can restart it. | | Activate [[Scenario]], when testrun is active the Scenerio can restart it. | ||
|- | |- | ||
|[[Api session event editor scenario set attribute|set_attribute]] | | [[Api session event editor scenario set attribute|set_attribute]] | ||
|Set [[Scenario]] [[Attribute]] value | | Set [[Scenario]] [[Attribute]] value | ||
|- | |- | ||
|[[Api session event editor scenario set attributes|set_attributes]] | | [[Api session event editor scenario set attributes|set_attributes]] | ||
|Set multiple [[Scenario]] [[Attribute]] values | | Set multiple [[Scenario]] [[Attribute]] values | ||
|- | |- | ||
|[[Api session event editor scenario set name|set_name]] | | [[Api session event editor scenario set name|set_name]] | ||
|Set new name of existing [[Scenario]] | | Set new name of existing [[Scenario]] | ||
|} | |} | ||
| Line 39: | Line 39: | ||
!Description | !Description | ||
|- | |- | ||
|[[Api session event editor scenario add event|add_event]] | | [[Api session event editor scenario add event|add_event]] | ||
|Add empty dummy event that is [[Trigger]]ed on [[Scenario]] activation. | | Add empty dummy 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 [[Cinematic]] | ||
|- | |- | ||
|[[Api session event editor scenario remove event|remove_event]] | | [[Api session event editor scenario remove event|remove_event]] | ||
|Remove Event | | Remove Event | ||
|- | |- | ||
|[[Api session event editor scenario remove measure|remove_measure]] | | [[Api session event editor scenario remove measure|remove_measure]] | ||
|Remove [[Measure]] | | Remove [[Measure]] | ||
|- | |- | ||
|[[Api session event editor scenario set cinematic|set_cinematic]] | | [[Api session event editor scenario set cinematic|set_cinematic]] | ||
|Set [[Cinematic]] | | Set [[Cinematic]] | ||
|- | |- | ||
|[[Api session event editor scenario set description|set_description]] | | [[Api session event editor scenario set description|set_description]] | ||
|Set Description | | Set Description | ||
|- | |- | ||
|[[Api session event editor scenario set event|set_event]] | | [[Api session event editor scenario set event|set_event]] | ||
|Set Event | | Set Event | ||
|- | |- | ||
|[[Api session event editor scenario set limit neighborhoods|set_limit_neighborhoods]] | | [[Api session event editor scenario set limit neighborhoods|set_limit_neighborhoods]] | ||
|Set Limit [[Neighborhood]]s | | Set Limit [[Neighborhood]]s | ||
|- | |- | ||
|[[Api session event editor scenario set limit type|set_limit_type]] | | [[Api session event editor scenario set limit type|set_limit_type]] | ||
|Set Limit Type | | Set Limit Type | ||
|- | |- | ||
|[[Api session event editor scenario set restart testrun|set_restart_testrun]] | | [[Api session event editor scenario set restart testrun|set_restart_testrun]] | ||
|When true test run is restarted on [[Scenario]] activation. This option will be deprecated in the future and replaced by multiple maps. | | When true test run is restarted on [[Scenario]] activation. This option will be deprecated in the future and replaced by multiple maps. | ||
|} | |} | ||
{{article end|seealso=*[[Api Session Endpoints]] | {{article end|seealso=*[[Api Session Endpoints]] | ||
Revision as of 11:42, 8 June 2026
API Endpoint: api/session/event/editorscenario/
API endpoints for Scenario editing.
| Name | Description |
|---|---|
| add | Add new Scenario. |
| append_attribute | Appended to existing Scenario Attribute value |
| duplicate | Duplicate existing Scenario |
| remove | Remove existing Scenario |
| remove_attribute | Remove Attribute from Scenario |
| set_active | Activate Scenario, when testrun is active the Scenerio can restart it. |
| set_attribute | Set Scenario Attribute value |
| set_attributes | Set multiple Scenario Attribute values |
| set_name | Set new name of existing Scenario |
Additional API endpoints:
| Name | Description |
|---|---|
| add_event | Add empty dummy event that is Triggered on Scenario activation. |
| add_measure | Add a Measure that is Triggered on Scenario activation. |
| remove_cinematic | Remove Cinematic |
| remove_event | Remove Event |
| remove_measure | Remove Measure |
| set_cinematic | Set Cinematic |
| set_description | Set Description |
| set_event | Set Event |
| set_limit_neighborhoods | Set Limit Neighborhoods |
| set_limit_type | Set Limit Type |
| set_restart_testrun | When true test run is restarted on Scenario activation. This option will be deprecated in the future and replaced by multiple maps. |