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

Announcement Template Schema

Schema-ID
announcement_template
Collection
announcement_templates
Permissions
  • Lesenannouncement_template_view
  • Anlegenannouncement_template_create
  • Ändernannouncement_template_edit
  • Löschenannouncement_template_delete

Felder

Announcement Template Schema

announcement_templates4 Permissions

Reusable blueprint for creating announcements

namestringerforderlich

Template name shown in the picker (e.g. "Neuer Mitarbeiter")

1–200 Zeichen
descriptionstringoptional

Optional hint about when to use this template

max 500 Zeichen
statusstringerforderlich

Archived templates stay available for reference but are hidden from the picker

Werte
ACTIVEARCHIVED
titlestringoptional

Pre-filled announcement title. Supports the placeholders below.

max 300 Zeichen
contentstringoptional

Pre-filled rich-text body (HTML from Tiptap)

max 50000 Zeichen
prioritystringoptional

Pre-filled announcement priority

Werte
LOWNORMALHIGHCRITICAL
showAsBannerbooleanoptional

Pre-fills whether the announcement is shown as a banner bar

bannerTextstringoptional

Pre-filled one-line banner text

max 200 Zeichen
bannerColorstringoptional

Pre-filled banner background colour (hex)

max 20 Zeichennullable
requiresConfirmationbooleanoptional

Pre-fills whether readers must confirm they have read it

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

Suche