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

KB Space Schema

Schema-ID
kb_space
Collection
kb_spaces
Permissions
  • Lesenkb_space_view
  • Anlegenkb_space_create
  • Ändernkb_space_edit
  • Löschenkb_space_delete

Felder

KB Space Schema

kb_spaces4 Permissions

Top-level container that groups KB articles into a navigable space.

namestringerforderlich

Display name (e.g. "Arbeitsanweisungen")

1–120 Zeichen
slugstringoptional

URL slug (auto-generated from name if missing)

max 120 Zeichennullable
descriptionstringoptional

Short description shown on the space tile

max 1000 Zeichennullable
iconstringoptional

Icon key from the shared Icons set (e.g. "BookOpen")

max 60 Zeichennullable
colorstringoptional

Tile accent color in #RRGGBB

Patternnullable
sortOrderintegeroptional

Display order on the spaces grid

≥ 0Default: 0nullable
isDefaultbooleanoptional

Marks the catch-all space that hosts orphan articles

Default: falseread-onlynullable

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

Suche