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

KB Article Schema

Schema-ID
kb_article
Collection
kb_articles
Permissions
  • Lesenkb_article_view
  • Anlegenkb_article_create
  • Ändernkb_article_edit
  • Löschenkb_article_delete

Felder

KB Article Schema

kb_articles4 Permissions

Knowledge base article

articleNumberstringoptional

Human-readable article number (server-generated, e.g. K-2026-00042)

read-onlynullable
titlestringerforderlich

Article title

1–500 Zeichen
slugstringoptional

URL-friendly slug (auto-generated from title if missing)

max 500 Zeichennullable
contentstringoptional

Article body (plain text or Markdown depending on bodyFormat)

Default: ""nullable
contentHtmlstringoptional

Rich-text HTML body (sanitized server-side)

nullable
bodyFormatstringoptional

Content format used for rendering

MARKDOWNHTMLBLOCKS
nullable
categorystringoptional

Category label (free-text)

Default: "Allgemein"nullable
categoryIdstringoptional

Optional structured category UUID

nullable
statusstringoptional

Workflow status

DRAFTREVIEWPUBLISHEDARCHIVED
Default: "DRAFT"
isPublishedbooleanoptional

Publication flag (mirrors status === PUBLISHED)

Default: falsenullable
viewCountintegeroptional

Number of times the article has been viewed

≥ 0Default: 0nullable
authorIduuidoptional

Primary author user UUID (protected — assigned server-side)

read-onlynullable
successorAuthorIduuidoptional

Designated successor when the current author is offboarded

Default: nullnullable
isPortalVisiblebooleanoptional

Visible in the customer portal

Default: falsenullable
visibleToPartyIdsuuid[]optional

When non-empty, restricts portal visibility to these parties

Default: []nullable
tagsstring[]optional

Free-text tags

Default: []nullable
attachmentsobject[]optional
Default: []nullable
s3Keystringerforderlich
fileNamestringerforderlich
mimeTypestringerforderlich
sizeBytesnumbererforderlich
≥ 0
uploadedAtdatetimeerforderlich
uploadedByuuiderforderlich
isInternalbooleanoptional
nullable
linkedEntitiesobject[]optional
Default: []nullable
entityTypestringerforderlich
partyassetticketcontractprojectuseropportunitykb_article
entityIduuiderforderlich
rolestringerforderlich
embeddingStatusstringoptional
PENDINGPROCESSINGDONEFAILED
nullable
lastEmbeddedAtdatetimeoptional
nullable
spaceIduuidoptional

Owning kb_space UUID. Articles without a space appear in the default space.

Default: nullnullable
parentIduuidoptional

Parent article UUID for hierarchy

Default: nullnullable
sortOrderintegeroptional

Sort order among siblings under parentId

≥ 0Default: 0nullable
pathstring[]optional

Materialized ancestor path (denormalized)

nullable
rootArticleIduuidoptional

Denormalized root article UUID for share-based visibility

nullable
isTemplatebooleanoptional

If true, this article acts as a template/blueprint

Default: falsenullable
templateNamestringoptional
max 200 Zeichennullable
templateDescriptionstringoptional
max 2000 Zeichennullable
iconstringoptional

Emoji grapheme (e.g. "🚀") OR an Icons key from the shared set (e.g. "Server"). Rendered as an icon when the value matches an Icons key, otherwise as text.

max 60 Zeichennullable
iconColorstringoptional

Optional accent color for the article icon (hex, e.g. "#3b82f6")

Patternnullable
nextReviewDatedatetimeoptional

Scheduled date for the next content review

Default: nullnullable
lastReviewedAtdatetimeoptional

Timestamp of the last completed review

Default: nullnullable

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

Suche