Time Machine (Vorschau)

Time Machine ist eine KI-gestützte Lernplattform für Unternehmen. Es wandelt Unternehmensdokumente, Videos und Expertenwissen in strukturierte Kurse mit Modulen, Themen, Quizfragen und Rollenspielübungen um und verfolgt den Lernfortschritt. Entwickelt für Personal- und L&D-Teams, die Mitarbeiter im großen Maßstab integrieren, trainieren und zertifizieren. Der Connector automatisiert den vollständigen Lernlebenszyklus: Verwalten von Kursen, Benutzern, Abteilungen und Rollen; Generieren von Quizfragen aus Dokumenten; und Analyse des Abschlusses lesen.

Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:

Service	Class	Regions
Copilot Studio	Premium	Alle Power Automate Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD)
Logik-Apps	Standard	Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche: - Azure Government Regionen - Azure China-Regionen - US Department of Defense (DoD)
Power Apps	Premium	Alle Power Apps Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD)
Power Automate	Premium	Alle Power Automate Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD)

Kontakt
Name	Time Machine Support
URL	https://timeml.ai

Connectormetadaten
Herausgeber	Time Machine AI
Website	https://timeml.ai
Datenschutzrichtlinie	https://timeml.ai/privacy-policy
Kategorien	Produktivität; KI

Time Machine – Power Automate Verbinder

Was ist Time Machine?

Time Machine ist eine KI-gestützte Lernplattform für Unternehmen, die Unternehmen dabei unterstützt, adaptive Lernsysteme für moderne Teams zu erstellen, zu betreiben und kontinuierlich zu verbessern. Organisationen verwenden Time Machine, um vorhandene Kenntnisse, Dokumente, Aufzeichnungen und Workflows in skalierbare Schulungserfahrungen zu transformieren, die das Onboarding beschleunigen, die Mitarbeiterbereitschaft verbessern und top-performer Know-how in der gesamten Organisation replizieren.

Mandantenadministratoren verwalten Benutzer, Lerninhalte, Organisationsressourcen und Plattformkonfiguration über die TIME Machine REST-API. Dieser Connector macht die öffentliche REST-API als Power Automate Aktionen verfügbar, sodass Sie die Benutzerbereitstellung, Inhaltsaufnahme, Wissenssynchronisierung und Lebenszyklusverwaltung automatisieren können, ohne Code zu schreiben.

Voraussetzungen

Ein aktiver Time Machine-Mandant mit Administratorzugriff
Ein Time Machine-API-Schlüssel, der aus den Einstellungen → API-Schlüsseln im Administratorbereich (https://web.timeml.ai) ausgegeben wurde. Der Schlüssel ist ein Wert, der mit tm_live_.

Authentifizierung

Jede Aktion authentifiziert sich mit einem API-Schlüssel im Authorization Header. Beim Erstellen einer Verbindung in Power Automate:

Feld: API key
Wert: Einfügen Bearer tm_live_<your-token> (die vollständige Zeichenfolge, einschließlich des Bearer Präfixes und eines Leerzeichens vor dem Token)

Verfügbare Aktionen

Der Connector spiegelt die öffentliche REST-API des Time Machine (116 Endpunkte) wieder. Aktionen werden nach Ressource gruppiert:

Kurse – Listen / Erstellen / Aktualisieren / Löschen / Veröffentlichen von Kursen, Zuweisen von Rollen, Generieren von KI-verfassten Inhalten
Benutzer — Liste / Erstellen / Aktualisieren / Deaktivieren / Reaktivieren von Benutzern
Dokumente – Liste / Hochladen / Aktualisieren / Löschen von Dokumenten
Medien – Liste / Hochladen / Aktualisieren / Löschen von Medienelementen
Abteilungen – Abteilungen auflisten/ erstellen/ aktualisieren / löschen, Rollen verwalten, Benutzer Rollen zuweisen
Experten – Listen / Erstellen von Expertenprofilen, Stellen von Expertenfragen, Zuweisen von Dokumenten und Rollen
Demo-Schulungen - Liste / Erstellen / Aktualisieren / Löschen Demo-Schulungen
Kursinhalte – Module, Themen, Lektionen, Übungen, Quizfragen
Insights – pro Student, pro Kurs und Analysen auf Unternehmensebene
Zertifikate – Schülerzertifikate auflisten, ZERTIFIKAT-PDF herunterladen

Vollständige Endpunktreferenz ist verfügbar unter https://api.timeml.ai/api/v1/docs.

Beispielworkflows

Confluence release → Time Machine: Wenn eine Releaseseite in Confluence veröffentlicht wird, laden Sie sie als Dokument in Time Machine hoch, damit sie in die Lernbytebibliothek fließt.
HR Onboarding: Wenn eine neue Mitarbeiterzeile in Ihrem HRIS angezeigt wird, erstellen Sie einen Time Machine-Benutzer mit ihrer Abteilung und Rollenzuweisungen, wodurch die Einladung zu magic-link ausgelöst wird.
Benachrichtigungen zum Abschluss des Kurses: Wenn ein Kursteilnehmer einen Kurs abgeschlossen hat, senden Sie eine PDF-Datei des Zertifikats an Slack, und protokollieren Sie den Abschluss bei einem Google Sheet.

Bekannte Einschränkungen

API-Schlüsseldrehung: Verbindungen müssen manuell aktualisiert werden, wenn der API-Schlüssel gedreht wird. Es gibt keinen Mechanismus für die automatische Aktualisierung.
Mehrteilige Uploads: Dateiuploadaktionen (Dokument hochladen, Medien hochladen) akzeptieren Dateien bis zu 50 MB. Für größere Medien teilen Sie sich in mehrere Uploads auf, oder wenden Sie sich an den Time Machine-Support.
Batchvorgänge: Die API wird jeweils auf einem Datensatz ausgeführt. Verwenden Sie für Massenaktionen die integrierten Power Automate für jedes Steuerelement.

Support

Bei Fragen oder Problemen mit dem Connector wenden Sie sich an Ihr Time Machine-Kontoteam oder den E-Mail-Support unter support@timeml.ai.

Eine Verbindung wird erstellt

Der Connector unterstützt die folgenden Authentifizierungstypen:


Vorgabe	Parameter zum Erstellen einer Verbindung.	Alle Regionen	Nicht teilbar

Vorgabe

Anwendbar: Alle Regionen

Parameter zum Erstellen einer Verbindung.

Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.

Name	Typ	Description	Erforderlich
Time Machine API-Schlüssel (Format: Bearer tm_live_...)	securestring	Der Time Machine-API-Schlüssel (Format: Bearer tm_live_...) für diese API	True

Aktionen

Abrufen des STATUS der KI-Generation für einen Kurs	Gibt die Liste der aktiven KI-Generierungsanforderungen für den Kurs mit Fortschritts- und Zielinformationen zurück.
Abrufen einer Demoschulung	Gibt die vollständige Demoschulung mit Segmenten zurück.
Abrufen einer Kursversionsmomentaufnahme	Gibt die vollständige Inhaltsstruktur (Module, Themen, Lektionen, Übungen, Fragen) für die angegebene Version zurück.
Abrufen einer Lektion	Gibt Unterrichtsinhalte, Medien- und Unterrichtsfragen zurück.
Abrufen einer Quizfrage in einem Modul	Gibt eine einzelne Quizfrage zurück, die dem angegebenen Modul zugeordnet ist.
Abrufen einer Quizfrage zu einem Thema	Gibt eine einzelne Quizfrage zurück, die dem angegebenen Thema zugeordnet ist.
Abrufen einer Übung	Gibt Übungsdetails für die angegebene ID zurück.
Abrufen eines Benutzers	Gibt Benutzermetadaten und Abteilungs-/Rollenzuweisungen zurück.
Abrufen eines Dokuments	Gibt Dokumentmetadaten und eine kurzlebige signierte Download-URL zurück.
Abrufen eines Lernbytes	Gibt Metadaten und geschachtelte Lektionen zurück.
Abrufen eines Medienelements	Gibt Medienmetadaten und eine kurzlebige signierte Download-URL zurück.
Abrufen eines Modulintros	Gibt den Einführungstext zurück, der für das angegebene Modul festgelegt ist.
Abrufen eines Moduls	Gibt Moduldetails für die angegebene ID zurück.
Abrufen eines Themaintros	Gibt den Einführungstext zurück, der für das angegebene Thema festgelegt ist.
Abrufen eines Themas	Gibt Die Themendetails für die angegebene ID zurück.
Abteilungen auflisten	Alle Abteilungen im Unternehmen des Anrufers mit geschachtelten Rollen
Aktivitätsereignisse pro Schüler/Studenten	Datenstrom für paginiertes vorwärtsgeschütztes Ereignis
Aktualisieren einer Abteilung	Aktualisieren des Namens und/oder der Beschreibung
Aktualisieren einer Demoschulung	Teilweise Aktualisierung. Übergeben Sie nur die Felder, die Sie ändern möchten. assignedRoleIds ersetzt den aktuellen Satz.
Aktualisieren einer In-Lektionsfrage	Geben Sie Felder an, die dem gespeicherten Typ entsprechen; Nicht verknüpfte Felder werden ignoriert.
Aktualisieren einer Quizfrage in einem Modul	Geben Sie Felder an, die dem gespeicherten Typ entsprechen; Nicht verknüpfte Felder werden ignoriert.
Aktualisieren einer Quizfrage zu einem Thema	Geben Sie Felder an, die dem gespeicherten Typ entsprechen; Nicht verknüpfte Felder werden ignoriert.
Aktualisieren einer Übung	Typfähig: ILE_TEXT verwendet nur prompt + generatedContent.scenario; RPE_* verwendet alle RPE-Felder. Ausgelassene Felder behalten die aktuellen Werte bei.
Aktualisieren eines Benutzers	Aktualisieren Sie "firstName", "lastName", "isAdmin" und Rollenzuweisungen. E-Mails können in v1 nicht bearbeitet werden.
Aktualisieren von Dokumentmetadaten	Aktualisieren des Namens und/oder der Beschreibung
Aktualisieren von Kursmetadaten	Kursname aktualisieren
Aktualisieren von Lernbytemetadaten	Ausgelassene Felder behalten die aktuellen Werte bei
Aktualisieren von Medienmetadaten	Aktualisieren des Namens und/oder der Beschreibung
Aktualisieren von Modulmetadaten	Aktualisiert den Namen und/oder die Beschreibung. Ausgelassene Felder behalten die aktuellen Werte bei
Aktualisieren von Themenmetadaten	Aktualisiert den Namen und/oder die Beschreibung. Ausgelassene Felder behalten die aktuellen Werte bei
Aktualisieren von Unterrichtsinhalten	Ausgelassener Inhalt behält den aktuellen Wert bei
Aufheben der Verknüpfung eines Dokuments aus einem Thema	Idempotent
Aufheben der Zuweisung eines Benutzers aus einer Rolle	Idempotent — 204, auch wenn nicht zugewiesen wurde
Aufheben der Zuweisung eines Dokuments von einem Experten	Idempotent
Auflisten der Zertifikate eines Kursteilnehmers	Gibt Zertifikate zurück, die von dem angegebenen Kursteilnehmer innerhalb des Unternehmens des Anrufers erzielt wurden.
Auflisten von Kursen	Paginierte Liste der Kurse im Unternehmen des Anrufers
Auflisten von Lektionen in einem Lernbyte	Gibt Lektionen zurück, die zum gegebenen Lernbyte gehören.
Auflisten von Lernbytes in einem Thema	Gibt Lernbytes zurück, die zum jeweiligen Thema gehören.
Auflisten von Modulen in einem Kurs	Gibt aktive Module zurück, die nach OrdinalNumber sortiert sind.
Auflisten von Quizfragen zu einem Modul	Gibt Quizfragen zurück, die dem angegebenen Modul zugeordnet sind.
Auflisten von Quizfragen zu einem Thema	Gibt Quizfragen zurück, die dem jeweiligen Thema zugeordnet sind.
Auflisten von Themen in einem Modul	Gibt aktive Themen zurück, die nach OrdinalNumber sortiert sind.
Auflisten von Übungen in einem Thema	Gemischte Typen (ILE_TEXT / RPE_VOICE / RPE_VIDEO) sortiert nach OrdinalNumber
Auslösen der KI-Inhaltsgenerierung für Themen	Enqueues AI Content Generation für die angegebenen Themen im Kurs
Benutzer auflisten	Paginierte Liste der Benutzer im Unternehmen des Anrufers
Deaktivieren eines Benutzers	Idempotent – gibt den Benutzer zurück, auch wenn er bereits deaktiviert ist.
Demoschulungen auflisten	Paginierte Liste mit Bereich für das Unternehmen des Anrufers
Dokument-Binärdatei ersetzen	Ersetzt die Datei-Binärdatei eines vorhandenen Dokuments; Metadaten bleiben erhalten
Dokumente auflisten	Paginierte Liste der Dokumente im Unternehmen des Anrufers
Einblicke auf Unternehmensebene	Top-Line-KPIs für das Unternehmen des Anrufers
Einblicke pro Schüler/Studenten	Aggregierte Zusammenfassung und Aufschlüsselung pro Kurs für das angegebene Fenster
Eine In-Lektionsfrage abrufen	Gibt eine einzelne In-Lektionsfrage anhand ihrer ID zurück.
Entfernen aller Rollenzuweisungen aus einem Kurs	Idempotent
Entfernen aller Rollenzuweisungen von einem Experten	Idempotent
Entfernen einer Rollenzuweisung aus einem Kurs	Idempotent
Entfernen einer Rollenzuweisung von einem Experten	Idempotent
Entfernen eines Modulintros	Idempotent — 204, auch wenn keine Einführung festgelegt ist
Entfernen eines Themeneinführungsthemas	Idempotent — 204, auch wenn keine Einführung festgelegt ist
Erstellen einer Abteilung	Erstellt eine neue Abteilung im Unternehmen des Anrufers.
Erstellen einer Demoschulung	Erstellt eine Demoschulung aus einer zuvor hochgeladenen Videodatei und startet die Verarbeitung.
Erstellen einer Rolle innerhalb einer Abteilung	Erstellt eine neue Rolle, die auf die angegebene Abteilung eingestellt ist.
Erstellen eines Benutzers	Erstellt einen Benutzer und löst den Magic-Link-Einladungsfluss aus.
Erstellen eines leeren Kurses	Erstellt eine neue Kursshell mit dem angegebenen Namen.
Experten auflisten	Paginierte Liste der Experten im Unternehmen des Anrufers
Festlegen der Anzahl der Modul quiz für einen Fragetyp	Ersetzt die Anzahl für den angegebenen questionType (MULTIPLE_CHOICE oder OPEN_ENDED). Die Anzahl des anderen Typs wird beibehalten.
Festlegen der Anzahl der Themen quiz für einen Fragetyp	Ersetzt die Anzahl für den angegebenen questionType (MULTIPLE_CHOICE oder OPEN_ENDED). Die Anzahl des anderen Typs wird beibehalten.
Festlegen oder Ersetzen eines Modulintros	Upsert – erstellt, falls nicht vorhanden, ersetzt, wenn vorhanden
Festlegen oder Ersetzen eines Themaintros	Upsert – erstellt, falls nicht vorhanden, ersetzt, wenn vorhanden
Generieren eines bestimmten Elements über KI	Generiert eine einzelne Lektion, Unterrichtsfragen, Quiz, Einführung oder Übung
Generieren eines vollständigen Kurses mit KI-Inhalten	Erstellt die Kursshell, alle Module, alle Themen und Queues KI-Inhaltsgenerierung für jedes Thema
Hinzufügen einer ILE_TEXT Übung zu einem Thema	Erstellt eine neue ILE_TEXT Übung innerhalb des angegebenen Themas.
Hinzufügen einer In-Lektionsfrage	Typ muss MULTIPLE_CHOICE sein (erfordert Optionen) oder OPEN_ENDED
Hinzufügen einer Lektion zu einem Lernbyte	Erstellt eine neue Lektion innerhalb des angegebenen Lernbytes.
Hinzufügen einer Quizfrage zu einem Modul	Erstellt eine neue Quizfrage innerhalb des angegebenen Moduls.
Hinzufügen einer Quizfrage zu einem Thema	Erstellt eine neue Quizfrage innerhalb des angegebenen Themas.
Hinzufügen einer RPE_VIDEO Übung zu einem Thema	Erstellt eine neue RPE_VIDEO Rollenspielübung innerhalb des jeweiligen Themas.
Hinzufügen einer RPE_VOICE Übung zu einem Thema	Erstellt eine neue RPE_VOICE Rollenspielübung innerhalb des jeweiligen Themas.
Hinzufügen eines Lernbytes zu einem Thema	Erstellt ein neues Lernbyte innerhalb des jeweiligen Themas.
Hinzufügen eines Moduls zu einem Kurs	Erstellt ein neues Modul innerhalb des angegebenen Kurses.
Hinzufügen eines Themas zu einem Modul	Erstellt ein neues Thema innerhalb des angegebenen Moduls.
Hochladen eines Dokuments	Mehrteiliger Upload (Datei + optionale Beschreibung). Max. 50 MB.
Hochladen eines Medienelements	Mehrteiliger Upload (Datei + optionale Beschreibung). Max. 50 MB für Bilder, 500 MB für Videos.
Holen Sie sich einen Experten	Gibt Expertenmetadaten, verknüpfte Dokumente und zugewiesene Rollen/Abteilungen zurück.
In-Lektionsfragen auflisten	Gibt Wissensüberprüfungsfragen zurück, die der angegebenen Lektion zugeordnet sind.
Kurs abrufen	Gibt Kursmetadaten mit Modulzusammenfassungen und zugewiesenen Rollen/Abteilungen zurück.
Kursversionen auflisten	Gibt veröffentlichte Versionsmetadaten zurück (Anzahl + Veröffentlichungsinformationen), sortiert nach Versionsnummer
Löschen (Deaktivieren) einer Abteilung	Idempotent - gibt 204 zurück, auch wenn bereits deaktiviert. Kaskadiert an Rollenzuweisungen.
Löschen (Deaktivieren) eines Dokuments	Idempotent – gibt 204 zurück, auch wenn das Dokument bereits gelöscht oder fehlt.
Löschen (Deaktivieren) eines Medienelements	Idempotent – gibt 204 zurück, auch wenn das Element bereits gelöscht oder fehlt.
Löschen (weich) eines Kurses	Idempotent - gibt 204 zurück, auch wenn der Kurs bereits entfernt wurde
Löschen einer Demoschulung	Idempotent - gibt 204 zurück, auch wenn die Demo-Schulung nicht vorhanden ist oder bereits verschwunden ist
Löschen einer In-Lektionsfrage	Idempotent — 204, auch wenn bereits entfernt
Löschen einer Lektion (weich)	Idempotent — 204, auch wenn bereits entfernt
Löschen einer Quizfrage in einem Modul	Idempotent — 204, auch wenn bereits entfernt
Löschen einer Quizfrage zu einem Thema	Idempotent — 204, auch wenn bereits entfernt
Löschen einer Übung	Idempotent — 204, auch wenn bereits entfernt
Löschen eines Lernbytes (weich)	Idempotent — 204, auch wenn bereits entfernt
Löschen eines Moduls (vorläufig)	Idempotent – gibt 204 zurück, auch wenn das Modul bereits entfernt wurde.
Löschen eines Themas (vorläufig)	Idempotent – gibt 204 zurück, auch wenn das Thema bereits entfernt wurde.
Medien auflisten	Paginierte Liste der Medienelemente im Unternehmen des Anrufers
Medien-Binärdatei ersetzen	Ersetzt die Datei-Binärdatei eines vorhandenen Medienelements; Metadaten bleiben erhalten
Mit einem Thema verknüpfte Dokumente auflisten	Paginiert; optionale Suche nach Dokumentname
Neuanordnen von Fragen in Lektionen	"questionIds" muss jede aktive Frage für die Lektion in der neuen Reihenfolge enthalten.
Neuanordnen von Modulen in einem Kurs	moduleIds müssen jedes aktive Modul genau einmal enthalten, in der neuen Reihenfolge
Neuanordnen von Quizfragen in einem Modul	"questionIds" muss jede aktive Quizfrage für das Modul in der neuen Reihenfolge enthalten.
Neuanordnen von Quizfragen zu einem Thema	"questionIds" müssen jede aktive Quizfrage für das Thema in der neuen Reihenfolge enthalten.
Neuanordnen von Themen in einem Modul	topicIds müssen jedes aktive Thema genau einmal enthalten, in der neuen Reihenfolge
PDF-Datei zum Herunterladen eines Zertifikats	Streamt die PDF-Datei des Zertifikats. Gibt 404 zurück, wenn das Zertifikat noch keine PDF-Datei enthält.
Reaktivieren eines Benutzers	Idempotent – gibt den Benutzer zurück, auch wenn er bereits aktiv ist.
Stellen Sie einem Experten eine Frage	Synchroner Wrapper um den Ki-Streaming-Chat. Gibt die zusammengesetzte Antwort zurück.
Verfügbarkeit für Kursteilnehmer ein/aus	Legen Sie fest, ob die Demoschulung für Kursteilnehmer veröffentlicht wird. Idempotent.
Verknüpfen von Dokumenten mit einem Thema	Additive - bereits verknüpfte Dokumente werden übersprungen
Verschieben eines Themas in ein anderes Modul	targetOrdinalNumber ist optional; wenn das Thema nicht angegeben wird, wird an das Zielmodul angefügt.
Veröffentlichen eines Kurses	Veröffentlicht den Kurs; schlägt mit 400 fehl, wenn keine veröffentlichungsfähigen Inhalte vorhanden sind.
Videoverarbeitung erneut ausführen	Sendet das Video für die KI-Segmentierung erneut. Setzen Sie optional die Verarbeitungsaufforderung außer Kraft.
Zertifikatdetails	Gibt ein Zertifikat zurück, das für das Unternehmen des Anrufers gilt.
Zuweisen eines Benutzers zu einer Rolle	Idempotent
Zuweisen von Dokumenten zu einem Experten	Massenverknüpfung von Dokumenten mit dem Experten. Idempotent.
Zuweisen von Rollen zu einem Experten	Additive — bereits zugewiesene Rollen werden beibehalten; neue angefügte. Gibt aktualisierten Experten zurück.
Zuweisen von Rollen zu einem Kurs	Additive – Rollen, die bereits zugewiesen wurden, werden übersprungen. Gibt das aktualisierte Kursdetails zurück.

Abrufen des STATUS der KI-Generation für einen Kurs

Vorgangs-ID:: getCourseGenerationStatus

Gibt die Liste der aktiven KI-Generierungsanforderungen für den Kurs mit Fortschritts- und Zielinformationen zurück.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Id	id	True	uuid	Id

Gibt zurück

Body: GenerationStatusResponse

Abrufen einer Demoschulung

Vorgangs-ID:: getDemoTraining

Gibt die vollständige Demoschulung mit Segmenten zurück.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Id	id	True	uuid	Id

Gibt zurück

Body: DemoTrainingDto

Abrufen einer Kursversionsmomentaufnahme

Vorgangs-ID:: getCourseVersion

Gibt die vollständige Inhaltsstruktur (Module, Themen, Lektionen, Übungen, Fragen) für die angegebene Version zurück.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Kurs-ID	courseId	True	uuid	Kurs-ID
Versionsnummer	versionNumber	True	integer	Versionsnummer

Gibt zurück

Body: CourseVersionSnapshotDto

Abrufen einer Lektion

Vorgangs-ID:: getLesson

Gibt Unterrichtsinhalte, Medien- und Unterrichtsfragen zurück.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Lektions-ID	lessonId	True	uuid	Lektions-ID

Gibt zurück

Body: LessonDetailDto

Abrufen einer Quizfrage in einem Modul

Vorgangs-ID:: getModuleQuizQuestion

Gibt eine einzelne Quizfrage zurück, die dem angegebenen Modul zugeordnet ist.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Modul-ID	moduleId	True	uuid	Modul-ID
Frage-ID	questionId	True	uuid	Frage-ID

Gibt zurück

Body: QuestionDto

Abrufen einer Quizfrage zu einem Thema

Vorgangs-ID:: getTopicQuizQuestion

Gibt eine einzelne Quizfrage zurück, die dem angegebenen Thema zugeordnet ist.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Themen-ID	topicId	True	uuid	Themen-ID
Frage-ID	questionId	True	uuid	Frage-ID

Gibt zurück

Body: QuestionDto

Abrufen einer Übung

Vorgangs-ID:: getExercise

Gibt Übungsdetails für die angegebene ID zurück.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Id	id	True	uuid	Id

Gibt zurück

Body: ExerciseDto

Abrufen eines Benutzers

Vorgangs-ID:: getUser

Gibt Benutzermetadaten und Abteilungs-/Rollenzuweisungen zurück.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Id	id	True	uuid	Id

Gibt zurück

Body: UserDto

Abrufen eines Dokuments

Vorgangs-ID:: getDocument

Gibt Dokumentmetadaten und eine kurzlebige signierte Download-URL zurück.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Id	id	True	uuid	Id

Gibt zurück

Body: DocumentDetailDto

Abrufen eines Lernbytes

Vorgangs-ID:: getLearningByte

Gibt Metadaten und geschachtelte Lektionen zurück.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Lb-ID	lbId	True	uuid	Lb-ID

Gibt zurück

Body: LearningByteDetailDto

Abrufen eines Medienelements

Vorgangs-ID:: getMediaItem

Gibt Medienmetadaten und eine kurzlebige signierte Download-URL zurück.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Id	id	True	uuid	Id

Gibt zurück

Body: MediaDetailDto

Abrufen eines Modulintros

Vorgangs-ID:: getModuleIntro

Gibt den Einführungstext zurück, der für das angegebene Modul festgelegt ist.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Modul-ID	moduleId	True	uuid	Modul-ID

Gibt zurück

Body: IntroDto

Abrufen eines Moduls

Vorgangs-ID:: getModule

Gibt Moduldetails für die angegebene ID zurück.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Modul-ID	moduleId	True	uuid	Modul-ID

Gibt zurück

Body: ModuleDetailDto

Abrufen eines Themaintros

Vorgangs-ID:: getTopicIntro

Gibt den Einführungstext zurück, der für das angegebene Thema festgelegt ist.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Themen-ID	topicId	True	uuid	Themen-ID

Gibt zurück

Body: IntroDto

Abrufen eines Themas

Vorgangs-ID:: getTopic

Gibt Die Themendetails für die angegebene ID zurück.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Themen-ID	topicId	True	uuid	Themen-ID

Gibt zurück

Body: TopicDto

Abteilungen auflisten

Vorgangs-ID:: listDepartments

Alle Abteilungen im Unternehmen des Anrufers mit geschachtelten Rollen

Gibt zurück

Body: DepartmentListResponse

Aktivitätsereignisse pro Schüler/Studenten

Vorgangs-ID:: listStudentEvents

Datenstrom für paginiertes vorwärtsgeschütztes Ereignis

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Benutzer-ID	userId	True	uuid	Benutzer-ID
Seite	page		integer	Seite
Größe	size		integer	Größe

Gibt zurück

Body: EventListResponse

Aktualisieren einer Abteilung

Vorgangs-ID:: updateDepartment

Aktualisieren des Namens und/oder der Beschreibung

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Id	id	True	uuid	Id
Name	name		string
Beschreibung	description		string

Gibt zurück

Body: DepartmentDto

Aktualisieren einer Demoschulung

Vorgangs-ID:: updateDemoTraining

Teilweise Aktualisierung. Übergeben Sie nur die Felder, die Sie ändern möchten. assignedRoleIds ersetzt den aktuellen Satz.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Id	id	True	uuid	Id
Name	name		string
Beschreibung	description		string
trainingType	trainingType		string
departmentId	departmentId		uuid
assignedRoleIds	assignedRoleIds		array of uuid

Gibt zurück

Body: DemoTrainingDto

Aktualisieren einer In-Lektionsfrage

Vorgangs-ID:: updateLessonQuestion

Geben Sie Felder an, die dem gespeicherten Typ entsprechen; Nicht verknüpfte Felder werden ignoriert.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Lektions-ID	lessonId	True	uuid	Lektions-ID
Frage-ID	questionId	True	uuid	Frage-ID
Text	text		string
Text	text	True	string
isCorrect	isCorrect		boolean
expectedAnswer	expectedAnswer		string

Gibt zurück

Body: QuestionDto

Aktualisieren einer Quizfrage in einem Modul

Vorgangs-ID:: updateModuleQuizQuestion

Geben Sie Felder an, die dem gespeicherten Typ entsprechen; Nicht verknüpfte Felder werden ignoriert.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Modul-ID	moduleId	True	uuid	Modul-ID
Frage-ID	questionId	True	uuid	Frage-ID
Text	text		string
Text	text	True	string
isCorrect	isCorrect		boolean
expectedAnswer	expectedAnswer		string

Gibt zurück

Body: QuestionDto

Aktualisieren einer Quizfrage zu einem Thema

Vorgangs-ID:: updateTopicQuizQuestion

Geben Sie Felder an, die dem gespeicherten Typ entsprechen; Nicht verknüpfte Felder werden ignoriert.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Themen-ID	topicId	True	uuid	Themen-ID
Frage-ID	questionId	True	uuid	Frage-ID
Text	text		string
Text	text	True	string
isCorrect	isCorrect		boolean
expectedAnswer	expectedAnswer		string

Gibt zurück

Body: QuestionDto

Aktualisieren einer Übung

Vorgangs-ID:: updateExercise

Typfähig: ILE_TEXT verwendet nur prompt + generatedContent.scenario; RPE_* verwendet alle RPE-Felder. Ausgelassene Felder behalten die aktuellen Werte bei.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Id	id	True	uuid	Id
Eingabeaufforderung	prompt		string
avatarPictureId	avatarPictureId		uuid
avatarCharacteristics	avatarCharacteristics		string
reverseRolePlayEnabled	reverseRolePlayEnabled		boolean
reverseRolePlayMandatory	reverseRolePlayMandatory		boolean
Szenario	scenario		string
TraineeRole	traineeRole		string
avatarName	avatarName		string
avatarDescription	avatarDescription		string
operationalChallenge	operationalChallenge		string
successMetric	successMetric		string

Gibt zurück

Body: ExerciseDto

Aktualisieren eines Benutzers

Vorgangs-ID:: updateUser

Aktualisieren Sie "firstName", "lastName", "isAdmin" und Rollenzuweisungen. E-Mails können in v1 nicht bearbeitet werden.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Id	id	True	uuid	Id
firstName	firstName		string
lastName	lastName		string
isAdmin	isAdmin		boolean
departmentRoleIds	departmentRoleIds		array of uuid

Gibt zurück

Body: UserDto

Aktualisieren von Dokumentmetadaten

Vorgangs-ID:: updateDocumentMetadata

Aktualisieren des Namens und/oder der Beschreibung

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Id	id	True	uuid	Id
Name	name		string
Beschreibung	description		string

Gibt zurück

Body: DocumentDetailDto

Aktualisieren von Kursmetadaten

Vorgangs-ID:: updateCourse

Kursname aktualisieren

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Id	id	True	uuid	Id
Name	name		string

Gibt zurück

Body: CourseDetailDto

Aktualisieren von Lernbytemetadaten

Vorgangs-ID:: updateLearningByte

Ausgelassene Felder behalten die aktuellen Werte bei

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Lb-ID	lbId	True	uuid	Lb-ID
Name	name		string
Beschreibung	description		string

Gibt zurück

Body: LearningByteDetailDto

Aktualisieren von Medienmetadaten

Vorgangs-ID:: updateMediaMetadata

Aktualisieren des Namens und/oder der Beschreibung

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Id	id	True	uuid	Id
Name	name		string
Beschreibung	description		string

Gibt zurück

Body: MediaDetailDto

Aktualisieren von Modulmetadaten

Vorgangs-ID:: updateModule

Aktualisiert den Namen und/oder die Beschreibung. Ausgelassene Felder behalten die aktuellen Werte bei

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Modul-ID	moduleId	True	uuid	Modul-ID
Name	name		string
Beschreibung	description		string

Gibt zurück

Body: ModuleDetailDto

Aktualisieren von Themenmetadaten

Vorgangs-ID:: updateTopic

Aktualisiert den Namen und/oder die Beschreibung. Ausgelassene Felder behalten die aktuellen Werte bei

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Themen-ID	topicId	True	uuid	Themen-ID
Name	name		string
Beschreibung	description		string

Gibt zurück

Body: TopicDto

Aktualisieren von Unterrichtsinhalten

Vorgangs-ID:: updateLesson

Ausgelassener Inhalt behält den aktuellen Wert bei

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Lektions-ID	lessonId	True	uuid	Lektions-ID
Inhalt	content		string

Gibt zurück

Body: LessonDetailDto

Aufheben der Verknüpfung eines Dokuments aus einem Thema

Vorgangs-ID:: unlinkDocumentFromTopic

Idempotent

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Themen-ID	topicId	True	uuid	Themen-ID
Dokument-ID	documentId	True	uuid	Dokument-ID

Aufheben der Zuweisung eines Benutzers aus einer Rolle

Vorgangs-ID:: unassignUserFromRole

Idempotent — 204, auch wenn nicht zugewiesen wurde

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Id	id	True	uuid	Id
Rollen-ID	roleId	True	uuid	Rollen-ID
Benutzer-ID	userId	True	uuid	Benutzer-ID

Aufheben der Zuweisung eines Dokuments von einem Experten

Vorgangs-ID:: unassignDocumentFromExpert

Idempotent

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Id	id	True	uuid	Id
Dokument-ID	documentId	True	uuid	Dokument-ID

Auflisten der Zertifikate eines Kursteilnehmers

Vorgangs-ID:: listStudentCertificates

Gibt Zertifikate zurück, die von dem angegebenen Kursteilnehmer innerhalb des Unternehmens des Anrufers erzielt wurden.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Benutzer-ID	userId	True	uuid	Benutzer-ID

Gibt zurück

Body: CertificateListResponse

Auflisten von Kursen

Vorgangs-ID:: listCourses

Paginierte Liste der Kurse im Unternehmen des Anrufers

Parameter

Name	Schlüssel	Typ	Beschreibung
Seite	page	integer	Seite
Größe	size	integer	Größe
Search	search	string	Search
Status	status	string	Status
Rollen-IDs der Abteilung	departmentRoleIds	string	Rollen-IDs der Abteilung

Gibt zurück

Body: CourseListResponse

Auflisten von Lektionen in einem Lernbyte

Vorgangs-ID:: listLessonsInLearningByte

Gibt Lektionen zurück, die zum gegebenen Lernbyte gehören.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Lb-ID	lbId	True	uuid	Lb-ID

Gibt zurück

Body: LessonListResponse

Auflisten von Lernbytes in einem Thema

Vorgangs-ID:: listLearningBytesInTopic

Gibt Lernbytes zurück, die zum jeweiligen Thema gehören.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Themen-ID	topicId	True	uuid	Themen-ID

Gibt zurück

Body: LearningByteListResponse

Auflisten von Modulen in einem Kurs

Vorgangs-ID:: listModulesInCourse

Gibt aktive Module zurück, die nach OrdinalNumber sortiert sind.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Kurs-ID	courseId	True	uuid	Kurs-ID

Gibt zurück

Body: ModuleListResponse

Auflisten von Quizfragen zu einem Modul

Vorgangs-ID:: listModuleQuizQuestions

Gibt Quizfragen zurück, die dem angegebenen Modul zugeordnet sind.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Modul-ID	moduleId	True	uuid	Modul-ID

Gibt zurück

Body: QuestionListResponse

Auflisten von Quizfragen zu einem Thema

Vorgangs-ID:: listTopicQuizQuestions

Gibt Quizfragen zurück, die dem jeweiligen Thema zugeordnet sind.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Themen-ID	topicId	True	uuid	Themen-ID

Gibt zurück

Body: QuestionListResponse

Auflisten von Themen in einem Modul

Vorgangs-ID:: listTopicsInModule

Gibt aktive Themen zurück, die nach OrdinalNumber sortiert sind.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Modul-ID	moduleId	True	uuid	Modul-ID

Gibt zurück

Body: TopicListResponse

Auflisten von Übungen in einem Thema

Vorgangs-ID:: listExercisesInTopic

Gemischte Typen (ILE_TEXT / RPE_VOICE / RPE_VIDEO) sortiert nach OrdinalNumber

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Themen-ID	topicId	True	uuid	Themen-ID

Gibt zurück

Body: ExerciseListResponse

Auslösen der KI-Inhaltsgenerierung für Themen

Vorgangs-ID:: generateCourseContent

Enqueues AI Content Generation für die angegebenen Themen im Kurs

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Id	id	True	uuid	Id
topicIds	topicIds	True	array of uuid

Gibt zurück

Body: GenerationRequestResponse

Benutzer auflisten

Vorgangs-ID:: listUsers

Paginierte Liste der Benutzer im Unternehmen des Anrufers

Parameter

Name	Schlüssel	Typ	Beschreibung
Seite	page	integer	Seite
Größe	size	integer	Größe
Search	search	string	Search
Status	status	string	Status
Abteilungs-IDs	departmentIds	string	Abteilungs-IDs
Rollen-IDs	roleIds	string	Rollen-IDs
Kind	kind	string	Kind

Gibt zurück

Body: UserListResponse

Deaktivieren eines Benutzers

Vorgangs-ID:: deactivateUser

Idempotent – gibt den Benutzer zurück, auch wenn er bereits deaktiviert ist.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Id	id	True	uuid	Id

Gibt zurück

Body: UserDto

Demoschulungen auflisten

Vorgangs-ID:: listDemoTrainings

Paginierte Liste mit Bereich für das Unternehmen des Anrufers

Parameter

Name	Schlüssel	Typ	Beschreibung
Seite	page	integer	Seite
Größe	size	integer	Größe
Search	search	string	Search
Schulungstypen	trainingTypes	string	Schulungstypen
Status	statuses	string	Status
Abteilungs-IDs	departmentIds	string	Abteilungs-IDs
Ist verfügbar	isAvailable	boolean	Ist verfügbar

Gibt zurück

Body: DemoTrainingListResponse

Dokument-Binärdatei ersetzen

Vorgangs-ID:: replaceDocumentFile

Ersetzt die Datei-Binärdatei eines vorhandenen Dokuments; Metadaten bleiben erhalten

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Id	id	True	uuid	Id
Datei	file	True	file	Datei

Gibt zurück

Body: DocumentDetailDto

Dokumente auflisten

Vorgangs-ID:: listDocuments

Paginierte Liste der Dokumente im Unternehmen des Anrufers

Parameter

Name	Schlüssel	Typ	Beschreibung
Seite	page	integer	Seite
Größe	size	integer	Größe
Search	search	string	Search
MIME-Typen	mimeTypes	string	MIME-Typen
Status	status	string	Status

Gibt zurück

Body: DocumentListResponse

Einblicke auf Unternehmensebene

Vorgangs-ID:: getCompanyInsights

Top-Line-KPIs für das Unternehmen des Anrufers

Gibt zurück

Body: CompanyInsightsDto

Einblicke pro Schüler/Studenten

Vorgangs-ID:: getStudentInsights

Aggregierte Zusammenfassung und Aufschlüsselung pro Kurs für das angegebene Fenster

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Benutzer-ID	userId	True	uuid	Benutzer-ID
Fenster	window		string	Fenster

Gibt zurück

Body: StudentInsightsDto

Eine In-Lektionsfrage abrufen

Vorgangs-ID:: getLessonQuestion

Gibt eine einzelne In-Lektionsfrage anhand ihrer ID zurück.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Lektions-ID	lessonId	True	uuid	Lektions-ID
Frage-ID	questionId	True	uuid	Frage-ID

Gibt zurück

Body: QuestionDto

Entfernen aller Rollenzuweisungen aus einem Kurs

Vorgangs-ID:: removeAllRolesFromCourse

Idempotent

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Id	id	True	uuid	Id

Entfernen aller Rollenzuweisungen von einem Experten

Vorgangs-ID:: removeAllRolesFromExpert

Idempotent

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Id	id	True	uuid	Id

Entfernen einer Rollenzuweisung aus einem Kurs

Vorgangs-ID:: removeRoleFromCourse

Idempotent

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Id	id	True	uuid	Id
Rollen-ID	roleId	True	uuid	Rollen-ID

Entfernen einer Rollenzuweisung von einem Experten

Vorgangs-ID:: removeRoleFromExpert

Idempotent

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Id	id	True	uuid	Id
Rollen-ID	roleId	True	uuid	Rollen-ID

Entfernen eines Modulintros

Vorgangs-ID:: removeModuleIntro

Idempotent — 204, auch wenn keine Einführung festgelegt ist

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Modul-ID	moduleId	True	uuid	Modul-ID

Entfernen eines Themeneinführungsthemas

Vorgangs-ID:: removeTopicIntro

Idempotent — 204, auch wenn keine Einführung festgelegt ist

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Themen-ID	topicId	True	uuid	Themen-ID

Erstellen einer Abteilung

Vorgangs-ID:: createDepartment

Erstellt eine neue Abteilung im Unternehmen des Anrufers.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Name	name	True	string
Beschreibung	description		string

Gibt zurück

Body: DepartmentDto

Erstellen einer Demoschulung

Vorgangs-ID:: createDemoTraining

Erstellt eine Demoschulung aus einer zuvor hochgeladenen Videodatei und startet die Verarbeitung.

Parameter

Name	Schlüssel	Erforderlich	Typ
Name	name	True	string
Beschreibung	description		string
trainingType	trainingType	True	string
videoFileId	videoFileId	True	uuid
departmentId	departmentId		uuid
processingPrompt	processingPrompt		string

Gibt zurück

Body: DemoTrainingDto

Erstellen einer Rolle innerhalb einer Abteilung

Vorgangs-ID:: createRoleInDepartment

Erstellt eine neue Rolle, die auf die angegebene Abteilung eingestellt ist.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Id	id	True	uuid	Id
Name	name	True	string
vollständiger Name	fullName		string
Beschreibung	description		string

Gibt zurück

Body: DepartmentDto

Erstellen eines Benutzers

Vorgangs-ID:: createUser

Erstellt einen Benutzer und löst den Magic-Link-Einladungsfluss aus.

Parameter

Name	Schlüssel	Erforderlich	Typ
email	email	True	email
firstName	firstName		string
lastName	lastName		string
isAdmin	isAdmin		boolean
departmentRoleIds	departmentRoleIds		array of uuid

Gibt zurück

Body: UserDto

Erstellen eines leeren Kurses

Vorgangs-ID:: createCourse

Erstellt eine neue Kursshell mit dem angegebenen Namen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Name	name	True	string

Gibt zurück

Body: CourseDetailDto

Experten auflisten

Vorgangs-ID:: listExperts

Paginierte Liste der Experten im Unternehmen des Anrufers

Parameter

Name	Schlüssel	Typ	Beschreibung
Seite	page	integer	Seite
Größe	size	integer	Größe
Search	search	string	Search

Gibt zurück

Body: ExpertListResponse

Festlegen der Anzahl der Modul quiz für einen Fragetyp

Vorgangs-ID:: setModuleQuizSettings

Ersetzt die Anzahl für den angegebenen questionType (MULTIPLE_CHOICE oder OPEN_ENDED). Die Anzahl des anderen Typs wird beibehalten.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Modul-ID	moduleId	True	uuid	Modul-ID
questionType	questionType	True	string
anzahl	count		integer

Gibt zurück

Body: ModuleDetailDto

Festlegen der Anzahl der Themen quiz für einen Fragetyp

Vorgangs-ID:: setTopicQuizSettings

Ersetzt die Anzahl für den angegebenen questionType (MULTIPLE_CHOICE oder OPEN_ENDED). Die Anzahl des anderen Typs wird beibehalten.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Themen-ID	topicId	True	uuid	Themen-ID
questionType	questionType	True	string
anzahl	count		integer

Gibt zurück

Body: TopicDto

Festlegen oder Ersetzen eines Modulintros

Vorgangs-ID:: setModuleIntro

Upsert – erstellt, falls nicht vorhanden, ersetzt, wenn vorhanden

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Modul-ID	moduleId	True	uuid	Modul-ID
Einführung	introduction		string

Gibt zurück

Body: IntroDto

Festlegen oder Ersetzen eines Themaintros

Vorgangs-ID:: setTopicIntro

Upsert – erstellt, falls nicht vorhanden, ersetzt, wenn vorhanden

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Themen-ID	topicId	True	uuid	Themen-ID
Einführung	introduction		string

Gibt zurück

Body: IntroDto

Generieren eines bestimmten Elements über KI

Vorgangs-ID:: regenerateCourseItem

Generiert eine einzelne Lektion, Unterrichtsfragen, Quiz, Einführung oder Übung

Parameter

Name	Schlüssel	Erforderlich	Typ
target	target	True	string
targetId	targetId	True	uuid
parentType	parentType		string

Gibt zurück

Body: GenerationRequestResponse

Generieren eines vollständigen Kurses mit KI-Inhalten

Vorgangs-ID:: generateCourse

Erstellt die Kursshell, alle Module, alle Themen und Queues KI-Inhaltsgenerierung für jedes Thema

Parameter

Name	Schlüssel	Erforderlich	Typ
Name	name	True	string
Beschreibung	description		string
Name	name	True	string
Beschreibung	description		string
Name	name	True	string
Beschreibung	description		string

Gibt zurück

Body: GenerateCourseResponse

Hinzufügen einer ILE_TEXT Übung zu einem Thema

Vorgangs-ID:: addIleTextExercise

Erstellt eine neue ILE_TEXT Übung innerhalb des angegebenen Themas.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Themen-ID	topicId	True	uuid	Themen-ID
Eingabeaufforderung	prompt		string

Gibt zurück

Body: ExerciseDto

Hinzufügen einer In-Lektionsfrage

Vorgangs-ID:: addLessonQuestion

Typ muss MULTIPLE_CHOICE sein (erfordert Optionen) oder OPEN_ENDED

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Lektions-ID	lessonId	True	uuid	Lektions-ID
Typ	type	True	string
Text	text	True	string
OrdinalNumber	ordinalNumber		integer
Text	text	True	string
isCorrect	isCorrect		boolean
expectedAnswer	expectedAnswer		string

Gibt zurück

Body: QuestionDto

Hinzufügen einer Lektion zu einem Lernbyte

Vorgangs-ID:: addLessonToLearningByte

Erstellt eine neue Lektion innerhalb des angegebenen Lernbytes.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Lb-ID	lbId	True	uuid	Lb-ID
Inhalt	content	True	string

Gibt zurück

Body: LessonDetailDto

Hinzufügen einer Quizfrage zu einem Modul

Vorgangs-ID:: addModuleQuizQuestion

Erstellt eine neue Quizfrage innerhalb des angegebenen Moduls.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Modul-ID	moduleId	True	uuid	Modul-ID
Typ	type	True	string
Text	text	True	string
OrdinalNumber	ordinalNumber		integer
Text	text	True	string
isCorrect	isCorrect		boolean
expectedAnswer	expectedAnswer		string

Gibt zurück

Body: QuestionDto

Hinzufügen einer Quizfrage zu einem Thema

Vorgangs-ID:: addTopicQuizQuestion

Erstellt eine neue Quizfrage innerhalb des angegebenen Themas.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Themen-ID	topicId	True	uuid	Themen-ID
Typ	type	True	string
Text	text	True	string
OrdinalNumber	ordinalNumber		integer
Text	text	True	string
isCorrect	isCorrect		boolean
expectedAnswer	expectedAnswer		string

Gibt zurück

Body: QuestionDto

Hinzufügen einer RPE_VIDEO Übung zu einem Thema

Vorgangs-ID:: addRpeVideoExercise

Erstellt eine neue RPE_VIDEO Rollenspielübung innerhalb des jeweiligen Themas.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Themen-ID	topicId	True	uuid	Themen-ID
Eingabeaufforderung	prompt		string
avatarPictureId	avatarPictureId		uuid
avatarCharacteristics	avatarCharacteristics		string
reverseRolePlayEnabled	reverseRolePlayEnabled		boolean
reverseRolePlayMandatory	reverseRolePlayMandatory		boolean

Gibt zurück

Body: ExerciseDto

Hinzufügen einer RPE_VOICE Übung zu einem Thema

Vorgangs-ID:: addRpeVoiceExercise

Erstellt eine neue RPE_VOICE Rollenspielübung innerhalb des jeweiligen Themas.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Themen-ID	topicId	True	uuid	Themen-ID
Eingabeaufforderung	prompt		string
avatarPictureId	avatarPictureId		uuid
avatarCharacteristics	avatarCharacteristics		string
reverseRolePlayEnabled	reverseRolePlayEnabled		boolean
reverseRolePlayMandatory	reverseRolePlayMandatory		boolean

Gibt zurück

Body: ExerciseDto

Hinzufügen eines Lernbytes zu einem Thema

Vorgangs-ID:: addLearningByteToTopic

Erstellt ein neues Lernbyte innerhalb des jeweiligen Themas.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Themen-ID	topicId	True	uuid	Themen-ID
Name	name	True	string
Beschreibung	description		string

Gibt zurück

Body: LearningByteDetailDto

Hinzufügen eines Moduls zu einem Kurs

Vorgangs-ID:: addModuleToCourse

Erstellt ein neues Modul innerhalb des angegebenen Kurses.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Kurs-ID	courseId	True	uuid	Kurs-ID
Name	name	True	string
Beschreibung	description		string

Gibt zurück

Body: ModuleDetailDto

Hinzufügen eines Themas zu einem Modul

Vorgangs-ID:: addTopicToModule

Erstellt ein neues Thema innerhalb des angegebenen Moduls.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Modul-ID	moduleId	True	uuid	Modul-ID
Name	name	True	string
Beschreibung	description		string

Gibt zurück

Body: TopicDto

Hochladen eines Dokuments

Vorgangs-ID:: uploadDocument

Mehrteiliger Upload (Datei + optionale Beschreibung). Max. 50 MB.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Datei	file	True	file	Datei
Description	description		string	Description

Gibt zurück

Body: DocumentDetailDto

Hochladen eines Medienelements

Vorgangs-ID:: uploadMedia

Mehrteiliger Upload (Datei + optionale Beschreibung). Max. 50 MB für Bilder, 500 MB für Videos.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Datei	file	True	file	Datei
Description	description		string	Description

Gibt zurück

Body: MediaDetailDto

Holen Sie sich einen Experten

Vorgangs-ID:: getExpert

Gibt Expertenmetadaten, verknüpfte Dokumente und zugewiesene Rollen/Abteilungen zurück.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Id	id	True	uuid	Id

Gibt zurück

Body: ExpertDetailDto

In-Lektionsfragen auflisten

Vorgangs-ID:: listLessonQuestions

Gibt Wissensüberprüfungsfragen zurück, die der angegebenen Lektion zugeordnet sind.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Lektions-ID	lessonId	True	uuid	Lektions-ID

Gibt zurück

Body: QuestionListResponse

Kurs abrufen

Vorgangs-ID:: getCourse

Gibt Kursmetadaten mit Modulzusammenfassungen und zugewiesenen Rollen/Abteilungen zurück.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Id	id	True	uuid	Id

Gibt zurück

Body: CourseDetailDto

Kursversionen auflisten

Vorgangs-ID:: listCourseVersions

Gibt veröffentlichte Versionsmetadaten zurück (Anzahl + Veröffentlichungsinformationen), sortiert nach Versionsnummer

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Kurs-ID	courseId	True	uuid	Kurs-ID

Gibt zurück

Body: CourseVersionListResponse

Löschen (Deaktivieren) einer Abteilung

Vorgangs-ID:: deleteDepartment

Idempotent - gibt 204 zurück, auch wenn bereits deaktiviert. Kaskadiert an Rollenzuweisungen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Id	id	True	uuid	Id

Löschen (Deaktivieren) eines Dokuments

Vorgangs-ID:: deleteDocument

Idempotent – gibt 204 zurück, auch wenn das Dokument bereits gelöscht oder fehlt.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Id	id	True	uuid	Id

Löschen (Deaktivieren) eines Medienelements

Vorgangs-ID:: deleteMedia

Idempotent – gibt 204 zurück, auch wenn das Element bereits gelöscht oder fehlt.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Id	id	True	uuid	Id

Löschen (weich) eines Kurses

Vorgangs-ID:: deleteCourse

Idempotent - gibt 204 zurück, auch wenn der Kurs bereits entfernt wurde

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Id	id	True	uuid	Id

Löschen einer Demoschulung

Vorgangs-ID:: deleteDemoTraining

Idempotent - gibt 204 zurück, auch wenn die Demo-Schulung nicht vorhanden ist oder bereits verschwunden ist