PluginAction
class flow_api.plugin_action.PluginAction
(select=None, cls=None, init=None, by='name', allow_normal=True, allow_deleted=False, commit=False, color=<class 'flow_api.system.NotSet'>, description=<class 'flow_api.system.NotSet'>, execution_location=<class 'flow_api.system.NotSet'>, flow_id=<class 'flow_api.system.NotSet'>, icon=<class 'flow_api.system.NotSet'>, is_enabled=<class 'flow_api.system.NotSet'>, name=<class 'flow_api.system.NotSet'>, parent_plugin_action_id=<class 'flow_api.system.NotSet'>, plugin_id=<class 'flow_api.system.NotSet'>, record_filter=<class 'flow_api.system.NotSet'>, record_type=<class 'flow_api.system.NotSet'>, type=<class 'flow_api.system.NotSet'>, debug=False
)
Base class: Row
A PluginAction creates an Execution of a Flow. The id of the Resource where the PluginAction originates from, is passed to the Execution as an input value.
Parameters
Name | Type | Description |
---|---|---|
allow_deleted | bool | |
allow_normal | bool | |
by | str | |
cls | Optional | |
color | Union | The color of of the button of the plugin_action. |
commit | bool | |
debug | bool | if set, the content of the data being written will be logged. |
description | Union | The description of the plugin_action. |
execution_location | Union | Controls the project association of executions created by this webhook. Following options are available: execution_location |
flow_id | Union | The id of the flow that is started by the plugin_action. |
icon | Union | The icon of the button of the plugin_action. |
init | Optional | |
is_enabled | Union | A flag to control if the plugin_action is enabled. |
name | Union | The name of the plugin_action. |
parent_plugin_action_id | Union | Reference to the parent_plugin_action. The parent_plugin_action must reference the same plugin as the child. |
plugin_id | Union | Reference to the plugin this plugin_action belongs to. |
record_filter | Union | A filter to limit the records for which the action is displayed. |
record_type | Union | Which record types the plugin_action is available for. |
select | Optional | |
type | Union | Controls whether this plugin_action is available for single records or for a list of records. |