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

Entity View Schema

Schema-ID
entity_view
Collection
entity_views
Permissions
  • Lesenentity_view_view
  • Anlegenentity_view_create
  • Ändernentity_view_edit
  • Löschenentity_view_delete

Felder

Entity View Schema

entity_views4 Permissions

Per-tenant view configuration for an entity schema (list + detail page, optional sidebar entry, search visibility). Pairs with a custom schema defined in schema_definitions, but can also decorate built-in schemas.

schemaIdstringerforderlich

Schema / entity id this view renders (e.g. "ticket" or a custom schema id).

1–100 ZeichenPatternread-only
slugstringerforderlich

URL-safe slug used in the route /custom/:slug. Unique per tenant.

1–60 ZeichenPatternread-only
labelDestringerforderlich

German display label (default language).

1–120 Zeichen
labelEnstringoptional

English display label (falls back to labelDe when unset).

max 120 Zeichennullable
iconstringoptional

Name of an icon from the shared Icons component.

max 60 Zeichennullable
sidebarobjectoptional

Sidebar-entry configuration for this view.

enabledbooleanoptional

Whether a sidebar entry is rendered for this view.

sectionstringoptional

Optional sidebar section label. When unset the entry is placed in a default "Eigene" section.

max 80 Zeichennullable
listobjectoptional

List view configuration (columns, default sort, quick filters).

columnsobject[]optional

Ordered list of columns shown in the grid.

fieldstringerforderlich

Field name on the entity (dot-notation allowed).

1–120 Zeichen
labelstringoptional

Column header override. Falls back to the field title.

max 120 Zeichennullable
widthintegeroptional

Preferred column width in pixels.

40 – 800nullable
defaultSortobjectoptional
nullable
fieldstringoptional
1–120 Zeichen
orderstringoptional
Werte
ascdesc
detailobjectoptional

Detail view configuration (sections with ordered fields).

sectionsobject[]optional

Detail-page sections. A section may render a heading + ordered fields.

labelstringoptional

Optional section heading.

max 120 Zeichennullable
fieldsstring[]erforderlich

Ordered field names shown in this section.

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

Suche