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

Lesson Schema

Schema-ID
lesson
Collection
lessons
Permissions
  • Lesenlesson_view
  • Anlegenlesson_create
  • Ändernlesson_edit
  • Löschenlesson_delete
Beziehungen

Felder

Lesson Schema

lessons4 Permissions

Schema for validating lesson entities in the Academy/LMS module

courseIdstringerforderlich

ID of the course this lesson belongs to

min 1 Zeichen
titlestringerforderlich

Lesson title

1–200 Zeichen
contentstringerforderlich

Lesson content in markdown format

min 1 Zeichen
ordernumbererforderlich

Order of lesson in the course

≥ 1
durationnumbererforderlich

Lesson duration in minutes

≥ 1
videoUrlurioptional

URL of lesson video

nullable
typestringoptional

Type of lesson content

Werte
videotextquizinteractive
nullable
isPreviewbooleanoptional

Whether lesson can be accessed without enrollment

nullable
resourcesobject[]optional

Additional resources for the lesson

nullable
namestringerforderlich
min 1 Zeichen
typestringerforderlich
Werte
pdflinkdownload
urlurierforderlich
sizenumberoptional
≥ 0nullable
unitCountnumberoptional

Cached count of learning units in this section

≥ 0nullable
completionModestringoptional

Whether units must be completed in order (sequential) or freely

Werte
sequentialfree
nullable
isLockedbooleanoptional

Whether this section is locked until the previous section is completed

nullable
requiredModulestringoptional

Module ID required to view this lesson (for onboarding filtering)

nullable

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

Suche