Skip to main content
Version: 10 - TBD

Execution

class flow_api.execution.Execution(select=None, cls=None, init=None, by='id', allow_normal=True, allow_deleted=False, breakpoints=[class 'flow_api.system.NotSet'], bundle_id=[class 'flow_api.system.NotSet'], bundle_name=[class 'flow_api.system.NotSet'], commit_message=[class 'flow_api.system.NotSet'], connector_id=[class 'flow_api.system.NotSet'], connector_name=[class 'flow_api.system.NotSet'], connector_type=[class 'flow_api.system.NotSet'], description=[class 'flow_api.system.NotSet'], flow_id=[class 'flow_api.system.NotSet'], flow_name=[class 'flow_api.system.NotSet'], input_schema=[class 'flow_api.system.NotSet'], input_value=[class 'flow_api.system.NotSet'], is_paused=[class 'flow_api.system.NotSet'], is_productive=[class 'flow_api.system.NotSet'], is_readonly=[class 'flow_api.system.NotSet'], message=[class 'flow_api.system.NotSet'], metadata=[class 'flow_api.system.NotSet'], name=[class 'flow_api.system.NotSet'], orphan=[class 'flow_api.system.NotSet'], output_schema=[class 'flow_api.system.NotSet'], output_value=[class 'flow_api.system.NotSet'], project_id=[class 'flow_api.system.NotSet'], project_inheritance=[class 'flow_api.system.NotSet'], project_name=[class 'flow_api.system.NotSet'], remote_workspace_name=[class 'flow_api.system.NotSet'], roles=[class 'flow_api.system.NotSet'], savepoint_retention=[class 'flow_api.system.NotSet'], schedule_name=[class 'flow_api.system.NotSet'], scheduled_for=[class 'flow_api.system.NotSet'], script=[class 'flow_api.system.NotSet'], type=[class 'flow_api.system.NotSet'], unwrapped=[class 'flow_api.system.NotSet'], use_breakpoints=[class 'flow_api.system.NotSet'], use_only_explicit_breakpoints=[class 'flow_api.system.NotSet'], wrapper_id=[class 'flow_api.system.NotSet'], wrapper_name=[class 'flow_api.system.NotSet'], debug=False)

Base class: Activity

An automation (flow, script, or connection) which is or was running.

See the corresponding Resources class at Execution

Parameters​

NameTypeDescription
allow_deletedbool
allow_normalbool
breakpointstyping.Union[ flow_api.system.NotSet, list ]The breakpoints of the execution.
bundle_idtyping.Union[ flow_api.system.NotSet, str, NoneType ]Reference to the bundle this record is associated with. Allowed for BUNDLE_REPOSITORY, CONNECTOR, CUSTOM_OBJECT, FILE, FLOW, LDAP_CONFIG, OAUTH, OBJECT_TEMPLATE, PLUGIN, ROLE, SCHEDULE, SCHEDULER, SCHEMA, SETTING, SYNC_CONFIG, TAG, VAULT_CONFIG, WEBHOOK, WRAPPER. Not allowed for BUNDLE, EXECUTION, MESSAGE, ORGANIZATION, PROCESS, PROJECT, USER, WORKSPACE. Mutually exclusive with project_id
bundle_nametyping.Union[ flow_api.system.NotSet, str, NoneType ]The name of the bundle. Will look up the bundle and set bundle_id.
bystr
clstyping.Union[ type, NoneType ]
commit_messagetyping.Union[ flow_api.system.NotSet, str, NoneType ]The commit message for this change.
connector_idtyping.Union[ flow_api.system.NotSet, str, NoneType ]The ID of the connector record the execution is using.
connector_nametyping.Union[ flow_api.system.NotSet, str, NoneType ]The name of the connector. Only used for type CONNECTION
connector_typetyping.Union[ flow_api.system.NotSet, str, NoneType ]The type of the connector / the type of the remote system.
debugboolif set, the content of the data being written will be logged.
descriptiontyping.Union[ flow_api.system.NotSet, str, NoneType ]A multiline description of what this record is and does.
flow_idtyping.Union[ flow_api.system.NotSet, str, NoneType ]The ID of the flow record the execution is processing.
flow_nametyping.Union[ flow_api.system.NotSet, str, NoneType ]The name of the flow. Only used for type FLOW
inittyping.Union[ dict, NoneType ]
input_schematyping.Union[ flow_api.system.NotSet, dict, NoneType ]The schema of the data the execution accepts in input_value.
input_valuetyping.Union[ flow_api.system.NotSet, dict, NoneType ]The data which was passed to the execution.
is_pausedtyping.Union[ flow_api.system.NotSet, bool ]A flag to control if the execution should be processed.
is_productivetyping.Union[ flow_api.system.NotSet, bool ]A flag to control if the execution runs in productive mode.
is_readonlytyping.Union[ flow_api.system.NotSet, bool ]A flag to control if the record can be modified. Allowed for BUNDLE, BUNDLE_REPOSITORY, CONNECTOR, CUSTOM_OBJECT, FILE, FLOW, OAUTH, OBJECT_TEMPLATE, PLUGIN, PROJECT, ROLE, SCHEDULE, SCHEDULER, SCHEMA, SETTING, SYNC_CONFIG, TAG, VAULT_CONFIG, WEBHOOK, WRAPPER. Not allowed for EXECUTION, LDAP_CONFIG, MESSAGE, ORGANIZATION, PROCESS, USER, WORKSPACE
messagetyping.Union[ flow_api.system.NotSet, str, NoneType ]A status message.
metadatatyping.Union[ flow_api.system.NotSet, dict, NoneType ]Additional data which can be stored in the execution.
nametyping.Union[ flow_api.system.NotSet, str ]The name of this record. Must be unique across a workspace.
orphantyping.Union[ flow_api.system.NotSet, bool, NoneType ]If set, the child execution will be disconnected from the execution tree
output_schematyping.Union[ flow_api.system.NotSet, dict, NoneType ]The schema of the data the execution produces in output_value.
output_valuetyping.Union[ flow_api.system.NotSet, dict, NoneType ]The data returned by the execution
project_idtyping.Union[ flow_api.system.NotSet, str, NoneType ]Reference to the project this record is associated with. Allowed for CONNECTOR, CUSTOM_OBJECT, EXECUTION, FILE, FLOW, MESSAGE, OAUTH, OBJECT_TEMPLATE, PLUGIN, SCHEDULE, SCHEDULER, SCHEMA, SETTING, SYNC_CONFIG, TAG, VAULT_CONFIG, WEBHOOK, WRAPPER. Not allowed for BUNDLE, BUNDLE_REPOSITORY, LDAP_CONFIG, ORGANIZATION, PROCESS, PROJECT, ROLE, USER, WORKSPACE. Mutually exclusive with bundle_id.
project_inheritancetyping.Union[ flow_api.system.NotSet, str, NoneType ]One of parent_execution - inherit the project_id from the parent execution. Not applicable if there is no parent execution; resource - inherit the project from the resource which is used to create this execution. Not applicable when running a script or an ad-hoc connection); or explicit - do not inherit project_id. When using this option a project_id must also be set. If this parameter is unset it will use explicit if there is a project_id set, parent_execution if there is a parent, resource if the resource is in a project, and a fallback to "Default project".
project_nametyping.Union[ flow_api.system.NotSet, str, NoneType ]The name of the project. Will look up the project and set project_id.
remote_workspace_nametyping.Union[ flow_api.system.NotSet, str, NoneType ]The name of the workspace where this execution is remotely running
rolestyping.Union[ flow_api.system.NotSet, dict, NoneType ]The roles this identity has.
savepoint_retentiontyping.Union[ flow_api.system.NotSet, str, NoneType ]Controls which savepoints are retained during execution (e.g. LAST, ALL)
schedule_nametyping.Union[ flow_api.system.NotSet, str, NoneType ]The name of the schedule. Only used for type SCHEDULE
scheduled_fortyping.Union[ flow_api.system.NotSet, datetime.datetime, NoneType ]The timestamp when the execution will continue. This field is also used for timeouts.
scripttyping.Union[ flow_api.system.NotSet, str, NoneType ]The script the execution is processing.
selecttyping.Union[ str, NoneType ]
typetyping.Union[ flow_api.system.NotSet, str ]The type of the execution.
unwrappedtyping.Union[ flow_api.system.NotSet, bool, NoneType ]If set, wrappers which are registered on the flow are not used
use_breakpointstyping.Union[ flow_api.system.NotSet, bool ]A flag to control if the execution will stop at breakpoints.
use_only_explicit_breakpointstyping.Union[ flow_api.system.NotSet, bool ]Should only explicitly defined breakpoints be used, this disables the step-through feature.
wrapper_idtyping.Union[ flow_api.system.NotSet, str, NoneType ]The ID of the wrapper record the execution is processing.
wrapper_nametyping.Union[ flow_api.system.NotSet, str, NoneType ]The name of the wrapper. Only used for type WRAPPER

Constants​

RESOURCE = execution

Methods​

add_identity_role​

add_operation​

add_record_tag​

add_record_user​

add_role​

add_setting​

add_tag​

breakpoint​

bundle​

cancel​

cancel_process​

child​

child_list​

children​

clone​

connect​

connector​

create_savepoint​

created_by_identity​

custom_object​

delete​

delete_process​

deleted_by_identity​

dependency​

dependency_execution_list​

dependency_list​

end​

error​

execution_dump_list​

execution_list_parent_execution_id​

execution_list_sync_config_id​

execution_list_top_execution_id​

exists​

export​

flow​

get​

get_dict​

get_identity_created_by​

get_identity_deleted_by​

get_identity_modified_by​

get_logs​

get_roles​

get_tags​

identity_role_list​

ignore​

ignore_dependency​

ignore_lock​

ignore_response​

ignore_scheduled​

load_savepoint​

lock​

log​

message​

modified_by_identity​

operation_list​

organization​

parent​

parent_execution_id_execution​

pause​

pause_process​

plugin_action​

process​

project​

record_list_created_by​

record_list_deleted_by​

record_list_modified_by​

record_log_list​

record_tag_list​

record_user_list​

release_lock​

remove_role​

remove_savepoints​

remove_tag​

restore​

run​

run_async​

run_process​

save​

schedule​

script​

set_output​

setting​

setting_list​

sleep​

sleep_until​

success​

sync_config_id_identity​

top​

top_execution_id_execution​

using​

wait​

wait_for​

wait_lock​

wait_status​

webhook​

webhook_base64_response​

webhook_bytes_response​

webhook_html_response​

webhook_json_response​

webhook_response​

workspace​

wrapper​