Api session event logic
Jump to navigation
Jump to search
API Endpoint: api/session/event/logic/
API endpoints for endpoints changing Functionality in a testrun/impact Session.
| Name | Description |
|---|---|
| action_log_export | Export history of Actions taken by participants. |
| action_menu_set_function_available | Add or remove a Function from a particular Action Menu. |
| action_menu_set_measure_available | Add or remove a Measure from a particular Action Menu. |
| action_menu_set_upgrade_available | Add or remove an upgrade from a particular Action Menu. |
| area_set_active | Activate/deactivate a Area. |
| area_set_attribute | Set Area Attribute to given number Value. |
| areas_set_attributes | Per entry in the array, set the value of the Attribute for the Area. |
| building_set_attribute | Set Building Attribute to given number Value. |
| building_set_attributes | Per entry in the array, set the values of the Attribute for the Building. |
| cinematic_reached_point | FlightPoint reached for a specific Cinematic. |
| cinematic_stakeholder_start | Start a Cinematic for a specific Stakeholder. |
| cinematic_stakeholder_stop | Stop any Cinematic for a specific Stakeholder. |
| dismiss_error | Dismiss Error Log. |
| global_set_value | Set Global Variable to given number Value. |
| global_set_values | Set Global Variable to given number Values. |
| map_direct_sell_land | Direct sale of land, no approval asked. |
| measurement_item_add | Add a ItemMeasurement for an Overlay. |
| measurement_line_add | Add a LineMeasurement for an Overlay for a specific Timeframe. |
| measurement_point_add | Add a PointMeasurement for an Overlay. |
| measurement_remove | Remove a Measurement. |
| measurement_save | Save a Measurement. |
| measurement_set_overlays | Set base Overlays for an existing Measurement. |
| measurement_set_sum | Set a Measurement to add its base Overlays to itself. |
| money_transfer_add | Create a new Money Transfer between two Stakeholders. |
| money_transfers_set_approved | Approve a Money Transfer |
| neighborhood_set_attribute | Set an Attribute for a Neighborhood. |
| net_cluster_set_fraction_connected | Set the frAction of connected loads with a cluster. |
| net_cluster_set_load_attribute | For each Net Load of a Net Cluster, set the value of the Attribute. |
| net_cluster_set_load_attributes | For each Net Load of a Net Cluster, set the values of the provided Attributes. |
| net_clusters_set_default_fraction_connected | Set the default frAction of connected loads with a cluster. |
| net_clusters_set_load_attributes | Per Net Cluster, for each Net Load of that Net Cluster, set the values of the provided Attributes. |
| net_clusters_set_state | Per Net Cluster, set all its Net Loads of the provided Net Type to the given Timestate. |
| net_line_set_attribute | Set the Attribute of a Net Line to the provided value. |
| net_lines_set_attribute | For each Net Line, set the value of the Attribute. |
| net_lines_set_attributes | Per entry in the array, set the value of the Attribute for the Net Line. |
| scenario_set_active | Activate a level. |
| scenario_set_attribute | Set Scenario Attribute to given number Value. |
| search | Search for Neighborhood, Building or Address. |
| session_release | Release a client from a Session using its client token. |
| set_net_setting_boolean | For boolean valued Net Settings (ELECTRICITY_ACTIVE, GAS_ACTIVE, HEAT_ACTIVE, INTERNET_ACTIVE, SEWER_ACTIVE, REQUIRE_UTILITY_CORPORATION_APPROVAL, CLUSTER_MODELS_ENABLED, LOAD_TO_NODE_LINES_ENABLED, FIRST_CONNECT_ACCEPT, RESTRICT_TO_NET_Overlay), set the value to true or false. |
| set_traffic_multiplier | Multiply visual (only) traffic density with this factor. |
| special_effect_set_active | Activate/deactivate a Special Effect. |
| stakeholder_release | Release a Stakeholder from a Session. |
| stakeholder_select | Select Stakeholder with preferred ID, when not available fallback to next best. |
| undo_last_building_action | Undo the last Building Action of a Stakeholder. |
| unit_type_set_active | Activate/deactivate units of a specific type. |
| zone_set_attribute | Set an Attribute for a Zone. |
| zones_set_attributes | Set Attributes to values for Zones. |