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

KB Share Schema

Schema-ID
kb_share
Collection
kb_shares
Permissions
  • Lesenkb_share_view
  • Anlegenkb_share_create
  • Ändernkb_share_edit
  • Löschenkb_share_delete

Felder

KB Share Schema

kb_shares4 Permissions

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

articleIduuiderforderlich

Reference to a kb_article (root or sub-article)

recipientTypestringerforderlich

Type of recipient this article is shared with

Werte
USERTEAMROLETENANT
recipientIduuiderforderlich

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

permissionsobjectoptional

Granular permissions granted by this share

canViewbooleanoptional

Can view the article (and its children if appliesToSubtree)

Default: true
canCreatebooleanoptional

Can create child articles

Default: false
canUpdatebooleanoptional

Can update the article (and its children if appliesToSubtree)

Default: false
canDeletebooleanoptional

Can delete the article (and its children if appliesToSubtree)

Default: false
canSharebooleanoptional

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

Default: false
canCommentbooleanoptional

Can add comments to the article

Default: false
canExportbooleanoptional

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

Default: false
canDownloadbooleanoptional

Can download attachments of the article

Default: false
canPrintbooleanoptional

Can print the article

Default: false
appliesToSubtreebooleanoptional

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

Default: true
validUntildatetimeoptional

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

Default: nullnullable
createdByuuidoptional

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

read-only
updatedBystringoptional

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

Patternread-onlynullable
isActivebooleanoptional

Soft toggle to temporarily disable sharing without deleting

Default: true

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

Suche