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

Announcement Schema

Schema-ID
announcement
Collection
announcements
Permissions
  • Lesenannouncement_view
  • Anlegenannouncement_create
  • Ändernannouncement_edit
  • Löschenannouncement_delete

Felder

Announcement Schema

announcements4 Permissions

Schema for tenant-wide announcements with banner display and read confirmations

titlestringerforderlich

Announcement title

1–300 Zeichen
contentstringoptional

Rich-text body (HTML from Tiptap)

max 50000 Zeichen
statusstringerforderlich

Publication status

Werte
DRAFTPUBLISHEDARCHIVED
prioritystringoptional

Announcement priority

Werte
LOWNORMALHIGHCRITICAL
showAsBannerbooleanoptional

Whether to display as a top-of-page banner bar

bannerTextstringoptional

Short one-line text shown in the banner bar

max 200 Zeichen
bannerColorstringoptional

Custom banner background color (hex)

max 20 Zeichennullable
publishedAtdatetimeoptional

When the announcement was published

nullable
expiresAtdatetimeoptional

When the announcement expires (banner auto-hides)

nullable
requiresConfirmationbooleanoptional

Whether users must explicitly confirm they have read it

authorIdstringoptional

User ID of the announcement author

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

Suche