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'>, 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
| Name | Type | Description |
|---|---|---|
| allow_deleted | bool | |
| allow_normal | bool | |
| breakpoints | Union | The breakpoints of the execution. |
| bundle_id | Union | 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 |
| bundle_name | Union | The name of the bundle. Will look up the bundle and set bundle_id. |
| by | str | |
| cls | Optional | |
| commit | bool | |
| commit_message | Union | The commit message for this change. |
| connector_id | Union | The ID of the connector record the execution is using. |
| connector_name | Union | The name of the connector. Only used for type CONNECTION |
| connector_type | Union | The type of the connector / the type of the remote system. |
| debug | bool | if set, the content of the data being written will be logged. |
| description | Union | A multiline description of what this record is and does. |
| flow_id | Union | The ID of the flow record the execution is processing. |
| flow_name | Union | The name of the flow. Only used for type FLOW |
| init | Optional | |
| input_schema | Union | The schema of the data the execution accepts in input_value. |
| input_value | Union | The data which was passed to the execution. |
| is_paused | Union | A flag to control if the execution should be processed. |
| is_productive | Union | A flag to control if the execution runs in productive mode. |
| is_readonly | Union | 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 |
| location_inheritance | Union | 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: <table> <thead> <tr> <th>location_inheritance</th> <th>record types</th> <th>description</th> </tr> </thead> <tbody> <tr> <td><code>created_by</code></td> <td>all</td> <td>use the same location as the identity which creates the record</td> </tr> <tr> <td><code>default</code></td> <td>all</td> <td>use the "Default project" where applicable or "Workspace" for record types which cannot be in a project</td> </tr> <tr> <td><code>wrapped_resource</code></td> <td>execution</td> <td>use the same location as the innermost resource which is wrapped</td> </tr> <tr> <td><code>resource</code></td> <td>execution</td> <td>use the same location as the resource on which the execution is based on</td> </tr> </tbody> </table> Notes: <ul> <li>If a <code>project_id</code>/<code>project_name</code>/<code>bundle_id</code>/<code>bundle_name</code> is specified in the request, it always takes precedence.</li> <li>The options <code>wrapped_resource</code> and <code>resource</code> 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 <code>default</code>.</li> <li>If the record being created cannot be associated with the specified location, the fallback to <code>default</code> will be used.</li> <li>If <code>location_inheritance</code> 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 <code>wrapped_resource</code>. In all other cases it defaults to <code>created_by</code>.</li> </ul> |
| max_runtime_minutes | Union | The maximum runtime of the execution in minutes. If set to 0, there is no limit. |
| message | Union | A status message. |
| name | Union | The name of this record. Must be unique across a workspace. |
| orphan | Union | If set, the child execution will be disconnected from the execution tree |
| output_schema | Union | The schema of the data the execution produces in output_value. |
| output_value | Union | The data returned by the execution |
| plugin_action_id | Union | Reference to the plugin_action this execution was started by. |
| priority | Union | The 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_id | Union | 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. |
| project_name | Union | The name of the project. Will look up the project and set project_id. |
| remote_workspace_name | Union | The name of the workspace where this execution is remotely running |
| roles | Union | The roles this identity has. |
| savepoint_retention | Union | Controls which savepoints are retained during execution (e.g. LAST, ALL) |
| schedule_id | Union | The associated schedule for this execution |
| schedule_name | Union | The name of the schedule. Only used for type SCHEDULE |
| scheduled_for | Union | The timestamp when the execution will continue. This field is also used for timeouts. |
| script | Union | The script the execution is processing. |
| select | Optional | |
| track_in_git | Union | Should new records automatically be tracked in git. |
| type | Union | The type of the execution. |
| unwrapped | Union | 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. |
| use_breakpoints | Union | A flag to control if the execution will stop at breakpoints. |
| use_only_explicit_breakpoints | Union | Should only explicitly defined breakpoints be used, this disables the step-through feature. |
| webhook_id | Union | The associated webhook for this execution |
| wrapper_id | Union | The ID of the wrapper record the execution is processing. |
| wrapper_name | Union | The name of the wrapper. Only used for type WRAPPER |
| wrappers | Union | A list of dynamic wrappers to apply around the execution. Provide a list of objects in the form [{"wrapper_id": ..., "params": {...}}]. |