API · v1 · stabil
CODEMETA OSDeveloper Center
Konsole öffnen
Entity · dashboard_templates

Dashboard Template Schema

Schema-ID
dashboard_template
Collection
dashboard_templates
Permissions
  • Lesendashboard_template_view
  • Anlegendashboard_template_create
  • Änderndashboard_template_edit
  • Löschendashboard_template_delete

Felder

Dashboard Template Schema

dashboard_templates4 Permissions

Schema for validating dashboard templates (tenant- or user-scoped layout presets)

namestringerforderlich

Display name of the template

1–100 Zeichen
descriptionstringoptional
max 500 Zeichennullable
scopestringerforderlich

user = private/personal or shared by a user; tenant = tenant-wide template

Werte
usertenant
userIduuidoptional

Owner userId (for scope=user). Set by the server.

nullable
configobjecterforderlich
versionintegererforderlich
read-only
layoutobjecterforderlich
presetstringerforderlich
Werte
1-col2-col-sidebar2-col-equal3-col-equal
customWidthsstringoptional
nullable
metricsobject[]erforderlich
idstringerforderlich
1–100 Zeichen
typestringerforderlich
1–100 Zeichen
settingsobjecterforderlich
columnSpanintegeroptional

Number of content-grid columns this widget should span. Default 1. Only meaningful in columns[], ignored in metrics.

1 – 6
columnsarray[]erforderlich
isDefaultbooleanoptional

For scope=user: active template for the owner on login. For scope=tenant: tenant default.

Default: false
isSharedbooleanoptional

Only meaningful for scope=user. Makes the template readable by all tenant users.

Default: false
sharedWithUserIdsuuid[]optional

For scope=user: explicit per-user read grants, independent of isShared. Mirrors dashboard_widget_group sharing (ADR 0164).

max 200 Itemsnullable
teamIdsuuid[]optional

For scope=user: org-unit/team IDs whose members may read the template (ADR 0164).

max 100 Itemsnullable
isPredefinedbooleanoptional

Read-only template seeded by the platform; protected from editing/deletion.

Default: falseread-only
predefinedKeystringoptional

Stable key for predefined templates (e.g. role preset carry-over).

max 100 Zeichenread-onlynullable
iconstringoptional
max 50 Zeichennullable
colorstringoptional
max 20 Zeichennullable

Standard-Endpoints

Diese Resource folgt dem generischen CRUD-Vertrag der Plattform. Lesen Sie die Konventionen für Pagination, Idempotenz, Optimistic Locking und Audit. Die wichtigsten Endpoints:

  • GET /api/v1/dashboard_templates — Liste, paginiert + filterbar
  • GET /api/v1/dashboard_templates/<id> — Einzelne Entity
  • POST /api/v1/dashboard_templates — Anlegen
  • PATCH /api/v1/dashboard_templates/<id> — Teil-Update
  • DELETE /api/v1/dashboard_templates/<id> — Soft-Delete
  • GET /api/v1/dashboard_templates/<id>/timeline — Audit + Aktivitäten

Suche