Version: 12 - TBD

Dashboard

class resources.dashboard.Dashboard

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 Flow Api class at Dashboard

Property Description Type Import/Export

bundle_id 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 UUID(as_uuid=False) both

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

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

created_at DateTime(timezone=True) export only

created_by UUID(as_uuid=False) export only

deleted_at When the record was moved to the trashbin. Null while the record is active. DateTime(timezone=True) import only

deleted_by UUID(as_uuid=False) import only

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

has_deprecation Boolean() export only

has_syntax_error Boolean() export only

id UUID(as_uuid=False) neither

is_bundle_content 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. Boolean() both

is_bundle_readonly Boolean() neither

is_deleted Whether the record has been permanently deleted. Records in the trashbin are indicated by deleted_at instead. Boolean() export only

is_project_readonly Boolean() neither

is_readonly 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 Boolean() both

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)

import only

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

pending_delete_commit Boolean() neither

pending_delete_identity_id UUID(as_uuid=False) neither

pending_operation_id UUID(as_uuid=False) neither

pending_restore_commit Boolean() neither

pending_restore_identity_id UUID(as_uuid=False) neither

pending_trash_commit Boolean() neither

pending_trash_identity_id UUID(as_uuid=False) neither

project_id 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. UUID(as_uuid=False) both

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

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

recurse_pending_delete Boolean() neither

recurse_pending_restore Boolean() neither

recurse_pending_trash Boolean() neither

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

resource_type Enum('BUNDLE', 'BUNDLE_REPOSITORY', 'CONNECTOR', 'CUSTOM_OBJECT', 'DASHBOARD', 'DEVOLUTIONS_CONFIG', 'FILE', 'FLOW', 'LDAP_CONFIG', 'MCP_USER_TOOL', 'OAUTH', 'OBJECT_TEMPLATE', 'ORGANIZATION', 'PLUGIN', 'PROJECT', 'ROLE', 'SCHEDULE', 'SCHEDULER', 'SCHEMA', 'SETTING', 'SYNC_CONFIG', 'TAG', 'USER', 'VAULT_CONFIG', 'WEBHOOK', 'WORKSPACE', 'WRAPPER', name='resourcetype') neither

schema_version String(length=128) both

track_in_git Should new records automatically be tracked in git. Boolean() both

value The dashboard layout configuration. JSONEncodedData() both

workspace_id UUID(as_uuid=False) export only