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

Dashboard Custom Widget

Schema-ID
dashboard_widget_custom
Collection
dashboard_widget_custom
Permissions
  • Lesendashboard_widget_custom_view
  • Anlegendashboard_widget_custom_create
  • Änderndashboard_widget_custom_edit
  • Löschendashboard_widget_custom_delete

Felder

Dashboard Custom Widget

dashboard_widget_custom4 Permissions

Persisted user-defined dashboard widget. Sharing/publishing follows the dashboard_template model (ADR 0043a).

titlestringerforderlich
1–100 Zeichen
descriptionstringoptional
max 500 Zeichennullable
iconstringoptional
max 50 Zeichennullable
definitionobjecterforderlich

Structured builder definition that the server compiles into a whitelisted MongoDB aggregation pipeline. Never accept raw pipelines from clients.

entitystringerforderlich
Pattern
filtersobject[]erforderlich
max 30 Items
fieldstringerforderlich
max 100 ZeichenPattern
operatorstringerforderlich
Werte
eqnegtgteltlteinnincontainsexistsbetween
valueanyOferforderlich
filterVariantsobject[]optional
max 10 Itemsnullable
idstringerforderlich
Pattern
labelstringerforderlich
1–60 Zeichen
filtersobject[]erforderlich
max 30 Items
fieldstringerforderlich
max 100 ZeichenPattern
operatorstringerforderlich
Werte
eqnegtgteltlteinnincontainsexistsbetween
valueanyOferforderlich
groupByobject[]erforderlich
max 2 Items
fieldstringerforderlich
max 100 ZeichenPattern
bucketstringoptional
Werte
dayweekmonthquarteryear
nullable
limitintegeroptional
1 – 1000nullable
sortstringoptional
Werte
ascdescvalueAscvalueDesc
nullable
labelstringoptional
max 100 Zeichennullable
aggregationsobject[]erforderlich
1–10 Items
opstringerforderlich
Werte
countsumavgminmaxcountDistinct
fieldstringoptional
max 100 ZeichenPatternnullable
labelstringoptional
max 100 Zeichennullable
filterobject[]optional
max 10 Itemsnullable
fieldstringerforderlich
max 100 ZeichenPattern
operatorstringerforderlich
Werte
eqnegtgteltlteinnincontainsexistsbetween
valueanyOferforderlich
sortobjectoptional
nullable
bystringerforderlich
Werte
dimensionmeasure
indexintegeroptional
0 – 20nullable
dirstringerforderlich
Werte
ascdesc
limitintegeroptional
1 – 10000nullable
timeCompareobjectoptional
nullable
enabledbooleanerforderlich
dateFieldstringoptional
max 100 ZeichenPatternnullable
presetstringerforderlich
Werte
wtd_vs_prev_weekmtd_vs_prev_monthytd_vs_prev_yearlast_7d_vs_prior_7dlast_30d_vs_prior_30d
drillDownobjectoptional
nullable
targetSchemastringerforderlich
Pattern
fieldMappingobjecterforderlich
staticFiltersobject[]optional
max 20 Itemsnullable
fieldstringerforderlich
max 100 ZeichenPattern
operatorstringerforderlich
Werte
eqnegtgteltlteinnincontainsexistsbetween
valueanyOferforderlich
visualizationobjecterforderlich
kindstringerforderlich
Werte
kpitablelistbarhorizontal_barstacked_barlineareapiedoughnutgaugeheatmapfunneltreemap
unitstringoptional
max 20 Zeichennullable
currencystringoptional
max 10 Zeichennullable
precisionintegeroptional
0 – 6nullable
showTrendbooleanoptional
nullable
stackedbooleanoptional
nullable
showLegendbooleanoptional
nullable
showDataLabelsbooleanoptional
nullable
colorSchemestringoptional
Werte
brandtableau10d3cat10okabeItoviridisbluesorangesrdYlGnsemanticpastel
nullable
thresholdsobjectoptional
nullable
greennumberoptional
nullable
yellownumberoptional
nullable
rednumberoptional
nullable
tableColumnsstring[]optional
max 30 Itemsnullable
columnLabelsobjectoptional
nullable
scopestringerforderlich
Werte
usertenant
isSharedbooleanoptional
Default: false
userIduuidoptional
nullable
sharedWithUserIdsuuid[]optional
max 200 Itemsnullable
teamIdsuuid[]optional
max 100 Itemsnullable

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_widget_custom — Liste, paginiert + filterbar
  • GET /api/v1/dashboard_widget_custom/<id> — Einzelne Entity
  • POST /api/v1/dashboard_widget_custom — Anlegen
  • PATCH /api/v1/dashboard_widget_custom/<id> — Teil-Update
  • DELETE /api/v1/dashboard_widget_custom/<id> — Soft-Delete
  • GET /api/v1/dashboard_widget_custom/<id>/timeline — Audit + Aktivitäten

Suche