Api session event editor scenario: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
<noinclude lang="text" copy>API Endpoint: api/session/event/editorscenario/
<noinclude lang="text" copy>API Endpoint: api/session/event/editorscenario/
</noinclude>
</noinclude><noinclude lang="text" copy>
API Endpoints for [[Scenario]] editing.
API Endpoints for [[Scenario]] editing.
{|class=wikitable
</noinclude>{|class=wikitable
!Name
!Name
!Description
!Description
Line 33: Line 33:
| Set the name of a [[Scenario]]
| 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 a new Coded Event that is [[Trigger]]ed on [[Scenario]] activation
| 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]]
Line 49: Line 49:
|-
|-
| [[Api session event editor scenario remove event|remove_event]]
| [[Api session event editor scenario remove event|remove_event]]
| Remove a Coded Event from a [[Scenario]]
| 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]]
Line 61: Line 61:
|-
|-
| [[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]]
| 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]]

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