Skip to content

CompleteAPIClient API Reference

This page documents all public methods of the CompleteAPIClient class.

For example implemenations please see: example_implementation.py

action

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

Action


action_experiment

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

List[Action]


action_group

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

ActionGroup


action_group_round

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

ActionGroup


action_not_done_experiment

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

List[Action]


action_protocol

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

ActionProtocol


action_protocol_round

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

ActionProtocol


buffer_history

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

BufferHistory


buffer_history_date

Parameters

Name Type Description Notes
start datetime Start datetime for filtering results.
stop datetime Stop datetime for filtering results.

Return type

List[BufferHistory]


device

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

Device


device_active

Return type

List[Device]


device_profile

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

List[Device]


experiment

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

Experiment


experiment_date

Parameters

Name Type Description Notes
start datetime Start datetime for filtering results.
stop datetime Stop datetime for filtering results.

Return type

List[Experiment]


experiment_id

Return type

List[int]


experiment_owner

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

List[Experiment]


note_experiment

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

List[ExperimentNote]


owner

Parameters

Name Type Description Notes
ids List[int] list of IDs of the resources.

Return type

List[Owner]


owner_id

Return type

List[int]


fc_imaging

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.

Return type

List[FcImaging]


fc_imaging_extended_data

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.

Return type

MeasureExtendedData


fc_imaging_extended_data_measure

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

MeasureExtendedData


fc_imaging_measure

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

FcImaging


fc_leaf_param

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.
param_id int ID of the parameter.

Return type

List[LeafParameter]


fc_leaf_param_analyse

Parameters

Name Type Description Notes
id int ID of the resource.
param_id int ID of the parameter.

Return type

List[LeafParameter]


fc_param

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

Parameter


fc_param_image

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.
param_id int ID of the parameter.

Return type

List[ParameterImage]


fc_param_image_analyse

Parameters

Name Type Description Notes
id int ID of the resource.
param_id int ID of the parameter.

Return type

ParameterImage


fc_param_used

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.

Return type

List[Parameter]


fc_param_used_analyse

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

List[Parameter]


fc_plant_mask

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.

Return type

List[PlantMask]


fc_plant_mask_measure

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

PlantMask


fc_plant_param

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.
param_id int ID of the parameter.

Return type

List[PlantParameter]


fc_plant_param_analyse

Parameters

Name Type Description Notes
id int ID of the resource.
param_id int ID of the parameter.

Return type

List[PlantParameter]


file

Return type

BytesIO


file_changelog

Return type

str


hc_imaging

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.

Return type

List[HcImaging]


hc_imaging_extended_data

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.

Return type

MeasureExtendedData


hc_imaging_extended_data_measure

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

MeasureExtendedData


hc_imaging_measure

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

HcImaging


hc_leaf_param

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.
param_id int ID of the parameter.

Return type

List[StatisticLeafParameter]


hc_leaf_param_analyse

Parameters

Name Type Description Notes
id int ID of the resource.
param_id int ID of the parameter.

Return type

List[StatisticLeafParameter]


hc_param

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

Parameter


hc_param_image

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.
param_id int ID of the parameter.

Return type

List[ParameterImage]


hc_param_image_analyse

Parameters

Name Type Description Notes
id int ID of the resource.
param_id int ID of the parameter.

Return type

ParameterImage


hc_param_used

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.

Return type

List[Parameter]


hc_param_used_analyse

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

List[Parameter]


hc_plant_mask

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.

Return type

List[PlantMask]


hc_plant_mask_measure

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

PlantMask


hc_plant_param

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.
param_id int ID of the parameter.

Return type

List[StatisticPlantParameter]


hc_plant_param_analyse

Parameters

Name Type Description Notes
id int ID of the resource.
param_id int ID of the parameter.

Return type

List[StatisticPlantParameter]


hc_rgb_image

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.

Return type

List[HcRgbImage]


hc_rgb_image_measure

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

HcRgbImage


ir_imaging

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.

Return type

List[Imaging]


ir_imaging_extended_data

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.

Return type

MeasureExtendedData


ir_imaging_extended_data_measure

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

MeasureExtendedData


ir_imaging_measure

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

Imaging


ir_leaf_param

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.
param_id int ID of the parameter.

Return type

List[StatisticLeafParameter]


ir_leaf_param_analyse

Parameters

Name Type Description Notes
id int ID of the resource.
param_id int ID of the parameter.

Return type

List[StatisticLeafParameter]


ir_param

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

Parameter


ir_param_used

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.

Return type

List[Parameter]


ir_param_used_analyse

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

List[Parameter]


ir_plant_mask

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.

Return type

List[PlantMask]


ir_plant_mask_image

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.

Return type

List[Imaging]


ir_plant_mask_image_measure

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

Imaging


ir_plant_mask_measure

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

PlantMask


ir_plant_param

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.
param_id int ID of the parameter.

Return type

List[StatisticPlantParameter]


ir_plant_param_analyse

Parameters

Name Type Description Notes
id int ID of the resource.
param_id int ID of the parameter.

Return type

List[StatisticPlantParameter]


msc_calibration

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

MscCalibration


msc_calibration_light

Parameters

Name Type Description Notes
id Optional[int] ID of the resource.

Return type

MscCalibrationLight


msc_calibration_light_set

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

MscCalibration


msc_imaging

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.

Return type

List[Imaging]


msc_imaging_extended_data

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.

Return type

MeasureExtendedData


msc_imaging_extended_data_measure

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

MeasureExtendedData


msc_imaging_measure

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

List[Imaging]


msc_leaf_param

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.
param_id int ID of the parameter.

Return type

List[StatisticLeafParameter]


msc_leaf_param_analyse

Parameters

Name Type Description Notes
id int ID of the resource.
param_id int ID of the parameter.

Return type

List[StatisticLeafParameter]


msc_light_set

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

MscLightSet


msc_light_set_used

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.

Return type

List[MscLightSet]


msc_param

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

Parameter


msc_param_image

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.
param_id int ID of the parameter.

Return type

List[ParameterImage]


msc_param_image_analyse

Parameters

Name Type Description Notes
id int ID of the resource.
param_id int ID of the parameter.

Return type

ParameterImage


msc_param_used

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.

Return type

List[Parameter]


msc_param_used_analyse

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

List[Parameter]


msc_plant_mask

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.

Return type

List[PlantMask]


msc_plant_mask_measure

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

PlantMask


msc_plant_param

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.
param_id int ID of the parameter.

Return type

List[StatisticPlantParameter]


msc_plant_param_analyse

Parameters

Name Type Description Notes
id int ID of the resource.
param_id int ID of the parameter.

Return type

List[StatisticPlantParameter]


plant

Parameters

Name Type Description Notes
ids List[int] list of IDs of the resources.

Return type

List[Plant]


plant_height_round

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

List[PlantHeight]


plant_leaf

Parameters

Name Type Description Notes
tray_id int ID of the tray.

Return type

List[PlantLeaf]


plant_tray

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

List[Plant]


plant_tray_profile

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

List[Plant]


plant_tray_profile_tray

Parameters

Name Type Description Notes
id int ID of the resource.
start datetime Start datetime for filtering results.
stop datetime Stop datetime for filtering results.

Return type

List[Plant]


probe

Parameters

Name Type Description Notes
id Optional[int] ID of the resource.

Return type

Probe


probe_value_date

Parameters

Name Type Description Notes
start datetime Start datetime for filtering results.
stop datetime Stop datetime for filtering results.

Return type

List[ProbeValue]


probe_value_date_probe

Parameters

Name Type Description Notes
id int ID of the resource.
start datetime Start datetime for filtering results.
stop datetime Stop datetime for filtering results.

Return type

List[ProbeValue]


profile

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

SystemProfile


profile_active

Return type

SystemProfile


profile_id

Return type

List[int]


rgb_greening_mask_image

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.

Return type

List[RgbGreeningMaskImage]


rgb_greening_mask_image_measure

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

RgbGreeningMaskImage


rgb_imaging

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.

Return type

List[Imaging]


rgb_imaging_extended_data

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.

Return type

MeasureExtendedData


rgb_imaging_extended_data_measure

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

MeasureExtendedData


rgb_imaging_measure

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

Imaging


rgb_leaf_param

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.
param_id int ID of the parameter.

Return type

List[LeafParameter]


rgb_leaf_param_analyse

Parameters

Name Type Description Notes
id int ID of the resource.
param_id int ID of the parameter.

Return type

List[LeafParameter]


rgb_leaf_param_color

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.
param_id int ID of the parameter.

Return type

List[LeafParameter]


rgb_leaf_param_color_analyse

Parameters

Name Type Description Notes
id int ID of the resource.
param_id int ID of the parameter.

Return type

List[LeafParameter]


rgb_param

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

Parameter


rgb_param_color_used

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.

Return type

List[Parameter]


rgb_param_color_used_analyse

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

List[Parameter]


rgb_param_used

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.

Return type

List[Parameter]


rgb_param_used_analyse

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

List[Parameter]


rgb_plant_mask

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.

Return type

List[PlantMask]


rgb_plant_mask_measure

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

PlantMask


rgb_plant_param

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.
param_id int ID of the parameter.

Return type

List[PlantParameter]


rgb_plant_param_analyse

Parameters

Name Type Description Notes
id int ID of the resource.
param_id int ID of the parameter.

Return type

List[PlantParameter]


rgb_plant_param_color

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.
param_id int ID of the parameter.

Return type

List[PlantParameter]


rgb_plant_param_color_analyse

Parameters

Name Type Description Notes
id int ID of the resource.
param_id int ID of the parameter.

Return type

List[PlantParameter]


round

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

Round


round_date_experiment

Parameters

Name Type Description Notes
id int ID of the resource.
start datetime Start datetime for filtering results.
stop datetime Stop datetime for filtering results.

Return type

List[Round]


round_experiment

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

List[Round]


round_order_date_experiment

Parameters

Name Type Description Notes
id int ID of the resource.
start datetime Start datetime for filtering results.
stop datetime Stop datetime for filtering results.

Return type

List[RoundOrder]


round_order_experiment

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

List[RoundOrder]


round_order_round

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

RoundOrder


scales_plant_weight

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.

Return type

List[ScalesData]


scales_plant_weight_measure

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

ScalesData


scales_weight_reference_plant

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

PlantWeightReference


scales_weight_reference_to_date_tray

Parameters

Name Type Description Notes
id int ID of the resource.
var_date datetime

Return type

List[PlantWeightReference]


scales_weight_reference_tray

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

List[PlantWeightReference]


scan3d

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.

Return type

List[Scan3DImaging]


scan3d_analyzed_model

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.

Return type

List[Scan3DAnalyzedModel]


scan3d_analyzed_model_analyse

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

List[Scan3DAnalyzedModel]


scan3d_analyzed_model_measure

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

List[Scan3DAnalyzedModel]


scan3d_imaging_extended_data

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.

Return type

MeasureExtendedData


scan3d_imaging_extended_data_measure

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

MeasureExtendedData


scan3d_imaging_measure

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

Scan3DImaging


scan3d_leaf_param

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.
param_id int ID of the parameter.

Return type

List[LeafParameter]


scan3d_leaf_param_analyse

Parameters

Name Type Description Notes
id int ID of the resource.
param_id int ID of the parameter.

Return type

List[LeafParameter]


scan3d_param

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

Parameter


scan3d_param_used

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.

Return type

List[Parameter]


scan3d_param_used_analyse

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

List[Parameter]


scan3d_plant_param

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.
param_id int ID of the parameter.

Return type

List[PlantParameter]


scan3d_plant_param_analyse

Parameters

Name Type Description Notes
id int ID of the resource.
param_id int ID of the parameter.

Return type

List[PlantParameter]


spectrum_device

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

SpectrumDevice


spectrum_device_id

Return type

List[SpectrumDeviceID]


spectrum_values_date_device

Parameters

Name Type Description Notes
id int ID of the resource.
start datetime Start datetime for filtering results.
stop datetime Stop datetime for filtering results.

Return type

List[SpectrumValues]


spray_action

Parameters

Name Type Description Notes
device_id int ID of the device.
round_id int ID of the round.
tray_id int ID of the tray.

Return type

List[SprayAction]


system_log_date_log_tag

Parameters

Name Type Description Notes
tag str
start datetime Start datetime for filtering results.
stop datetime Stop datetime for filtering results.

Return type

List[SystemLog]


system_log_date_log_type

Parameters

Name Type Description Notes
type str
start datetime Start datetime for filtering results.
stop datetime Stop datetime for filtering results.

Return type

List[SystemLog]


system_log_date_round

Parameters

Name Type Description Notes
id int ID of the resource.
start datetime Start datetime for filtering results.
stop datetime Stop datetime for filtering results.

Return type

List[SystemLog]


system_log_date_tray

Parameters

Name Type Description Notes
id int ID of the resource.
start datetime Start datetime for filtering results.
stop datetime Stop datetime for filtering results.

Return type

List[SystemLog]


system_log_log_tag

Return type

List[LogTag]


system_log_log_type

Return type

List[LogType]


system_log_round

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

List[SystemLog]


system_log_tray

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

List[SystemLog]


scales_mapping_tray

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

List[ScalesMapping]


tray

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

Tray


tray_profile

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

TrayProfile


tray_profile_to_date_tray

Parameters

Name Type Description Notes
id int ID of the resource.
var_date datetime

Return type

TrayProfile


tray_profile_tray

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

List[TrayProfile]


tray_profile_used_tray

Parameters

Name Type Description Notes
id int ID of the resource.
start datetime Start datetime for filtering results.
stop datetime Stop datetime for filtering results.

Return type

List[TrayProfile]


tray_round

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

List[Tray]


tray_type

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

TrayType


tray_type_tray

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

TrayType


tray_type_tray_profile

Parameters

Name Type Description Notes
id int ID of the resource.

Return type

TrayType


version_info

Return type

VersionInfo


imaging

Return type

List[Imaging]


Back to top | Back to API Endpoints | Back to Models | Back to README