Back to bricks list
Introduction Getting Started
Architecture
Technical Documentation
Other Classes
AbstractDbManager AgentFactory AudioView AuthService BadRequestException BarPlotView Base BaseEnvShell BaseHTTPException BaseModelDTO BaseTestCase BaseTestCaseLight BashCodeParam BoolParam BoolRField BoolValidator BoxPlotView BrickMigration BrickService CheckBeforeTaskResult CommunityService Compress CondaShellProxy Config ConfigParams Connector ConnectorPartSpec ConnectorSpec ConverterRunner Credentials CredentialsDataBasic CredentialsDataLab CredentialsDataOther CredentialsDataS3 CredentialsParam CredentialsType CurrentUserService Dashboard DashboardType DataframeAggregatorHelper DataframeDataFilterHelper DataframeFilterHelper DataFrameRField DataframeScalerHelper datetime DateTimeUTC DbConfig DictRField DictValidator DispatchedMessage DynamicInputs DynamicOutputs EntityNavigator EntityNavigatorService EntityTag EntityType Enum ExceptionHandler ExceptionResponse ExpressionBuilder ExternalApiService FileDownloader FileHelper FileRField FloatParam FloatRField FloatValidator ForbiddenException FrontService FrontTheme FSNodeModel FsNodeService GwsCorePackages GWSException GzipCompress HeatmapView HistogramView ImageView InPort Inputs InputSpec InputSpecs InterfaceSpec IntParam IntRField IntValidator IO IOface Job JsonCodeParam JSONField JSONView JuliaCodeParam KVStore LazyViewParam LinePlot2DView ListParam ListRField ListValidator Logger MailService MambaShellProxy MessageDispatcher MessageLevel MessageObserver Model ModelService Monitor MonitorService MultiViews NetworkView Note Notebook NoteParam NoteSearchBuilder NoteService NoteTemplate NoteTemplateParam NoteTemplateService NotFoundException NumericHelper NumericParam NumericValidator OpenAiChat OpenAiChatMessage OpenAiChatParam OpenAiHelper OutPort Outputs OutputSpec OutputSpecs PackageHelper Paginator ParamSet ParamSpec PerlCodeParam PipShellProxy PlotlyRField PlotlyView PoolDb Port PrimitiveRField Process ProcessFactory ProcessModel ProcessProxy ProcessSpec ProgressBar ProgressBarMessageObserver ProgressBarService ProtocolModel ProtocolProxy ProtocolService ProtocolTyping PythonCodeParam Queue QueueService RCodeParam Requests ResourceDownloaderBase ResourceModel ResourceOrigin ResourceRField ResourceSearchBuilder ResourceService ResourceTransfertService ResourceTyping RField RichText RichTextBlock RichTextBlockModificationDTO RichTextBlockModificationWithUserDTO RichTextBlockType RichTextDTO RichTextFigureData RichTextFileData RichTextFormulaData RichTextListData RichTextListItem RichTextModificationDifferenceDTO RichTextModificationsDTO RichTextModificationType RichTextNoteResourceViewData RichTextObjectType RichTextParagraphData RichTextParagraphHeaderData RichTextParagraphHeaderLevel RichTextParagraphListData RichTextParagraphListItemData RichTextParagraphText RichTextResourceViewData RichTextTimestampData RichTextUserDTO RichTextVariableData RichTextView RichTextViewFileData S3Bucket ScatterPlot2DView Scenario ScenarioCreationType ScenarioProcessStatus ScenarioProxy ScenarioRunService ScenarioSaveDTO ScenarioSearchBuilder ScenarioService ScenarioStatus ScenarioTemplate ScenarioTemplateFactory ScenarioTransfertService SearchBuilder SerializableObjectJson SerializableRField Settings ShellProxy SimpleTextView SpaceFolder SqlMigrator StackedBarPlotView StreamlitApp StreamlitAppManager StreamlitProcess StringHelper StrParam StrRField StrValidator SysProc TableAnnotatorHelper TableColumnSelector TableColumnTagToRowExtractor TableColumnTagUnfolder TableConcatHelper TableHeaderInfo TableOperationHelper TableRowSelector TableRowTagToColumnExtractor TableRowTagUnfolder TableScalerHelper TableTagAggregatorHelper TableUnfolderHelper TableView TabularView Tag TagHelper TagKeyModel TagService TagsParam TagValueModel TarCompress TarGzCompress TaskFileDownloader TaskHelper TaskInputs TaskModel TaskProxy TaskRunner TaskService TaskTyping TechnicalInfo TextParam TextView TextViewData Typing TypingDeprecated TypingIconColor TypingIconType TypingManager TypingStyle UnauthorizedException URLValidator User UserCredentialsDTO UserGroup UserService Utils UUIDRField Validator VennDiagramView Version View ViewTester ViewType YamlCodeParam ZipCompress
Version

ScenarioService

Functions
ARCHIVE_SCENARIO_BY_ID - @classmethod
CLONE_SCENARIO - @classmethod
COUNT_BY_TITLE - @classmethod
Parameters:
NameTypeDefault valueDescription
titlestr
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:
NameTypeDefault valueDescription
protocol_typeType
folderSpaceFolder
titlestr ''
creation_typeScenarioCreationType ScenarioCreationType.MANUAL
Return type:
Scenario
DELETE_INTERMEDIATE_RESOURCES - @classmethod
DELETE_SCENARIO - @classmethod
EXPORT_SCENARIO - @classmethod
Parameters:
NameTypeDefault valueDescription
scenario_idstr
Return type:
ZipScenarioInfo
GET_BY_ID_AND_CHECK - @classmethod
Parameters:
NameTypeDefault valueDescription
idstr
Return type:
Scenario
GET_INTERMEDIATE_RESULTS - @classmethod

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

Parameters:
NameTypeDefault valueDescription
scenario_idstr 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:
NameTypeDefault valueDescription
resource_idstr _description_
pageint 0
number_of_items_per_pageint 20
Return type:
Paginator
GET_RUNNING_SCENARIO_INFO - @classmethod
Parameters:
NameTypeDefault valueDescription
scenarioScenario
Return type:
RunningScenarioInfoDTO
GET_RUNNING_SCENARIOS - @classmethod
Return type:
List
RESET_SCENARIO - @classmethod
Parameters:
NameTypeDefault valueDescription
scenarioScenario
Return type:
Scenario
SEARCH_BY_TITLE - @classmethod
Parameters:
NameTypeDefault valueDescription
titlestr
pageint 0
number_of_items_per_pageint 20
Return type:
Paginator
SYNCHRONIZE_WITH_SPACE_BY_ID - @classmethod
Parameters:
NameTypeDefault valueDescription
idstr
Return type:
Scenario
UNARCHIVE_SCENARIO_BY_ID - @classmethod
Parameters:
NameTypeDefault valueDescription
idstr
Return type:
Scenario
UPDATE_SCENARIO_DESCRIPTION - @classmethod
Parameters:
NameTypeDefault valueDescription
id_str
descriptionRichTextDTO
Return type:
Scenario
UPDATE_SCENARIO_FOLDER - @classmethod
Parameters:
NameTypeDefault valueDescription
scenario_idstr
folder_idOptional
check_notebool True
Return type:
Scenario
UPDATE_SCENARIO_TITLE - @classmethod
Parameters:
NameTypeDefault valueDescription
scenario_idstr
titlestr
Return type:
Scenario
VALIDATE_SCENARIO - @classmethod
VALIDATE_SCENARIO_BY_ID - @classmethod