Skip to main content
Version: 12 - TBD

Execution

class flow_api.execution.Execution(select=None, cls=None, init=None, by='id', allow_normal=True, allow_deleted=False, commit=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'>, location_inheritance=<class 'flow_api.system.NotSet'>, max_runtime_minutes=<class 'flow_api.system.NotSet'>, message=<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'>, parent_execution_id=<class 'flow_api.system.NotSet'>, plugin_action_id=<class 'flow_api.system.NotSet'>, priority=<class 'flow_api.system.NotSet'>, project_id=<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_id=<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'>, track_in_git=<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'>, webhook_id=<class 'flow_api.system.NotSet'>, wrapper_id=<class 'flow_api.system.NotSet'>, wrapper_name=<class 'flow_api.system.NotSet'>, wrappers=<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
breakpointsUnionThe breakpoints of the execution.
bundle_idUnionReference to the bundle this record is associated with. Allowed for BUNDLE_REPOSITORY, CONNECTOR, CUSTOM_OBJECT, DEVOLUTIONS_CONFIG, EXECUTION, FILE, FLOW, LDAP_CONFIG, MESSAGE, OAUTH, OBJECT_TEMPLATE, PLUGIN, ROLE, SCHEDULE, SCHEDULER, SCHEMA, SETTING, SYNC_CONFIG, TAG, VAULT_CONFIG, WEBHOOK, WRAPPER. Not allowed for BUNDLE, CHAT, ORGANIZATION, PROCESS, PROJECT, USER, WORKSPACE. Mutually exclusive with project_id
bundle_nameUnionThe name of the bundle. Will look up the bundle and set bundle_id.
bystr
clsOptional
commitbool
commit_messageUnionThe commit message for this change.
connector_idUnionThe ID of the connector record the execution is using.
connector_nameUnionThe name of the connector. Only used for type CONNECTION
connector_typeUnionThe type of the connector / the type of the remote system.
debugboolif set, the content of the data being written will be logged.
descriptionUnionA multiline description of what this record is and does.
flow_idUnionThe ID of the flow record the execution is processing.
flow_nameUnionThe name of the flow. Only used for type FLOW
initOptional
input_schemaUnionThe schema of the data the execution accepts in input_value.
input_valueUnionThe data which was passed to the execution.
is_pausedUnionA flag to control if the execution should be processed.
is_productiveUnionA flag to control if the execution runs in productive mode.
is_readonlyUnionA flag to control if the record can be modified. Allowed for BUNDLE, BUNDLE_REPOSITORY, CONNECTOR, CUSTOM_OBJECT, DEVOLUTIONS_CONFIG, FILE, FLOW, OAUTH, OBJECT_TEMPLATE, PLUGIN, PROJECT, ROLE, SCHEDULE, SCHEDULER, SCHEMA, SETTING, SYNC_CONFIG, TAG, VAULT_CONFIG, WEBHOOK, WRAPPER. Not allowed for CHAT, EXECUTION, LDAP_CONFIG, MESSAGE, ORGANIZATION, PROCESS, USER, WORKSPACE
location_inheritanceUnionControls the project/bundle association of a newly created record when no project_id/project_name/bundle_id/bundle_name is specified in the create request. Depending on the record type different options are available:
location_inheritance record types description
created_by all use the same location as the identity which creates the record
default all use the "Default project" where applicable or "Workspace" for record types which cannot be in a project
wrapped_resource execution use the same location as the innermost resource which is wrapped
resource execution use the same location as the resource on which the execution is based on
Notes:
  • If a project_id/project_name/bundle_id/bundle_name is specified in the request, it always takes precedence.
  • The options wrapped_resource and resource only work with executions which are based on a resource, not with ad-hoc connections or executions of type "SCRIPT". If used with ad-hoc connections or "SCRIPT" it will fall back to default.
  • If the record being created cannot be associated with the specified location, the fallback to default will be used.
  • If location_inheritance is unset, the default value used depends on the type of identity which creates the record as well as the type of record which is created. If an execution is created by any identity which is not an execution, it defaults to wrapped_resource. In all other cases it defaults to created_by.
max_runtime_minutesUnionThe maximum runtime of the execution in minutes. If set to 0, there is no limit.
messageUnionA status message.
nameUnionThe name of this record. Must be unique across a workspace.
orphanUnionIf set, the child execution will be disconnected from the execution tree
output_schemaUnionThe schema of the data the execution produces in output_value.
output_valueUnionThe data returned by the execution
parent_execution_idUnionThe ID of the execution which created this execution.
plugin_action_idUnionReference to the plugin_action this execution was started by.
priorityUnionThe priority of the execution. Higher priority executions will be processed first. Executions with the same priority are processed in the order they were created.
project_idUnionReference to the project this record is associated with. Allowed for CONNECTOR, CUSTOM_OBJECT, DEVOLUTIONS_CONFIG, 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, CHAT, LDAP_CONFIG, ORGANIZATION, PROCESS, PROJECT, ROLE, USER, WORKSPACE. Mutually exclusive with bundle_id.
project_nameUnionThe name of the project. Will look up the project and set project_id.
remote_workspace_nameUnionThe name of the workspace where this execution is remotely running
rolesUnionThe roles this identity has.
savepoint_retentionUnionControls which savepoints are retained during execution (e.g. LAST, ALL)
schedule_idUnionThe associated schedule for this execution
schedule_nameUnionThe name of the schedule. Only used for type SCHEDULE
scheduled_forUnionThe timestamp when the execution will continue. This field is also used for timeouts.
scriptUnionThe script the execution is processing.
selectOptional
track_in_gitUnionShould new records automatically be tracked in git.
typeUnionThe type of the execution.
unwrappedUnionIf set, static wrappers which are registered on the flow are not used. Dynamically added wrappers and wrappers which are explicitly added using the wrappers field are still used.
use_breakpointsUnionA flag to control if the execution will stop at breakpoints.
use_only_explicit_breakpointsUnionShould only explicitly defined breakpoints be used, this disables the step-through feature.
webhook_idUnionThe associated webhook for this execution
wrapper_idUnionThe ID of the wrapper record the execution is processing.
wrapper_nameUnionThe name of the wrapper. Only used for type WRAPPER
wrappersUnionA list of dynamic wrappers to apply around the execution. Provide a list of objects in the form [{"wrapper_id": ..., "params": {...}}].

Constants​

RESOURCE = execution

Methods​

add_child​

add_execution_parent_execution_id​

add_identity_role​

add_operation​

add_record_metadata​

add_record_tag​

add_record_user​

add_setting​

breakpoint​

bundle​

cancel​

cancel_process​

chat​

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​

duplicate​

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​

git_log_list​

identity_role_list​

ignore​

ignore_dependency​

ignore_lock​

ignore_response​

ignore_scheduled​

load_savepoint​

lock​

log​

log_data​

log_markdown​

message​

metadata​

metadata_exists​

modified_by_identity​

operation_list​

organization​

parent​

parent_execution_id_execution​

pause​

pause_process​

pending_delete_identity_id_identity​

pending_restore_identity_id_identity​

pending_trash_identity_id_identity​

plugin_action​

process​

project​

record_list_created_by​

record_list_deleted_by​

record_list_modified_by​

record_list_pending_delete_identity_id​

record_list_pending_restore_identity_id​

record_list_pending_trash_identity_id​

record_log_list​

record_metadata_list​

record_tag_list​

record_user_list​

release_lock​

remove_savepoints​

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​