gws_core

Introduction
Getting Started
Developer guide
Release
Architecture
CLI
Technical documentations
Version

ScenarioService

Functions
archive_scenario_by_id @classmethod
clone_scenario @classmethod
count_by_title @classmethod
title : str
Return type : int
count_of_running_scenarios @classmethod
Return type : int
count_queued_scenarios @classmethod
Return type : int
count_running_or_queued_scenarios @classmethod
Return type : int
create_scenario @classmethod
create_scenario_from_dto @classmethod
create_scenario_from_protocol_model @classmethod
create_scenario_from_protocol_type @classmethod
protocol_type : Type
folder : SpaceFolder
title : str - ''
creation_type : ScenarioCreationType - ScenarioCreationType.MANUAL
Return type : Scenario
delete_intermediate_resources @classmethod
delete_scenario @classmethod
export_scenario @classmethod
scenario_id : str
Return type : ZipScenarioInfo
get_by_id_and_check @classmethod
id : str
Return type : Scenario
get_intermediate_results @classmethod

Retrieve the list of intermediate resources of a scenario A resource is considered as intermediate if it is not used as output and not flagged

scenario_id : str
id of the scenario
Return type : List
get_next_scenarios_of_resource @classmethod

Return the list of scenario that used the resource as input

resource_id : str
_description_
page : int - 0
number_of_items_per_page : int - 20
Return type : Paginator
get_running_scenario_info @classmethod
scenario : Scenario
Return type : RunningScenarioInfoDTO
get_running_scenarios @classmethod
Return type : List
reset_scenario @classmethod
scenario : Scenario
Return type : Scenario
search_by_title @classmethod
title : str
page : int - 0
number_of_items_per_page : int - 20
Return type : Paginator
synchronize_with_space_by_id @classmethod
id : str
Return type : Scenario
unarchive_scenario_by_id @classmethod
id : str
Return type : Scenario
update_scenario_description @classmethod
id_ : str
description : RichTextDTO
Return type : Scenario
update_scenario_folder @classmethod
scenario_id : str
folder_id : Optional
check_note : bool - True
Return type : Scenario
update_scenario_title @classmethod
scenario_id : str
title : str
Return type : Scenario
validate_scenario @classmethod
validate_scenario_by_id @classmethod