Flow
class flow_api.flow.Flow
(select=None, cls=None, init=None, by='name', 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'>, description=<class 'flow_api.system.NotSet'>, input_schema=<class 'flow_api.system.NotSet'>, is_bundle_content=<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'>, name=<class 'flow_api.system.NotSet'>, output_schema=<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'>, savepoint_retention=<class 'flow_api.system.NotSet'>, script=<class 'flow_api.system.NotSet'>, track_in_git=<class 'flow_api.system.NotSet'>, debug=False
)
Base class: Resource
A script which contains automation logic.
See the corresponding Resources class at Flow
Parameters
Name | Type | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
allow_deleted | bool | ||||||||||||||||
allow_normal | bool | ||||||||||||||||
breakpoints | Union | The breakpoints of the flow. | |||||||||||||||
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, CHAT, 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. | |||||||||||||||
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. | |||||||||||||||
init | Optional | ||||||||||||||||
input_schema | Union | The schema of the data an execution of the flow accepts in input_value. | |||||||||||||||
is_bundle_content | Union | A flag to control if the resource is considered bundle content. Changes in bundle content mark the bundle as modified. Updating the bundle will modify the bundle content. | |||||||||||||||
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 CHAT, 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:
| |||||||||||||||
max_runtime_minutes | Union | The maximum runtime of executions of this flow in minutes. If set to 0, there is no limit. If set to null, the EXECUTION_MAX_RUNTIME_MINUTES workspace configuration will be used when creating an execution of this flow. | |||||||||||||||
name | Union | The name of this record. Must be unique across a workspace. | |||||||||||||||
output_schema | Union | The schema of the data an execution of the flow produces in output_value. | |||||||||||||||
priority | Union | The execution priority of the flow. Will be inherited to executions of this flow. If unset the EXECUTION_DEFAULT_PRIORITY workspace configuration will be used. Higher priority executions will be processed first. | |||||||||||||||
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, CHAT, 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. | |||||||||||||||
savepoint_retention | Union | Controls which savepoints are retained during execution (e.g. LAST, ALL) | |||||||||||||||
script | Union | The automation logic script. | |||||||||||||||
select | Optional | ||||||||||||||||
track_in_git | Union | Should new records automatically be tracked in git. |