ScenarioService - gws_core

Functions

ARCHIVE_SCENARIO_BY_ID - @classmethod

CLONE_SCENARIO - @classmethod

COUNT_BY_TITLE - @classmethod

Parameters:

Name	Type	Default value	Description
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

Parameters:

Name	Type	Default value
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

Parameters:

Name	Type	Default value	Description
scenario_id	`str`

Return type:

ZipScenarioInfo

GET_BY_ID_AND_CHECK - @classmethod

Parameters:

Name	Type	Default value	Description
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

Parameters:

Name	Type	Default value	Description
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

Parameters:

Name	Type	Default value	Description
resource_id	`str`		_description_
page	`int`	0
number_of_items_per_page	`int`	20

Return type:

Paginator

GET_RUNNING_SCENARIO_INFO - @classmethod

Parameters:

Name	Type	Default value	Description
scenario	`Scenario`

Return type:

RunningScenarioInfoDTO

GET_RUNNING_SCENARIOS - @classmethod

Return type:

List

RESET_SCENARIO - @classmethod

Parameters:

Name	Type	Default value	Description
scenario	`Scenario`

Return type:

Scenario

SEARCH - @classmethod

Parameters:

Name	Type	Default value
search	`SearchParams`
page	`int`	0
number_of_items_per_page	`int`	20

Return type:

Paginator

SEARCH_BY_TITLE - @classmethod

Parameters:

Name	Type	Default value
title	`str`
page	`int`	0
number_of_items_per_page	`int`	20

Return type:

Paginator

SYNCHRONIZE_WITH_SPACE_BY_ID - @classmethod

Parameters:

Name	Type	Default value	Description
id	`str`

Return type:

Scenario

UNARCHIVE_SCENARIO_BY_ID - @classmethod

Parameters:

Name	Type	Default value	Description
id	`str`

Return type:

Scenario

UPDATE_SCENARIO_DESCRIPTION - @classmethod

Parameters:

Name	Type	Default value	Description
id_	`str`
description	`RichTextDTO`

Return type:

Scenario

UPDATE_SCENARIO_FOLDER - @classmethod

Parameters:

Name	Type	Default value
scenario_id	`str`
folder_id	`Optional`
check_note	`bool`	True

Return type:

Scenario

UPDATE_SCENARIO_TITLE - @classmethod

Parameters:

Name	Type	Default value	Description
scenario_id	`str`
title	`str`

Return type:

Scenario

VALIDATE_SCENARIO - @classmethod

VALIDATE_SCENARIO_BY_ID - @classmethod