HomeGuidesAPI ReferenceChangelog
Log In
API Reference

Execution

execution keeps all information on time, status and results of a specific pipeline manual or automatic run.

Attributes

NameTypeDescription
execution_iduuid.UUIDtechnical id of execution.
execution_timeintduration of the execution from started.
experiment_iduuid.UUIDexperiment id used in experiment mode.
pipeline_iduuid.UUIDpipeline id executed or to execute.
pipeline_image_iduuid.UUIDpipeline image package to use instead of current pipeline.
propertiesdictconfiguration, parameters and variables (only accessible from front-end to DS api).
queued_dateinttimestamp on which execution is queued, if none use createdDate
started_dateinttimestamp on which execution is started.
statusExecutionStatusexecution status.
template_iduuid.UUIDtemplate id linked to the pipeline.
trigger_iduuid.UUIDtrigger id used if automatic run.
twin_iduuid.UUIDtwin id registered on the template to run pipeline on.
waiting_timeintduration of the waiting time in the queue.
warningslistlist of error and/or warning messages.
versionstrpython version (major.minor) to use as target on runners, by default use current auto-detected version.
edge_device_iduuid.UUIDedge device identifier if executed on edge.
modelslistlist of model outputs (only accessible within runners).
plotslistlist of plot outputs (only accessible within runners).
dataframeslistlist of dataframe outputs (only accessible within runners).

Methods

api_id()

return current object id on Web API format.

endpoint()

return endpoint name used to contact backend.

from_json()

load the object from a dict originating of a JSON format.

NameTypeDefaultDescription
objobject to load information from.

set_id()

specify the id_value neutrally

NameTypeDefaultDescription
id_value
return:

to_json()

transform current object into a dict that could be JSONIFY.

NameTypeDefaultDescription
targetstrNone
return: dumpable dict.