Version: 11 - TBD

Execution

class resources.execution.Execution

Base class: Activity

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

See the corresponding Flow Api class at Execution

Property Description Type Import/Export

activity_type Enum('EXECUTION', 'MESSAGE', 'PROCESS', name='activitytype') neither

break A flag to control if the execution should pause on the next line. Boolean() neither

breakpoints The breakpoints of the execution. ARRAY(SmallInteger()) import only

bundle_id Reference 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, ORGANIZATION, PROCESS, PROJECT, USER, WORKSPACE. Mutually exclusive with project_id UUID(as_uuid=False) both

bundle_name The name of the bundle. Will look up the bundle and set bundle_id. String(length=128) neither

commit_message The commit message for this change. Text() import only

connector_id The ID of the connector record the execution is using. UUID(as_uuid=False) both

connector_name The name of the connector. Only used for type CONNECTION String(length=128) neither

connector_type The type of the connector / the type of the remote system. Enum('AWS', 'AZURE', 'AZUREAI', 'FTP', 'GIT', 'GOOGLE', 'IMAP', 'K8S', 'LDAP', 'MSTEAMS', 'MYSQL', 'OPENAI', 'PS', 'REDIS', 'REST', 'SCP', 'SFTP', 'SMB', 'SMTP', 'SOAP', 'SQLMSSQL', 'SQLORACLE', 'SQLPG', 'SSH', 'VAULT', 'WEBDAV', 'XMLRPC', name='connectortype') both

created_at DateTime(timezone=True) export only

created_by UUID(as_uuid=False) export only

custom_object_id If this execution was created by the on_create, on_update, or on_delete hook of an object template, this field contains the reference to the custom object. UUID(as_uuid=False) both

deleted_at DateTime(timezone=True) export only

deleted_by UUID(as_uuid=False) export only

dependency_id The ID of the dependency record the execution is currently waiting for. UUID(as_uuid=False) export only

description A multiline description of what this record is and does. Text() both

end_status Enum('WAITING_DEPENDENCY', 'WAITING_LOCK', 'WAITING_ENGINE', 'WAITING_RESPONSE', 'AT_ENGINE', 'ENDED_SUCCESS', 'ENDED_ERROR', 'ENDED_CANCELLED', 'PAUSED', 'SCHEDULED', 'LOST', name='executionstatus') neither

ended_at The timestamp when the execution ended. DateTime(timezone=True) both

flow_id The ID of the flow record the execution is processing. UUID(as_uuid=False) both

flow_name The name of the flow. Only used for type FLOW String(length=128) neither

has_deprecation Boolean() export only

has_syntax_error Boolean() export only

id UUID(as_uuid=False) neither

identity_type Enum('EXECUTION', 'LDAP_CONFIG', 'SCHEDULE', 'SYNC_CONFIG', 'USER', 'WEBHOOK', 'WORKSPACE', name='identitytype') neither

input_schema The schema of the data the execution accepts in input_value. JSONEncodedData() both

input_value The data which was passed to the execution. JSONEncodedData() both

is_bundle_readonly Boolean() neither

is_deleted Boolean() export only

is_hidden Boolean() neither

is_paused A flag to control if the execution should be processed. Boolean() both

is_productive A flag to control if the execution runs in productive mode. Boolean() both

is_project_readonly Boolean() neither

is_queued If set, the execution is waiting to be processed. Boolean() neither

is_readonly A 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 EXECUTION, LDAP_CONFIG, MESSAGE, ORGANIZATION, PROCESS, USER, WORKSPACE Boolean() both

is_remote_processed A flag to control if the execution is processed in a remote workspace. Boolean() both

last_activity The last time the identity was active in Cloudomation. Output only. DateTime(timezone=True) neither

last_command The flow_api command which is currently executed. String(length=128) export only

last_sync Timestamp of when the execution was last synced with a workspace sync_config. DateTime(timezone=True) both

lineno The line number of the script which is currently executed. SmallInteger() export only

location_inheritance

Controls 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.

String(length=128)

neither

message A status message. Text() both

message_id The ID of the message record the execution is currently awaiting a response from. UUID(as_uuid=False) export only

metadata Additional data which can be stored in the execution. JSONEncodedData() both

modified_at DateTime(timezone=True) export only

modified_by UUID(as_uuid=False) export only

name The name of this record. Must be unique across a workspace. String(length=128) both

organization_id UUID(as_uuid=False) export only

orphan If set, the child execution will be disconnected from the execution tree Boolean() neither

output_schema The schema of the data the execution produces in output_value. JSONEncodedData() both

output_value The data returned by the execution JSONEncodedData() both

parent_execution_id The ID of the execution which created this execution. UUID(as_uuid=False) export only

plugin_action_id Reference to the plugin_action this execution was started by. UUID(as_uuid=False) both

priority The priority of the execution. Higher priority executions will be processed first. SmallInteger() export only

process_id UUID(as_uuid=False) neither

project_id Reference 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, LDAP_CONFIG, ORGANIZATION, PROCESS, PROJECT, ROLE, USER, WORKSPACE. Mutually exclusive with bundle_id. UUID(as_uuid=False) both

project_name The name of the project. Will look up the project and set project_id. String(length=128) neither

provisioning_type If this execution was created by the on_create, on_update, or on_delete hook of an object template. String(length=128) export only

record_type Enum('BUNDLE', 'BUNDLE_REPOSITORY', 'CONNECTOR', 'CUSTOM_OBJECT', 'DEVOLUTIONS_CONFIG', 'EXECUTION', 'FILE', 'FLOW', 'LDAP_CONFIG', 'MESSAGE', 'OAUTH', 'OBJECT_TEMPLATE', 'ORGANIZATION', 'PLUGIN', 'PROCESS', 'PROJECT', 'ROLE', 'SCHEDULE', 'SCHEDULER', 'SCHEMA', 'SETTING', 'SYNC_CONFIG', 'TAG', 'USER', 'VAULT_CONFIG', 'WEBHOOK', 'WORKSPACE', 'WRAPPER', name='recordtype') neither

remote_workspace_name The name of the workspace where this execution is remotely running String(length=128) neither

repository_path The path to the storing repository, relative to GIT_REPOSITORY_SAVE_PATH String(length=256) neither

roles The roles this identity has. JSONEncodedData() import only

savepoint_retention Controls which savepoints are retained during execution (e.g. LAST, ALL) Enum('ALL', 'LAST', name='savepointretention') both

schedule_id The associated schedule for this execution UUID(as_uuid=False) both

schedule_name The name of the schedule. Only used for type SCHEDULE String(length=128) neither

scheduled_for The timestamp when the execution will continue. This field is also used for timeouts. DateTime(timezone=True) both

schema_version String(length=128) both

script The script the execution is processing. Text() both

setting_id The ID of the setting record the execution is currently trying to acquire a lock from. UUID(as_uuid=False) export only

started_at The timestamp when the execution started. DateTime(timezone=True) both

status The status of the execution. Output only. Enum('WAITING_DEPENDENCY', 'WAITING_LOCK', 'WAITING_ENGINE', 'WAITING_RESPONSE', 'AT_ENGINE', 'ENDED_SUCCESS', 'ENDED_ERROR', 'ENDED_CANCELLED', 'PAUSED', 'SCHEDULED', 'LOST', name='executionstatus') both

status_label String(length=128) neither

sync_config_id The ID of the workspace sync_config the execution is associated with. UUID(as_uuid=False) both

top_execution_id The ID of the top-most execution which created this execution. UUID(as_uuid=False) export only

type The type of the execution. Enum('FLOW', 'SCRIPT', 'CONNECTION', 'SCHEDULE', 'WRAPPER', name='executiontype') both

unwrapped If 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. Boolean() neither

use_breakpoints A flag to control if the execution will stop at breakpoints. Boolean() both

use_only_explicit_breakpoints Should only explicitly defined breakpoints be used, this disables the step-through feature. Boolean() both

webhook_id The associated webhook for this execution UUID(as_uuid=False) both

workspace_id UUID(as_uuid=False) export only

wrapper_id The ID of the wrapper record the execution is processing. UUID(as_uuid=False) both

wrapper_name The name of the wrapper. Only used for type WRAPPER String(length=128) neither

wrappers A list of dynamic wrappers to apply around the execution. Provide a list of objects in the form [{"wrapper_id": ..., "params": {...}}]. JSONEncodedData() neither