Login
Back to bricks list
Introduction Version

ExperimentService

Functions

ARCHIVE_EXPERIMENT_BY_ID - @classmethod
CLONE_EXPERIMENT - @classmethod
COUNT_BY_TITLE - @classmethod
Parameters:
NameTypeDefault valueDescription
titlestr
Return type:
int
COUNT_OF_RUNNING_EXPERIMENTS - @classmethod
Return type:
int
COUNT_QUEUED_EXPERIMENTS - @classmethod
Return type:
int
COUNT_RUNNING_OR_QUEUED_EXPERIMENTS - @classmethod
Return type:
int
CREATE_EXPERIMENT - @classmethod
CREATE_EXPERIMENT_FROM_DTO - @classmethod
CREATE_EXPERIMENT_FROM_PROTOCOL_MODEL - @classmethod
CREATE_EXPERIMENT_FROM_PROTOCOL_TYPE - @classmethod
Parameters:
NameTypeDefault valueDescription
protocol_typeType
projectProject
titlestr ''
creation_typeExperimentCreationType ExperimentCreationType.MANUAL
Return type:
Experiment
DELETE_EXPERIMENT - @classmethod
DELETE_INTERMEDIATE_RESOURCES - @classmethod
GET_BY_ID_AND_CHECK - @classmethod
Parameters:
NameTypeDefault valueDescription
idstr
Return type:
Experiment
GET_INTERMEDIATE_RESULTS - @classmethod

Retrieve the list of intermediate resources of an experiment A resource is considered as intermediate if it is not used as input of a sink and not flagged

Parameters:
NameTypeDefault valueDescription
experiment_idstr Id of the experiment
Return type:
List
GET_NEXT_EXPERIMENTS_OF_RESOURCE - @classmethod

Return the list of experiment 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_EXPERIMENT_INFO - @classmethod
Parameters:
NameTypeDefault valueDescription
experimentExperiment
Return type:
RunningExperimentInfoDTO
GET_RUNNING_EXPERIMENTS - @classmethod
Return type:
List
RESET_EXPERIMENT - @classmethod
Parameters:
NameTypeDefault valueDescription
experimentExperiment
Return type:
Experiment
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:
Experiment
UNARCHIVE_EXPERIMENT_BY_ID - @classmethod
Parameters:
NameTypeDefault valueDescription
idstr
Return type:
Experiment
UPDATE_EXPERIMENT_DESCRIPTION - @classmethod
Parameters:
NameTypeDefault valueDescription
id_str
descriptionDict
Return type:
Experiment
UPDATE_EXPERIMENT_PROJECT - @classmethod
Parameters:
NameTypeDefault valueDescription
experiment_idstr
project_idOptional
check_reportbool True
Return type:
Experiment
UPDATE_EXPERIMENT_TITLE - @classmethod
Parameters:
NameTypeDefault valueDescription
experiment_idstr
titlestr
Return type:
Experiment
VALIDATE_EXPERIMENT - @classmethod
VALIDATE_EXPERIMENT_BY_ID - @classmethod