DatasetRequestParameter

class LOGS.Entities.DatasetRequestParameter.DatasetOrder(value)

Bases: Enum

An enumeration.

ACQUISITION_DATE_ASC = 'ACQUISITION_DATE_ASC'

ACQUISITION_DATE_DESC = 'ACQUISITION_DATE_DESC'

CREATED_BY_ASC = 'CREATED_BY_ASC'

CREATED_BY_DESC = 'CREATED_BY_DESC'

CREATED_ON_ASC = 'CREATED_ON_ASC'

CREATED_ON_DESC = 'CREATED_ON_DESC'

EXPERIMENT_ASC = 'EXPERIMENT_ASC'

EXPERIMENT_DESC = 'EXPERIMENT_DESC'

FORMAT_ID_ASC = 'FORMAT_ID_ASC'

FORMAT_ID_DESC = 'FORMAT_ID_DESC'

ID_ASC = 'ID_ASC'

ID_DESC = 'ID_DESC'

INSTRUMENT_ASC = 'INSTRUMENT_ASC'

INSTRUMENT_DESC = 'INSTRUMENT_DESC'

METHOD_ASC = 'METHOD_ASC'

METHOD_DESC = 'METHOD_DESC'

MODIFIED_BY_ASC = 'MODIFIED_BY_ASC'

MODIFIED_BY_DESC = 'MODIFIED_BY_DESC'

MODIFIED_ON_ASC = 'MODIFIED_ON_ASC'

MODIFIED_ON_DESC = 'MODIFIED_ON_DESC'

NAME_ASC = 'NAME_ASC'

NAME_DESC = 'NAME_DESC'

PARSING_STATE_ASC = 'PARSING_STATE_ASC'

PARSING_STATE_DESC = 'PARSING_STATE_DESC'

SAMPLE_ASC = 'SAMPLE_ASC'

SAMPLE_DESC = 'SAMPLE_DESC'

TYPE_ASC = 'TYPE_ASC'

TYPE_DESC = 'TYPE_DESC'

class LOGS.Entities.DatasetRequestParameter.DatasetRequestParameter(includePermissions=None, createdFrom=None, createdTo=None, originIds=None, names=None, ownerIds=None, projectIds=None, typeIds=None, includeSoftDeleted=None, isSoftDeleted=None, includeCustomFields=None, includeRelations=True, includeRelationLink=None, includeRelationCount=None, page=None, pageSize=None, excludeIds=None, searchTerm=None, ids=None, includeCount=None, orderby=None, acquisitionDateFrom=None, acquisitionDateTo=None, autoloadServerIds=None, bridgeIds=None, dataSourceIds=None, documentIds=None, equipmentIds=None, excludeUndeleted=None, experimentIds=None, files=None, formatIds=None, hasExperiment=None, hashes=None, hasOperator=None, includeParameters=None, includeParsingInfo=None, includeUnclaimed=None, instrumentIds=None, isClaimed=None, isReferencedByLabNotebook=None, isViewableEntity=None, methodIds=None, operatorIds=None, orderBy=None, organizationIds=None, parameters=None, parsingState=None, participatedPersonIds=None, pathContains=None, sampleIds=None, searchTermIncludeNotes=None, searchTermIncludeParameters=None, searchTermIncludePaths=None, viewableEntityTypes=None)

Bases: EntityRequestParameter[DatasetOrder], IRelatedEntityRequest, ITypedEntityRequest, ISoftDeletableRequest, ICustomSchemaRequest, IProjectBasedRequest, IOwnedEntityRequest, INamedEntityRequest, IUniqueEntityRequest, ICreationRecordRequest, IModificationRecordRequest, IPermissionedEntityRequest

acquisitionDateFrom: Optional[datetime] = None

acquisitionDateTo: Optional[datetime] = None

autoloadServerIds: Optional[List[int]] = None

bridgeIds: Optional[List[int]] = None

createdByIds: Optional[List[int]]

dataSourceIds: Optional[List[int]] = None

documentIds: Optional[List[int]] = None

equipmentIds: Optional[List[int]] = None

excludeUndeleted: Optional[bool] = None

experimentIds: Optional[List[int]] = None

files: Optional[Sequence[Union[str, DirEntry, FileEntry]]] = None

formatIds: Optional[List[str]] = None

hasExperiment: Optional[bool] = None

hasOperator: Optional[bool] = None

hashes: Optional[List[str]] = None

includeParameters: Optional[bool] = None

includeParsingInfo: Optional[bool] = None

includeSoftDeleted: Optional[bool] = None

includeUnclaimed: Optional[bool] = None

instrumentIds: Optional[List[int]] = None

isClaimed: Optional[bool] = None

isReferencedByLabNotebook: Optional[bool] = None

isViewableEntity: Optional[bool] = None

methodIds: Optional[List[int]] = None

names: Optional[List[str]] = None

operatorIds: Optional[List[int]] = None

orderBy: Optional[DatasetOrder] = None

organizationIds: Optional[List[int]] = None

originIds: Optional[List[int]] = None

parameters: Optional[Dict[str, Any]] = None

parsingState: Optional[List[Literal['ParsedSuccessfully', 'NotParseable', 'ParsingFailed', 'NotYetParsed']]] = None

participatedPersonIds: Optional[List[int]] = None

pathContains: Optional[str] = None

sampleIds: Optional[List[int]] = None

searchTermIncludeNotes: Optional[bool] = None

searchTermIncludeParameters: Optional[bool] = None

searchTermIncludePaths: Optional[bool] = None

viewableEntityTypes: Optional[List[ViewableEntityTypes]] = None