Dashboard
class flow_api.dashboard.Dashboard(select=None, cls=None, init=None, by='name', allow_normal=True, allow_deleted=False, commit=False, 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'>, is_bundle_content=<class 'flow_api.system.NotSet'>, is_readonly=<class 'flow_api.system.NotSet'>, location_inheritance=<class 'flow_api.system.NotSet'>, name=<class 'flow_api.system.NotSet'>, project_id=<class 'flow_api.system.NotSet'>, project_name=<class 'flow_api.system.NotSet'>, track_in_git=<class 'flow_api.system.NotSet'>, value=<class 'flow_api.system.NotSet'>, debug=False)
Base class: Resource
A configurable dashboard. Stores a JSON layout configuration which the UI renders as an interactive grid of widgets (record lists, single records, action buttons, embedded execution output, relation graphs, …).
The value column holds the dashboard configuration. Its shape is
validated client-side against the published dashboard config JSON Schema;
the backend treats it as opaque JSON, exactly like Setting.
See the corresponding Resources class at Dashboard
Parameters
| Name | Type | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| allow_deleted | bool | ||||||||||||||||
| allow_normal | bool | ||||||||||||||||
| bundle_id | Union | Reference to the bundle this record is associated with. Allowed for BUNDLE_REPOSITORY, CONNECTOR, CUSTOM_OBJECT, DASHBOARD, DEVOLUTIONS_CONFIG, EXECUTION, FILE, FLOW, LDAP_CONFIG, MCP_USER_TOOL, 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. | |||||||||||||||
| 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 | ||||||||||||||||
| 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, DASHBOARD, DEVOLUTIONS_CONFIG, FILE, FLOW, MCP_USER_TOOL, 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:
| |||||||||||||||
| name | Union | The name of this record. Must be unique across a workspace. | |||||||||||||||
| project_id | Union | Reference to the project this record is associated with. Allowed for CONNECTOR, CUSTOM_OBJECT, DASHBOARD, DEVOLUTIONS_CONFIG, EXECUTION, FILE, FLOW, MCP_USER_TOOL, 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. | |||||||||||||||
| select | Optional | ||||||||||||||||
| track_in_git | Union | Should new records automatically be tracked in git. | |||||||||||||||
| value | Union | The dashboard layout configuration. |