Module

Wissensdatenbank

Die Wissensdatenbank verwaltet interne und kundenfokussierte Artikel mit Versionierung, Kommentaren, Feedback und Runbook-Executions. Artikel können auf Wunsch an Customer-Tenants geteilt werden (kb_shares).

Resources

Resource	Pfad	Permission-Präfix	Sequenz
Artikel	`/api/v1/kb_articles`	`kb_article`	`KB-`
Kommentare	`/api/v1/kb_comments`	`kb_comment`	—
Feedback	`/api/v1/kb_feedback`	`kb_feedback`	—
Runbook-Executions	`/api/v1/kb_executions`	`kb_execution`	—
Cross-Tenant-Shares	`/api/v1/kb_shares`	`kb_share`	—

Standard-CRUD nach den Konventionen. Lese-Statistiken, Kategorien und Tags liegen als typisierte Felder direkt am kb_article-Datensatz.

Schemas

Article

kb_articles4 Permissions

Knowledge base article

articleNumber string optional

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

read-onlynullable

title string erforderlich

Article title

1–500 Zeichen

slug string optional

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

max 500 Zeichennullable

content string optional

Article body (plain text or Markdown depending on bodyFormat)

Default: ""nullable

contentHtml string optional

Rich-text HTML body (sanitized server-side)

nullable

bodyFormat string optional

Content format used for rendering

Werte

MARKDOWNHTMLBLOCKS

nullable

category string optional

Category label (free-text)

Default: "Allgemein"nullable

categoryId string optional

Optional structured category UUID

nullable

status string optional

Workflow status

Werte

DRAFTREVIEWPUBLISHEDARCHIVED

Default: "DRAFT"

isPublished boolean optional

Publication flag (mirrors status === PUBLISHED)

Default: falsenullable

viewCount integer optional

Number of times the article has been viewed

≥ 0Default: 0nullable

authorId uuid optional

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

read-onlynullable

successorAuthorId uuid optional

Designated successor when the current author is offboarded

Default: nullnullable

isPortalVisible boolean optional

Visible in the customer portal

Default: falsenullable

visibleToPartyIds uuid[] optional

When non-empty, restricts portal visibility to these parties

Default: []nullable

tags string[] optional

Free-text tags

Default: []nullable

attachments object[] optional

Default: []nullable

s3Key string erforderlich

fileName string erforderlich

mimeType string erforderlich

sizeBytes number erforderlich

≥ 0

uploadedAt datetime erforderlich

uploadedBy uuid erforderlich

isInternal boolean optional

nullable

linkedEntities object[] optional

Default: []nullable

entityType string erforderlich

Werte

partyassetticketcontractprojectuseropportunitykb_article

entityId uuid erforderlich

role string erforderlich

embeddingStatus string optional

Werte

PENDINGPROCESSINGDONEFAILED

nullable

lastEmbeddedAt datetime optional

nullable

spaceId uuid optional

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

Default: nullnullable

parentId uuid optional

Parent article UUID for hierarchy

Default: nullnullable

sortOrder integer optional

Sort order among siblings under parentId

≥ 0Default: 0nullable

path string[] optional

Materialized ancestor path (denormalized)

nullable

rootArticleId uuid optional

Denormalized root article UUID for share-based visibility

nullable

isTemplate boolean optional

If true, this article acts as a template/blueprint

Default: falsenullable

templateName string optional

max 200 Zeichennullable

templateDescription string optional

max 2000 Zeichennullable

nextReviewDate datetime optional

Scheduled date for the next content review

Default: nullnullable

lastReviewedAt datetime optional

Timestamp of the last completed review

Default: nullnullable

Comment

kb_comments4 Permissions

Threaded comment on a knowledge base article

articleId uuid erforderlich

Reference to the kb_article

parentCommentId string optional

Parent comment ID for threaded replies (null = root comment)

PatternDefault: nullnullable

body string erforderlich

Comment text (may contain @mentions as @[userId])

1–5000 Zeichen

mentions uuid[] optional

User IDs mentioned in this comment

Default: []

isResolved boolean optional

Whether this comment thread is resolved

Default: false

resolvedBy string optional

User who resolved this thread

PatternDefault: nullnullable

resolvedAt datetime optional

Default: nullnullable

Feedback

kb_feedback4 Permissions

User feedback (rating) on a knowledge base article

articleId uuid erforderlich

Reference to the rated kb_article

rating string erforderlich

Thumbs-up or thumbs-down rating

Werte

UPDOWN

feedbackText string optional

Optional free-text feedback from the user

max 1000 ZeichenDefault: ""

Execution

kb_executions4 Permissions

Execution record for a knowledge base runbook/SOP article

articleId uuid erforderlich

Reference to the source kb_article (runbook/SOP)

ticketId string optional

Optional reference to the ticket this execution is for

PatternDefault: nullnullable

status string erforderlich

Execution status

Werte

IN_PROGRESSCOMPLETEDABANDONED

Default: "IN_PROGRESS"

steps object[] erforderlich

Ordered list of checklist steps extracted from the article

stepIndex integer erforderlich

≥ 0

label string erforderlich

max 500 Zeichen

isComplete boolean erforderlich

Default: false

completedAt datetime optional

Default: nullnullable

completedBy string optional

PatternDefault: nullnullable

startedAt datetime optional

When execution was started

completedAt datetime optional

When execution was completed or abandoned

Default: nullnullable

startedBy uuid optional

User who started the execution

kb_shares4 Permissions

Knowledge base article share configuration (user, team, role, or tenant)

articleId uuid erforderlich

Reference to a kb_article (root or sub-article)

recipientType string erforderlich

Type of recipient this article is shared with

Werte

USERTEAMROLETENANT

recipientId uuid erforderlich

ID of the recipient (userId, orgUnitId, roleId, or tenantId)

permissions object optional

Granular permissions granted by this share

canView boolean optional

Can view the article (and its children if appliesToSubtree)

Default: true

canCreate boolean optional

Can create child articles

Default: false

canUpdate boolean optional

Can update the article (and its children if appliesToSubtree)

Default: false

canDelete boolean optional

Can delete the article (and its children if appliesToSubtree)

Default: false

canShare boolean optional

Can re-share this article to additional recipients (capped by own permissions)

Default: false

canComment boolean optional

Can add comments to the article

Default: false

canExport boolean optional

Can export the article (e.g. PDF, Markdown)

Default: false

canDownload boolean optional

Can download attachments of the article

Default: false

canPrint boolean optional

Can print the article

Default: false

appliesToSubtree boolean optional

If true (default), the share recursively applies to all descendant articles. If false, it only applies to this exact article.

Default: true

validUntil datetime optional

Optional ISO date-time after which the share is no longer effective. Null = unlimited.

Default: nullnullable

createdBy uuid optional

User ID who created this share (set automatically by the API)

read-only

updatedBy string optional

User ID who last updated this share (set automatically by the API)

Patternread-onlynullable

isActive boolean optional

Soft toggle to temporarily disable sharing without deleting

Default: true

visibility: 'public' macht den Artikel über die Public-API erreichbar (sofern Branding-Domain konfiguriert).

Sonder-Permissions

Neben dem Standard-Set gibt es:

kb_article_publish — Status-Übergang von draft/review nach published.
kb_article_archive — Archivieren.

Wer nur kb_article_update hat, kann keinen Artikel publizieren — der Status-Wechsel scheitert mit 403.

Runbooks & Executions

Ein KB-Artikel kann als ausführbares Runbook markiert werden. Jeder Lauf hinterlässt eine kb_execution mit Eingaben, Ausgaben und Verantwortlichem — praktisch für wiederkehrende Standard-Prozeduren mit Audit-Bedarf.

MSPs können KB-Artikel über kb_shares an Customer-Tenants teilen. Der Customer-Tenant sieht den Artikel, kann ihn aber nicht editieren. Das ist die Basis für self-service-Wissens-Portale.

Verwandt

Konventionen
DMS — DMS hält Datei-Anhänge
LMS — Kurse können auf KB-Artikel verweisen
Public Endpoints — public-visible Artikel über Public-Scope