Time Machine (preview)
Time Machine is een op AI gebaseerd bedrijfsleerplatform. Het verandert in bedrijfsdocumenten, video's en deskundige kennis in gestructureerde cursussen met modules, onderwerpen, toetsen en rollenspeloefeningen, en houdt de voortgang van cursisten bij. Gebouwd voor HR- en L&D-teams die werknemers op schaal onboarden, trainen en certificeren. De connector automatiseert de volledige leerlevenscyclus: cursussen, gebruikers, afdelingen en rollen beheren; toetsen genereren uit documenten; en lees voltooiingsanalyses.
Deze connector is beschikbaar in de volgende producten en regio's:
| Dienst | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate regio's behalve: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Logic-apps | Standard | Alle Logic Apps-regio's , met uitzondering van het volgende: - Azure Government regio's - Azure China-regio's - Us Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps regio's behalve: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate regio's behalve: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Contact | |
|---|---|
| Naam | Time Machine-ondersteuning |
| URL | https://timeml.ai |
| Connectormetagegevens | |
|---|---|
| Uitgever | Time Machine AI |
| Website | https://timeml.ai |
| Privacybeleid | https://timeml.ai/privacy-policy |
| Categorieën | Productiviteit; AI |
Time Machine - Power Automate-connector
Wat is Time Machine?
Time Machine is een op AI gebaseerd organisatie learning-platform waarmee bedrijven adaptieve leersystemen voor moderne teams kunnen bouwen, gebruiken en continu verbeteren. Organisaties gebruiken Time Machine om bestaande kennis, documenten, opnamen en werkstromen te transformeren in schaalbare trainingservaringen waarmee onboarding wordt versneld, de gereedheid van werknemers wordt verbeterd en de expertise van de beste prestaties in de hele organisatie wordt gerepliceerd.
Tenantbeheerders beheren gebruikers, leerinhoud, organisatieresources en platformconfiguratie via de Time Machine REST API. Deze connector maakt de openbare REST API beschikbaar als Power Automate acties, zodat u het inrichten van gebruikers, inhoudsopname, kennissynchronisatie en levenscyclusbeheer kunt automatiseren zonder code te schrijven.
Prerequisites
- Een actieve Time Machine-tenant met beheerderstoegang
- Een Time Machine API-sleutel die is uitgegeven via Instellingen → API-sleutels in het beheervenster (
https://web.timeml.ai). De sleutel is een waarde die begint mettm_live_.
Authentication
Elke actie wordt geverifieerd met een API-sleutel in de Authorization header. Bij het maken van een verbinding in Power Automate:
-
veld:
API key -
Waarde: plakken
Bearer tm_live_<your-token>(de volledige tekenreeks, inclusief hetBearervoorvoegsel en een spatie vóór het token)
Beschikbare acties
De connector spiegelt de openbare REST API van Time Machine (116 eindpunten). Acties worden gegroepeerd op resource:
- Cursussen : vermelden/maken/bijwerken/verwijderen/cursussen publiceren, rollen toewijzen, AI-geschreven inhoud genereren
- Gebruikers : gebruikers weergeven/maken/bijwerken/deactiveren/opnieuw activeren
- Documenten — lijst / uploaden / bijwerken / documenten verwijderen
- Media — lijst / uploaden / bijwerken / media-items verwijderen
- Afdelingen - lijst / maken / bijwerken / verwijderen afdelingen, rollen beheren, gebruikers toewijzen aan rollen
- Experts — lijst/ expertprofielen maken, vragen stellen aan experts, documenten en rollen toewijzen
- Demotrainingen — lijst / maken / bijwerken / demotrainingen verwijderen
- Cursusinhoud : modules, onderwerpen, lessen, oefeningen, toetsvragen
- Inzichten : analyse per student, per cursus en analyse op bedrijfsniveau
- Certificaten : studentencertificaten weergeven, PDF-bestanden voor certificaten downloaden
Volledige eindpuntreferentie is beschikbaar op https://api.timeml.ai/api/v1/docs.
Voorbeeldwerkstromen
- Confluence-release → Time Machine: wanneer een releasepagina wordt gepubliceerd in Confluence, uploadt u deze als een document in Time Machine, zodat deze in de leer-bytebibliotheek stroomt.
- HR-onboarding: Wanneer er een nieuwe werknemersrij wordt weergegeven in uw HRIS, maakt u een Time Machine-gebruiker met hun afdelings- en roltoewijzingen, waardoor de magic-link-uitnodiging wordt geactiveerd.
- Meldingen over voltooiing van de cursus: wanneer een student een cursus voltooit, verzendt u een certificaat-PDF naar Slack en meldt u de voltooiing aan een Google Sheet.
Bekende beperkingen
- API-sleutelrotatie: verbindingen moeten handmatig worden bijgewerkt wanneer de API-sleutel wordt geroteerd. Er is geen mechanisme voor automatisch vernieuwen.
- Uploads met meerdere onderdelen: acties voor het uploaden van bestanden (Upload Document, Media uploaden) accepteren bestanden van maximaal 50 MB. Voor grotere media splitst u op in meerdere uploads of neemt u contact op met de ondersteuning van Time Machine.
- Batchbewerkingen: de API werkt op één record tegelijk. Voor bulkacties gebruikt u het ingebouwde besturingselement van Power Automate van toepassing op elk besturingselement.
Support
Neem voor vragen of problemen met de connector contact op met uw Time Machine-accountteam of e-mailondersteuning op support@timeml.ai.
Een verbinding maken
De connector ondersteunt de volgende verificatietypen:
| Standaard | Parameters voor het maken van verbinding. | Alle regio's | Niet deelbaar |
Verstek
Van toepassing: Alle regio's
Parameters voor het maken van verbinding.
Dit is geen deelbare verbinding. Als de power-app wordt gedeeld met een andere gebruiker, wordt een andere gebruiker gevraagd om expliciet een nieuwe verbinding te maken.
| Naam | Typ | Description | Required |
|---|---|---|---|
| Time Machine-API-sleutel (indeling: Bearer tm_live_...) | beveiligde string | De Time Machine API-sleutel (indeling: Bearer tm_live_...) voor deze API | True |
Acties
| Aantal onderwerpvragen instellen voor één vraagtype |
Vervangt het aantal voor het opgegeven questionType (MULTIPLE_CHOICE of OPEN_ENDED). Het aantal andere typen blijft behouden |
| Activiteitengebeurtenissen per leerling/student |
Gepagineerde gebeurtenisstroom voor alleen-doorstuur |
| Afdelingen vermelden |
Alle afdelingen in het bedrijf van de beller met geneste rollen |
| AI-inhoud genereren activeren voor onderwerpen |
Ai-inhoudsgeneratie enqueues voor de opgegeven onderwerpen in de cursus |
| Alle roltoewijzingen uit een cursus verwijderen |
Idempotent (onveranderlijk bij herhaald gebruik) |
| Alle roltoewijzingen van een expert verwijderen |
Idempotent (onveranderlijk bij herhaald gebruik) |
| Beschikbaarheid voor leerlingen/studenten in-/uitschakelen |
Instellen of de demotraining wordt gepubliceerd voor leerlingen/studenten. Idempotent. |
| Binair document vervangen |
Vervangt het binaire bestand van een bestaand document; metagegevens blijven behouden |
| Bytemetagegevens voor leren bijwerken |
Weggelaten velden behouden huidige waarden |
| Certificaatdetails |
Retourneert één certificaat dat is gericht op het bedrijf van de beller |
| Cursusmetagegevens bijwerken |
Cursusnaam bijwerken |
| Cursussen vermelden |
Gepagineerde lijst met cursussen in het bedrijf van de beller |
| Cursusversies weergeven |
Retourneert gepubliceerde versiemetagegevens (aantallen + publicatiegegevens) gesorteerd op versienummer |
| De certificaten van een leerling/student vermelden |
Retourneert certificaten die zijn verdiend door de opgegeven student binnen het bedrijf van de beller |
| Demotrainingen weergeven |
Gepagineerde lijst die is gericht op het bedrijf van de beller |
| Documenten koppelen aan een onderwerp |
Additief : reeds gekoppelde documenten worden overgeslagen |
| Documenten toewijzen aan een expert |
Documenten bulksgewijs koppelen aan de expert. Idempotent. |
| Documenten weergeven |
Gepagineerde lijst met documenten in het bedrijf van de beller |
| Documenten weergeven die zijn gekoppeld aan een onderwerp |
Gepagineerd; optioneel zoeken op documentnaam |
| Documentmetagegevens bijwerken |
Naam en/of beschrijving bijwerken |
| Een afdeling bijwerken |
Naam en/of beschrijving bijwerken |
| Een afdeling maken |
Hiermee maakt u een nieuwe afdeling in het bedrijf van de beller. |
| Een afdeling verwijderen (deactiveren) |
Idempotent — retourneert 204, zelfs als deze al is gedeactiveerd. Trapsgewijs naar roltoewijzingen. |
| Een cursus ophalen |
Retourneert cursusmetagegevens met moduleoverzichten en toegewezen rollen/afdelingen |
| Een cursus publiceren |
Publiceert de cursus; mislukt met 400 als er geen publicatiebare inhoud is |
| Een cursus verwijderen (voorlopig) |
Idempotent — retourneert 204, zelfs als de cursus al is verwijderd |
| Een demotraining bijwerken |
Gedeeltelijke update. Geef alleen de velden door die u wilt wijzigen. assignedRoleIds vervangt de huidige set. |
| Een demotraining krijgen |
Retourneert de volledige demotraining met segmenten |
| Een demotraining maken |
Hiermee maakt u een demotraining op basis van een eerder geüpload videobestand en begint u met verwerken |
| Een demotraining verwijderen |
Idempotent — retourneert 204, zelfs als de demotraining niet bestaat of al is verdwenen |
| Een document intrekken van een expert |
Idempotent (onveranderlijk bij herhaald gebruik) |
| Een document ophalen |
Retourneert documentmetagegevens en een kortdurende ondertekende download-URL |
| Een document uploaden |
Uploaden met meerdere onderdelen (bestand + optionele beschrijving). Max. 50 MB. |
| Een document verwijderen (deactiveren) |
Idempotent : retourneert 204, zelfs als het document al is verwijderd of ontbreekt |
| Een expert een vraag stellen |
Synchrone wrapper rond de streaming AI-chat. Retourneert het samengestelde antwoord. |
| Een expert krijgen |
Retourneert deskundige metagegevens, gekoppelde documenten en toegewezen rollen/afdelingen |
| Een gebruiker bijwerken |
Werk firstName, lastName, isAdmin en roltoewijzingen bij. E-mail kan niet worden bewerkt in v1. |
| Een gebruiker deactiveren |
Idempotent — retourneert de gebruiker zelfs als deze al is gedeactiveerd |
| Een gebruiker maken |
Hiermee maakt u een gebruiker en activeert u de magic-link-uitnodigingsstroom |
| Een gebruiker ophalen |
Retourneert gebruikersmetagegevens en afdelings-/roltoewijzingen |
| Een gebruiker opnieuw activeren |
Idempotent — retourneert de gebruiker zelfs als deze al actief is |
| Een gebruiker toewijzen aan een rol |
Idempotent (onveranderlijk bij herhaald gebruik) |
| Een gebruiker uit een rol intrekken |
Idempotent — 204 zelfs als er niet aan is toegewezen |
| Een ILE_TEXT oefening toevoegen aan een onderwerp |
Hiermee maakt u een nieuwe ILE_TEXT oefening in het opgegeven onderwerp. |
| Een in-lesson-vraag bijwerken |
Geef velden op die overeenkomen met het opgeslagen type; niet-gerelateerde velden worden genegeerd |
| Een in-lesson-vraag toevoegen |
type moet zijn MULTIPLE_CHOICE (vereist opties) of OPEN_ENDED |
| Een in-lesson-vraag verwijderen |
Idempotent — 204 zelfs als deze al is verwijderd |
| Een learning-byte verwijderen (voorlopig) |
Idempotent — 204 zelfs als deze al is verwijderd |
| Een leer-byte krijgen |
Hiermee worden metagegevens en geneste lessen geretourneerd |
| Een leer byte toevoegen aan een onderwerp |
Hiermee maakt u een nieuwe learning-byte binnen het opgegeven onderwerp. |
| Een lege cursus maken |
Hiermee maakt u een nieuwe cursusshell met de opgegeven naam |
| Een les krijgen |
Retourneert lesinhoud, media en in-lesson vragen |
| Een les toevoegen aan een leer byte |
Hiermee maakt u een nieuwe les in de opgegeven learning-byte. |
| Een les verwijderen (voorlopig) |
Idempotent — 204 zelfs als deze al is verwijderd |
| Een media-item ophalen |
Hiermee worden mediametagegevens en een kortstondige download-URL geretourneerd |
| Een media-item uploaden |
Uploaden met meerdere onderdelen (bestand + optionele beschrijving). Maximaal 50 MB voor afbeeldingen, 500 MB voor video's. |
| Een media-item verwijderen (deactiveren) |
Idempotent : retourneert 204, zelfs als het item al is verwijderd of ontbreekt |
| Een module ophalen |
Retourneert moduledetails voor de opgegeven id. |
| Een module toevoegen aan een cursus |
Hiermee maakt u een nieuwe module in de opgegeven cursus. |
| Een module verwijderen (voorlopig) |
Idempotent : retourneert 204, zelfs als de module al is verwijderd |
| Een momentopname van een cursusversie ophalen |
Retourneert de volledige inhoudsstructuur (modules, onderwerpen, lessen, oefeningen, vragen) voor de opgegeven versie |
| Een oefening bijwerken |
Typebewust: ILE_TEXT gebruikt alleen prompt + generatedContent.scenario; RPE_* gebruikt alle RPE-velden. Weggelaten velden behouden de huidige waarden. |
| Een oefening ophalen |
Retourneert oefeningsgegevens voor de opgegeven id. |
| Een oefening verwijderen |
Idempotent — 204 zelfs als deze al is verwijderd |
| Een onderwerp ophalen |
Retourneert onderwerpdetails voor de opgegeven id. |
| Een onderwerp toevoegen aan een module |
Hiermee maakt u een nieuw onderwerp in de opgegeven module. |
| Een onderwerp verplaatsen naar een andere module |
targetOrdinalNumber is optioneel; als u het onderwerp weglaat, wordt toegevoegd aan de doelmodule |
| Een onderwerp verwijderen (voorlopig) |
Idempotent : retourneert 204, zelfs als het onderwerp al is verwijderd |
| Een rol binnen een afdeling maken |
Hiermee maakt u een nieuwe rol binnen het bereik van de opgegeven afdeling. |
| Een RPE_VIDEO oefening toevoegen aan een onderwerp |
Hiermee maakt u een nieuwe RPE_VIDEO rolspeloefening in het opgegeven onderwerp. |
| Een RPE_VOICE oefening toevoegen aan een onderwerp |
Hiermee maakt u een nieuwe RPE_VOICE rolspeloefening in het opgegeven onderwerp. |
| Een specifiek item opnieuw genereren via AI |
Hiermee wordt één les, lesvragen, toets, inleiding of oefening opnieuw gegenereerd |
| Een toetsvraag in een module verwijderen |
Idempotent — 204 zelfs als deze al is verwijderd |
| Een toetsvraag over een module ophalen |
Hiermee wordt één toetsvraag geretourneerd die is gekoppeld aan de opgegeven module. |
| Een toetsvraag over een onderwerp ophalen |
Hiermee wordt één toetsvraag geretourneerd die is gekoppeld aan het opgegeven onderwerp. |
| Een toetsvraag toevoegen aan een module |
Hiermee maakt u een nieuwe toetsvraag in de opgegeven module. |
| Een toetsvraag toevoegen aan een onderwerp |
Hiermee maakt u een nieuwe toetsvraag in het opgegeven onderwerp. |
| Een toetsvraag voor een onderwerp verwijderen |
Idempotent — 204 zelfs als deze al is verwijderd |
| Een volledige cursus genereren met AI-inhoud |
Hiermee maakt u de cursusshell, alle modules, alle onderwerpen en enqueues ai-inhoud genereren voor elk onderwerp |
| Een vraag in de les krijgen |
Retourneert één in-lesson-vraag op basis van de id. |
| Eén document loskoppelen van een onderwerp |
Idempotent (onveranderlijk bij herhaald gebruik) |
| Eén quizvraag bijwerken in een module |
Geef velden op die overeenkomen met het opgeslagen type; niet-gerelateerde velden worden genegeerd. |
| Eén quizvraag bijwerken voor een onderwerp |
Geef velden op die overeenkomen met het opgeslagen type; niet-gerelateerde velden worden genegeerd. |
| Eén roltoewijzing uit een cursus verwijderen |
Idempotent (onveranderlijk bij herhaald gebruik) |
| Eén roltoewijzing van een expert verwijderen |
Idempotent (onveranderlijk bij herhaald gebruik) |
| Gebruikers weergeven |
Gepagineerde lijst met gebruikers in het bedrijf van de beller |
| Het aantal modulequiz instellen voor één vraagtype |
Vervangt het aantal voor het opgegeven questionType (MULTIPLE_CHOICE of OPEN_ENDED). Het aantal andere typen blijft behouden |
| In-lesvragen opnieuw ordenen |
questionIds moeten elke actieve vraag voor de les bevatten, in de nieuwe volgorde |
| In-lesvragen weergeven |
Retourneert kennistoetsvragen die zijn gekoppeld aan de gegeven les. |
| Inleiding tot een module ophalen |
Retourneert de introtekst die is ingesteld voor de opgegeven module. |
| Inleiding tot een module verwijderen |
Idempotent — 204 zelfs als er geen intro is ingesteld |
| Inleiding tot een onderwerp instellen of vervangen |
Upsert : wordt gemaakt als deze ontbreekt, vervangt indien aanwezig |
| Inleiding tot een onderwerp ophalen |
Retourneert de introtekst die is ingesteld voor het opgegeven onderwerp. |
| Inleiding tot een onderwerp verwijderen |
Idempotent — 204 zelfs als er geen intro is ingesteld |
| Inleiding tot het instellen of vervangen van een module |
Upsert : wordt gemaakt als deze ontbreekt, vervangt indien aanwezig |
| Inzichten op bedrijfsniveau |
KPI's op de bovenste regel voor het bedrijf van de beller |
| Inzichten per leerling/student |
Geaggregeerde samenvatting en uitsplitsing per cursus voor het opgegeven venster |
| Leerbytes weergeven in een onderwerp |
Retourneert leerbytes die deel uitmaken van het opgegeven onderwerp. |
| Lesinhoud bijwerken |
Als u inhoud weglaat, blijft de huidige waarde behouden |
| Lessen in een leer byte vermelden |
Retourneert lessen die deel uitmaken van de gegeven leer byte. |
| Lijstexperts |
Gepagineerde lijst met experts in het bedrijf van de beller |
| Media binair vervangen |
Vervangt het binaire bestand van een bestaand media-item; metagegevens blijven behouden |
| Media vermelden |
Gepagineerde lijst met media-items in het bedrijf van de beller |
| Metagegevens van media bijwerken |
Naam en/of beschrijving bijwerken |
| Metagegevens van module bijwerken |
Hiermee werkt u de naam en/of beschrijving bij. Weggelaten velden behouden huidige waarden |
| Metagegevens van onderwerp bijwerken |
Hiermee werkt u de naam en/of beschrijving bij. Weggelaten velden behouden huidige waarden |
| Modules in een cursus opnieuw ordenen |
moduleIds moeten elke actieve module precies één keer bevatten, in de nieuwe volgorde |
| Modules in een cursus vermelden |
Retourneert actieve modules geordend op ordinaalNumber |
| Oefeningen in een onderwerp weergeven |
Gemengde typen (ILE_TEXT / RPE_VOICE / RPE_VIDEO) gesorteerd op ordinaalNumber |
| Onderwerpen in een module opnieuw ordenen |
topicIds moeten elk actief onderwerp precies één keer bevatten, in de nieuwe volgorde |
| Onderwerpen in een module vermelden |
Retourneert actieve onderwerpen geordend op ordinaalNumber |
| PDF-certificaat downloaden |
Hiermee wordt het pdf-bestand van het certificaat gestreamd. Retourneert 404 als het certificaat nog geen PDF heeft |
| Quizvragen over een onderwerp weergeven |
Hiermee worden toetsvragen geretourneerd die zijn gekoppeld aan het opgegeven onderwerp. |
| Rollen toewijzen aan een cursus |
Additief: rollen die al zijn toegewezen, worden overgeslagen. Retourneert de bijgewerkte cursusdetails |
| Rollen toewijzen aan een expert |
Additief — reeds toegewezen rollen worden bewaard; nieuwe toegevoegd. Retourneert bijgewerkte expert |
| Status van AI-generatie voor een cursus ophalen |
Retourneert de lijst met actieve AI-generatieaanvragen voor de cursus met voortgang en doelgegevens |
| Toetsvragen over een onderwerp opnieuw ordenen |
questionIds moeten elke actieve toetsvraag voor het onderwerp bevatten, in de nieuwe volgorde. |
| Toetsvragen voor een module opnieuw ordenen |
questionIds moeten elke actieve toetsvraag voor de module bevatten, in de nieuwe volgorde. |
| Toetsvragen weergeven in een module |
Hiermee worden toetsvragen geretourneerd die zijn gekoppeld aan de opgegeven module. |
| Videoverwerking opnieuw uitvoeren |
Verzendt de video opnieuw voor AI-segmentatie. U kunt eventueel de verwerkingsprompt overschrijven. |
Aantal onderwerpvragen instellen voor één vraagtype
Vervangt het aantal voor het opgegeven questionType (MULTIPLE_CHOICE of OPEN_ENDED). Het aantal andere typen blijft behouden
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Onderwerp-id
|
topicId | True | uuid |
Onderwerp-id |
|
questionType
|
questionType | True | string | |
|
aantal
|
count | integer |
Retouren
- Body
- TopicDto
Activiteitengebeurtenissen per leerling/student
Gepagineerde gebeurtenisstroom voor alleen-doorstuur
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Gebruikersnaam
|
userId | True | uuid |
Gebruikersnaam |
|
Pagina
|
page | integer |
Pagina |
|
|
Grootte
|
size | integer |
Grootte |
Retouren
- Body
- EventListResponse
Afdelingen vermelden
Alle afdelingen in het bedrijf van de beller met geneste rollen
Retouren
AI-inhoud genereren activeren voor onderwerpen
Ai-inhoudsgeneratie enqueues voor de opgegeven onderwerpen in de cursus
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
topicIds
|
topicIds | True | array of uuid |
Retouren
Alle roltoewijzingen uit een cursus verwijderen
Idempotent (onveranderlijk bij herhaald gebruik)
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
Alle roltoewijzingen van een expert verwijderen
Idempotent (onveranderlijk bij herhaald gebruik)
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
Beschikbaarheid voor leerlingen/studenten in-/uitschakelen
Instellen of de demotraining wordt gepubliceerd voor leerlingen/studenten. Idempotent.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
available
|
available | True | boolean |
Retouren
- Body
- DemoTrainingDto
Binair document vervangen
Vervangt het binaire bestand van een bestaand document; metagegevens blijven behouden
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
File
|
file | True | file |
File |
Retouren
- Body
- DocumentDetailDto
Bytemetagegevens voor leren bijwerken
Weggelaten velden behouden huidige waarden
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Lb-id
|
lbId | True | uuid |
Lb-id |
|
naam
|
name | string | ||
|
beschrijving
|
description | string |
Retouren
Certificaatdetails
Retourneert één certificaat dat is gericht op het bedrijf van de beller
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
Retouren
- Body
- CertificateDto
Cursusmetagegevens bijwerken
Cursusnaam bijwerken
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
naam
|
name | string |
Retouren
- Body
- CourseDetailDto
Cursussen vermelden
Gepagineerde lijst met cursussen in het bedrijf van de beller
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Pagina
|
page | integer |
Pagina |
|
|
Grootte
|
size | integer |
Grootte |
|
|
Search
|
search | string |
Search |
|
|
Status
|
status | string |
Status |
|
|
Rol-id's van afdeling
|
departmentRoleIds | string |
Rol-id's van afdeling |
Retouren
- Body
- CourseListResponse
Cursusversies weergeven
Retourneert gepubliceerde versiemetagegevens (aantallen + publicatiegegevens) gesorteerd op versienummer
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Cursus-id
|
courseId | True | uuid |
Cursus-id |
Retouren
De certificaten van een leerling/student vermelden
Retourneert certificaten die zijn verdiend door de opgegeven student binnen het bedrijf van de beller
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Gebruikersnaam
|
userId | True | uuid |
Gebruikersnaam |
Retouren
Demotrainingen weergeven
Gepagineerde lijst die is gericht op het bedrijf van de beller
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Pagina
|
page | integer |
Pagina |
|
|
Grootte
|
size | integer |
Grootte |
|
|
Search
|
search | string |
Search |
|
|
Trainingstypen
|
trainingTypes | string |
Trainingstypen |
|
|
Statussen
|
statuses | string |
Statussen |
|
|
Afdelings-id's
|
departmentIds | string |
Afdelings-id's |
|
|
Is beschikbaar
|
isAvailable | boolean |
Is beschikbaar |
Retouren
Documenten koppelen aan een onderwerp
Additief : reeds gekoppelde documenten worden overgeslagen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Onderwerp-id
|
topicId | True | uuid |
Onderwerp-id |
|
documentIds
|
documentIds | True | array of uuid |
Documenten toewijzen aan een expert
Documenten bulksgewijs koppelen aan de expert. Idempotent.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
documentIds
|
documentIds | True | array of uuid |
Retouren
- Body
- ExpertDetailDto
Documenten weergeven
Gepagineerde lijst met documenten in het bedrijf van de beller
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Pagina
|
page | integer |
Pagina |
|
|
Grootte
|
size | integer |
Grootte |
|
|
Search
|
search | string |
Search |
|
|
Mime-typen
|
mimeTypes | string |
Mime-typen |
|
|
Status
|
status | string |
Status |
Retouren
- Body
- DocumentListResponse
Documenten weergeven die zijn gekoppeld aan een onderwerp
Gepagineerd; optioneel zoeken op documentnaam
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Onderwerp-id
|
topicId | True | uuid |
Onderwerp-id |
|
Pagina
|
page | integer |
Pagina |
|
|
Grootte
|
size | integer |
Grootte |
|
|
Search
|
search | string |
Search |
Retouren
Documentmetagegevens bijwerken
Naam en/of beschrijving bijwerken
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
naam
|
name | string | ||
|
beschrijving
|
description | string |
Retouren
- Body
- DocumentDetailDto
Een afdeling bijwerken
Naam en/of beschrijving bijwerken
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
naam
|
name | string | ||
|
beschrijving
|
description | string |
Retouren
- Body
- DepartmentDto
Een afdeling maken
Hiermee maakt u een nieuwe afdeling in het bedrijf van de beller.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
naam
|
name | True | string | |
|
beschrijving
|
description | string |
Retouren
- Body
- DepartmentDto
Een afdeling verwijderen (deactiveren)
Idempotent — retourneert 204, zelfs als deze al is gedeactiveerd. Trapsgewijs naar roltoewijzingen.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
Een cursus ophalen
Retourneert cursusmetagegevens met moduleoverzichten en toegewezen rollen/afdelingen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
Retouren
- Body
- CourseDetailDto
Een cursus publiceren
Publiceert de cursus; mislukt met 400 als er geen publicatiebare inhoud is
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
Retouren
- Body
- CourseDetailDto
Een cursus verwijderen (voorlopig)
Idempotent — retourneert 204, zelfs als de cursus al is verwijderd
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
Een demotraining bijwerken
Gedeeltelijke update. Geef alleen de velden door die u wilt wijzigen. assignedRoleIds vervangt de huidige set.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
naam
|
name | string | ||
|
beschrijving
|
description | string | ||
|
trainingType
|
trainingType | string | ||
|
departmentId
|
departmentId | uuid | ||
|
assignedRoleIds
|
assignedRoleIds | array of uuid |
Retouren
- Body
- DemoTrainingDto
Een demotraining krijgen
Retourneert de volledige demotraining met segmenten
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
Retouren
- Body
- DemoTrainingDto
Een demotraining maken
Hiermee maakt u een demotraining op basis van een eerder geüpload videobestand en begint u met verwerken
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
naam
|
name | True | string | |
|
beschrijving
|
description | string | ||
|
trainingType
|
trainingType | True | string | |
|
videoFileId
|
videoFileId | True | uuid | |
|
departmentId
|
departmentId | uuid | ||
|
processingPrompt
|
processingPrompt | string |
Retouren
- Body
- DemoTrainingDto
Een demotraining verwijderen
Idempotent — retourneert 204, zelfs als de demotraining niet bestaat of al is verdwenen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
Een document intrekken van een expert
Idempotent (onveranderlijk bij herhaald gebruik)
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
Document-id
|
documentId | True | uuid |
Document-id |
Een document ophalen
Retourneert documentmetagegevens en een kortdurende ondertekende download-URL
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
Retouren
- Body
- DocumentDetailDto
Een document uploaden
Uploaden met meerdere onderdelen (bestand + optionele beschrijving). Max. 50 MB.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
File
|
file | True | file |
File |
|
Description
|
description | string |
Description |
Retouren
- Body
- DocumentDetailDto
Een document verwijderen (deactiveren)
Idempotent : retourneert 204, zelfs als het document al is verwijderd of ontbreekt
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
Een expert een vraag stellen
Synchrone wrapper rond de streaming AI-chat. Retourneert het samengestelde antwoord.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
vraag
|
question | True | string |
Retouren
- Body
- AskResponse
Een expert krijgen
Retourneert deskundige metagegevens, gekoppelde documenten en toegewezen rollen/afdelingen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
Retouren
- Body
- ExpertDetailDto
Een gebruiker bijwerken
Werk firstName, lastName, isAdmin en roltoewijzingen bij. E-mail kan niet worden bewerkt in v1.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
firstName
|
firstName | string | ||
|
lastName
|
lastName | string | ||
|
isAdmin
|
isAdmin | boolean | ||
|
departmentRoleIds
|
departmentRoleIds | array of uuid |
Retouren
- Body
- UserDto
Een gebruiker deactiveren
Idempotent — retourneert de gebruiker zelfs als deze al is gedeactiveerd
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
Retouren
- Body
- UserDto
Een gebruiker maken
Hiermee maakt u een gebruiker en activeert u de magic-link-uitnodigingsstroom
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
email
|
True | |||
|
firstName
|
firstName | string | ||
|
lastName
|
lastName | string | ||
|
isAdmin
|
isAdmin | boolean | ||
|
departmentRoleIds
|
departmentRoleIds | array of uuid |
Retouren
- Body
- UserDto
Een gebruiker ophalen
Retourneert gebruikersmetagegevens en afdelings-/roltoewijzingen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
Retouren
- Body
- UserDto
Een gebruiker opnieuw activeren
Idempotent — retourneert de gebruiker zelfs als deze al actief is
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
Retouren
- Body
- UserDto
Een gebruiker toewijzen aan een rol
Idempotent (onveranderlijk bij herhaald gebruik)
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
Rol-id
|
roleId | True | uuid |
Rol-id |
|
userId
|
userId | True | uuid |
Retouren
- Body
- DepartmentDto
Een gebruiker uit een rol intrekken
Idempotent — 204 zelfs als er niet aan is toegewezen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
Rol-id
|
roleId | True | uuid |
Rol-id |
|
Gebruikersnaam
|
userId | True | uuid |
Gebruikersnaam |
Een ILE_TEXT oefening toevoegen aan een onderwerp
Hiermee maakt u een nieuwe ILE_TEXT oefening in het opgegeven onderwerp.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Onderwerp-id
|
topicId | True | uuid |
Onderwerp-id |
|
Prompt
|
prompt | string |
Retouren
- Body
- ExerciseDto
Een in-lesson-vraag bijwerken
Geef velden op die overeenkomen met het opgeslagen type; niet-gerelateerde velden worden genegeerd
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Les-id
|
lessonId | True | uuid |
Les-id |
|
Vraag-id
|
questionId | True | uuid |
Vraag-id |
|
tekst
|
text | string | ||
|
tekst
|
text | True | string | |
|
isCorrectie
|
isCorrect | boolean | ||
|
expectedAnswer
|
expectedAnswer | string |
Retouren
- Body
- QuestionDto
Een in-lesson-vraag toevoegen
type moet zijn MULTIPLE_CHOICE (vereist opties) of OPEN_ENDED
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Les-id
|
lessonId | True | uuid |
Les-id |
|
type
|
type | True | string | |
|
tekst
|
text | True | string | |
|
rangnummer
|
ordinalNumber | integer | ||
|
tekst
|
text | True | string | |
|
isCorrectie
|
isCorrect | boolean | ||
|
expectedAnswer
|
expectedAnswer | string |
Retouren
- Body
- QuestionDto
Een in-lesson-vraag verwijderen
Idempotent — 204 zelfs als deze al is verwijderd
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Les-id
|
lessonId | True | uuid |
Les-id |
|
Vraag-id
|
questionId | True | uuid |
Vraag-id |
Een learning-byte verwijderen (voorlopig)
Idempotent — 204 zelfs als deze al is verwijderd
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Lb-id
|
lbId | True | uuid |
Lb-id |
Een leer-byte krijgen
Hiermee worden metagegevens en geneste lessen geretourneerd
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Lb-id
|
lbId | True | uuid |
Lb-id |
Retouren
Een leer byte toevoegen aan een onderwerp
Hiermee maakt u een nieuwe learning-byte binnen het opgegeven onderwerp.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Onderwerp-id
|
topicId | True | uuid |
Onderwerp-id |
|
naam
|
name | True | string | |
|
beschrijving
|
description | string |
Retouren
Een lege cursus maken
Hiermee maakt u een nieuwe cursusshell met de opgegeven naam
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
naam
|
name | True | string |
Retouren
- Body
- CourseDetailDto
Een les krijgen
Retourneert lesinhoud, media en in-lesson vragen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Les-id
|
lessonId | True | uuid |
Les-id |
Retouren
- Body
- LessonDetailDto
Een les toevoegen aan een leer byte
Hiermee maakt u een nieuwe les in de opgegeven learning-byte.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Lb-id
|
lbId | True | uuid |
Lb-id |
|
inhoud
|
content | True | string |
Retouren
- Body
- LessonDetailDto
Een les verwijderen (voorlopig)
Idempotent — 204 zelfs als deze al is verwijderd
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Les-id
|
lessonId | True | uuid |
Les-id |
Een media-item ophalen
Hiermee worden mediametagegevens en een kortstondige download-URL geretourneerd
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
Retouren
- Body
- MediaDetailDto
Een media-item uploaden
Uploaden met meerdere onderdelen (bestand + optionele beschrijving). Maximaal 50 MB voor afbeeldingen, 500 MB voor video's.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
File
|
file | True | file |
File |
|
Description
|
description | string |
Description |
Retouren
- Body
- MediaDetailDto
Een media-item verwijderen (deactiveren)
Idempotent : retourneert 204, zelfs als het item al is verwijderd of ontbreekt
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
Een module ophalen
Retourneert moduledetails voor de opgegeven id.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Module-id
|
moduleId | True | uuid |
Module-id |
Retouren
- Body
- ModuleDetailDto
Een module toevoegen aan een cursus
Hiermee maakt u een nieuwe module in de opgegeven cursus.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Cursus-id
|
courseId | True | uuid |
Cursus-id |
|
naam
|
name | True | string | |
|
beschrijving
|
description | string |
Retouren
- Body
- ModuleDetailDto
Een module verwijderen (voorlopig)
Idempotent : retourneert 204, zelfs als de module al is verwijderd
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Module-id
|
moduleId | True | uuid |
Module-id |
Een momentopname van een cursusversie ophalen
Retourneert de volledige inhoudsstructuur (modules, onderwerpen, lessen, oefeningen, vragen) voor de opgegeven versie
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Cursus-id
|
courseId | True | uuid |
Cursus-id |
|
Versienummer
|
versionNumber | True | integer |
Versienummer |
Retouren
Een oefening bijwerken
Typebewust: ILE_TEXT gebruikt alleen prompt + generatedContent.scenario; RPE_* gebruikt alle RPE-velden. Weggelaten velden behouden de huidige waarden.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
Prompt
|
prompt | string | ||
|
avatarPictureId
|
avatarPictureId | uuid | ||
|
avatarCharacteristics
|
avatarCharacteristics | string | ||
|
reverseRolePlayEnabled
|
reverseRolePlayEnabled | boolean | ||
|
reverseRolePlayMandatory
|
reverseRolePlayMandatory | boolean | ||
|
situatie
|
scenario | string | ||
|
traineeRole
|
traineeRole | string | ||
|
avatarName
|
avatarName | string | ||
|
avatarDescription
|
avatarDescription | string | ||
|
operationalChallenge
|
operationalChallenge | string | ||
|
successMetric
|
successMetric | string |
Retouren
- Body
- ExerciseDto
Een oefening ophalen
Retourneert oefeningsgegevens voor de opgegeven id.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
Retouren
- Body
- ExerciseDto
Een oefening verwijderen
Idempotent — 204 zelfs als deze al is verwijderd
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
Een onderwerp ophalen
Retourneert onderwerpdetails voor de opgegeven id.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Onderwerp-id
|
topicId | True | uuid |
Onderwerp-id |
Retouren
- Body
- TopicDto
Een onderwerp toevoegen aan een module
Hiermee maakt u een nieuw onderwerp in de opgegeven module.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Module-id
|
moduleId | True | uuid |
Module-id |
|
naam
|
name | True | string | |
|
beschrijving
|
description | string |
Retouren
- Body
- TopicDto
Een onderwerp verplaatsen naar een andere module
targetOrdinalNumber is optioneel; als u het onderwerp weglaat, wordt toegevoegd aan de doelmodule
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Onderwerp-id
|
topicId | True | uuid |
Onderwerp-id |
|
targetModuleId
|
targetModuleId | True | uuid | |
|
targetOrdinalNumber
|
targetOrdinalNumber | integer |
Retouren
- Body
- TopicDto
Een onderwerp verwijderen (voorlopig)
Idempotent : retourneert 204, zelfs als het onderwerp al is verwijderd
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Onderwerp-id
|
topicId | True | uuid |
Onderwerp-id |
Een rol binnen een afdeling maken
Hiermee maakt u een nieuwe rol binnen het bereik van de opgegeven afdeling.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
naam
|
name | True | string | |
|
volledige naam
|
fullName | string | ||
|
beschrijving
|
description | string |
Retouren
- Body
- DepartmentDto
Een RPE_VIDEO oefening toevoegen aan een onderwerp
Hiermee maakt u een nieuwe RPE_VIDEO rolspeloefening in het opgegeven onderwerp.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Onderwerp-id
|
topicId | True | uuid |
Onderwerp-id |
|
Prompt
|
prompt | string | ||
|
avatarPictureId
|
avatarPictureId | uuid | ||
|
avatarCharacteristics
|
avatarCharacteristics | string | ||
|
reverseRolePlayEnabled
|
reverseRolePlayEnabled | boolean | ||
|
reverseRolePlayMandatory
|
reverseRolePlayMandatory | boolean |
Retouren
- Body
- ExerciseDto
Een RPE_VOICE oefening toevoegen aan een onderwerp
Hiermee maakt u een nieuwe RPE_VOICE rolspeloefening in het opgegeven onderwerp.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Onderwerp-id
|
topicId | True | uuid |
Onderwerp-id |
|
Prompt
|
prompt | string | ||
|
avatarPictureId
|
avatarPictureId | uuid | ||
|
avatarCharacteristics
|
avatarCharacteristics | string | ||
|
reverseRolePlayEnabled
|
reverseRolePlayEnabled | boolean | ||
|
reverseRolePlayMandatory
|
reverseRolePlayMandatory | boolean |
Retouren
- Body
- ExerciseDto
Een specifiek item opnieuw genereren via AI
Hiermee wordt één les, lesvragen, toets, inleiding of oefening opnieuw gegenereerd
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
target
|
target | True | string | |
|
targetId
|
targetId | True | uuid | |
|
bovenliggend type
|
parentType | string |
Retouren
Een toetsvraag in een module verwijderen
Idempotent — 204 zelfs als deze al is verwijderd
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Module-id
|
moduleId | True | uuid |
Module-id |
|
Vraag-id
|
questionId | True | uuid |
Vraag-id |
Een toetsvraag over een module ophalen
Hiermee wordt één toetsvraag geretourneerd die is gekoppeld aan de opgegeven module.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Module-id
|
moduleId | True | uuid |
Module-id |
|
Vraag-id
|
questionId | True | uuid |
Vraag-id |
Retouren
- Body
- QuestionDto
Een toetsvraag over een onderwerp ophalen
Hiermee wordt één toetsvraag geretourneerd die is gekoppeld aan het opgegeven onderwerp.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Onderwerp-id
|
topicId | True | uuid |
Onderwerp-id |
|
Vraag-id
|
questionId | True | uuid |
Vraag-id |
Retouren
- Body
- QuestionDto
Een toetsvraag toevoegen aan een module
Hiermee maakt u een nieuwe toetsvraag in de opgegeven module.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Module-id
|
moduleId | True | uuid |
Module-id |
|
type
|
type | True | string | |
|
tekst
|
text | True | string | |
|
rangnummer
|
ordinalNumber | integer | ||
|
tekst
|
text | True | string | |
|
isCorrectie
|
isCorrect | boolean | ||
|
expectedAnswer
|
expectedAnswer | string |
Retouren
- Body
- QuestionDto
Een toetsvraag toevoegen aan een onderwerp
Hiermee maakt u een nieuwe toetsvraag in het opgegeven onderwerp.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Onderwerp-id
|
topicId | True | uuid |
Onderwerp-id |
|
type
|
type | True | string | |
|
tekst
|
text | True | string | |
|
rangnummer
|
ordinalNumber | integer | ||
|
tekst
|
text | True | string | |
|
isCorrectie
|
isCorrect | boolean | ||
|
expectedAnswer
|
expectedAnswer | string |
Retouren
- Body
- QuestionDto
Een toetsvraag voor een onderwerp verwijderen
Idempotent — 204 zelfs als deze al is verwijderd
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Onderwerp-id
|
topicId | True | uuid |
Onderwerp-id |
|
Vraag-id
|
questionId | True | uuid |
Vraag-id |
Een volledige cursus genereren met AI-inhoud
Hiermee maakt u de cursusshell, alle modules, alle onderwerpen en enqueues ai-inhoud genereren voor elk onderwerp
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
naam
|
name | True | string | |
|
beschrijving
|
description | string | ||
|
naam
|
name | True | string | |
|
beschrijving
|
description | string | ||
|
naam
|
name | True | string | |
|
beschrijving
|
description | string |
Retouren
Een vraag in de les krijgen
Retourneert één in-lesson-vraag op basis van de id.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Les-id
|
lessonId | True | uuid |
Les-id |
|
Vraag-id
|
questionId | True | uuid |
Vraag-id |
Retouren
- Body
- QuestionDto
Eén document loskoppelen van een onderwerp
Idempotent (onveranderlijk bij herhaald gebruik)
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Onderwerp-id
|
topicId | True | uuid |
Onderwerp-id |
|
Document-id
|
documentId | True | uuid |
Document-id |
Eén quizvraag bijwerken in een module
Geef velden op die overeenkomen met het opgeslagen type; niet-gerelateerde velden worden genegeerd.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Module-id
|
moduleId | True | uuid |
Module-id |
|
Vraag-id
|
questionId | True | uuid |
Vraag-id |
|
tekst
|
text | string | ||
|
tekst
|
text | True | string | |
|
isCorrectie
|
isCorrect | boolean | ||
|
expectedAnswer
|
expectedAnswer | string |
Retouren
- Body
- QuestionDto
Eén quizvraag bijwerken voor een onderwerp
Geef velden op die overeenkomen met het opgeslagen type; niet-gerelateerde velden worden genegeerd.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Onderwerp-id
|
topicId | True | uuid |
Onderwerp-id |
|
Vraag-id
|
questionId | True | uuid |
Vraag-id |
|
tekst
|
text | string | ||
|
tekst
|
text | True | string | |
|
isCorrectie
|
isCorrect | boolean | ||
|
expectedAnswer
|
expectedAnswer | string |
Retouren
- Body
- QuestionDto
Eén roltoewijzing uit een cursus verwijderen
Idempotent (onveranderlijk bij herhaald gebruik)
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
Rol-id
|
roleId | True | uuid |
Rol-id |
Eén roltoewijzing van een expert verwijderen
Idempotent (onveranderlijk bij herhaald gebruik)
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
Rol-id
|
roleId | True | uuid |
Rol-id |
Gebruikers weergeven
Gepagineerde lijst met gebruikers in het bedrijf van de beller
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Pagina
|
page | integer |
Pagina |
|
|
Grootte
|
size | integer |
Grootte |
|
|
Search
|
search | string |
Search |
|
|
Status
|
status | string |
Status |
|
|
Afdelings-id's
|
departmentIds | string |
Afdelings-id's |
|
|
Rol-id's
|
roleIds | string |
Rol-id's |
|
|
Kind
|
kind | string |
Kind |
Retouren
- Body
- UserListResponse
Het aantal modulequiz instellen voor één vraagtype
Vervangt het aantal voor het opgegeven questionType (MULTIPLE_CHOICE of OPEN_ENDED). Het aantal andere typen blijft behouden
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Module-id
|
moduleId | True | uuid |
Module-id |
|
questionType
|
questionType | True | string | |
|
aantal
|
count | integer |
Retouren
- Body
- ModuleDetailDto
In-lesvragen opnieuw ordenen
questionIds moeten elke actieve vraag voor de les bevatten, in de nieuwe volgorde
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Les-id
|
lessonId | True | uuid |
Les-id |
|
questionIds
|
questionIds | True | array of uuid |
Retouren
- Body
- QuestionListResponse
In-lesvragen weergeven
Retourneert kennistoetsvragen die zijn gekoppeld aan de gegeven les.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Les-id
|
lessonId | True | uuid |
Les-id |
Retouren
- Body
- QuestionListResponse
Inleiding tot een module ophalen
Retourneert de introtekst die is ingesteld voor de opgegeven module.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Module-id
|
moduleId | True | uuid |
Module-id |
Retouren
- Body
- IntroDto
Inleiding tot een module verwijderen
Idempotent — 204 zelfs als er geen intro is ingesteld
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Module-id
|
moduleId | True | uuid |
Module-id |
Inleiding tot een onderwerp instellen of vervangen
Upsert : wordt gemaakt als deze ontbreekt, vervangt indien aanwezig
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Onderwerp-id
|
topicId | True | uuid |
Onderwerp-id |
|
Introductie
|
introduction | string |
Retouren
- Body
- IntroDto
Inleiding tot een onderwerp ophalen
Retourneert de introtekst die is ingesteld voor het opgegeven onderwerp.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Onderwerp-id
|
topicId | True | uuid |
Onderwerp-id |
Retouren
- Body
- IntroDto
Inleiding tot een onderwerp verwijderen
Idempotent — 204 zelfs als er geen intro is ingesteld
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Onderwerp-id
|
topicId | True | uuid |
Onderwerp-id |
Inleiding tot het instellen of vervangen van een module
Upsert : wordt gemaakt als deze ontbreekt, vervangt indien aanwezig
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Module-id
|
moduleId | True | uuid |
Module-id |
|
Introductie
|
introduction | string |
Retouren
- Body
- IntroDto
Inzichten op bedrijfsniveau
Inzichten per leerling/student
Geaggregeerde samenvatting en uitsplitsing per cursus voor het opgegeven venster
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Gebruikersnaam
|
userId | True | uuid |
Gebruikersnaam |
|
Window
|
window | string |
Window |
Retouren
- Body
- StudentInsightsDto
Leerbytes weergeven in een onderwerp
Retourneert leerbytes die deel uitmaken van het opgegeven onderwerp.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Onderwerp-id
|
topicId | True | uuid |
Onderwerp-id |
Retouren
Lesinhoud bijwerken
Als u inhoud weglaat, blijft de huidige waarde behouden
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Les-id
|
lessonId | True | uuid |
Les-id |
|
inhoud
|
content | string |
Retouren
- Body
- LessonDetailDto
Lessen in een leer byte vermelden
Retourneert lessen die deel uitmaken van de gegeven leer byte.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Lb-id
|
lbId | True | uuid |
Lb-id |
Retouren
- Body
- LessonListResponse
Lijstexperts
Gepagineerde lijst met experts in het bedrijf van de beller
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Pagina
|
page | integer |
Pagina |
|
|
Grootte
|
size | integer |
Grootte |
|
|
Search
|
search | string |
Search |
Retouren
- Body
- ExpertListResponse
Media binair vervangen
Vervangt het binaire bestand van een bestaand media-item; metagegevens blijven behouden
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
File
|
file | True | file |
File |
Retouren
- Body
- MediaDetailDto
Media vermelden
Gepagineerde lijst met media-items in het bedrijf van de beller
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Pagina
|
page | integer |
Pagina |
|
|
Grootte
|
size | integer |
Grootte |
|
|
Search
|
search | string |
Search |
|
|
Kind
|
kind | string |
Kind |
|
|
Status
|
status | string |
Status |
Retouren
- Body
- MediaListResponse
Metagegevens van media bijwerken
Naam en/of beschrijving bijwerken
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
naam
|
name | string | ||
|
beschrijving
|
description | string |
Retouren
- Body
- MediaDetailDto
Metagegevens van module bijwerken
Hiermee werkt u de naam en/of beschrijving bij. Weggelaten velden behouden huidige waarden
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Module-id
|
moduleId | True | uuid |
Module-id |
|
naam
|
name | string | ||
|
beschrijving
|
description | string |
Retouren
- Body
- ModuleDetailDto
Metagegevens van onderwerp bijwerken
Hiermee werkt u de naam en/of beschrijving bij. Weggelaten velden behouden huidige waarden
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Onderwerp-id
|
topicId | True | uuid |
Onderwerp-id |
|
naam
|
name | string | ||
|
beschrijving
|
description | string |
Retouren
- Body
- TopicDto
Modules in een cursus opnieuw ordenen
moduleIds moeten elke actieve module precies één keer bevatten, in de nieuwe volgorde
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Cursus-id
|
courseId | True | uuid |
Cursus-id |
|
moduleIds
|
moduleIds | True | array of uuid |
Retouren
- Body
- ModuleListResponse
Modules in een cursus vermelden
Retourneert actieve modules geordend op ordinaalNumber
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Cursus-id
|
courseId | True | uuid |
Cursus-id |
Retouren
- Body
- ModuleListResponse
Oefeningen in een onderwerp weergeven
Gemengde typen (ILE_TEXT / RPE_VOICE / RPE_VIDEO) gesorteerd op ordinaalNumber
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Onderwerp-id
|
topicId | True | uuid |
Onderwerp-id |
Retouren
- Body
- ExerciseListResponse
Onderwerpen in een module opnieuw ordenen
topicIds moeten elk actief onderwerp precies één keer bevatten, in de nieuwe volgorde
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Module-id
|
moduleId | True | uuid |
Module-id |
|
topicIds
|
topicIds | True | array of uuid |
Retouren
- Body
- TopicListResponse
Onderwerpen in een module vermelden
Retourneert actieve onderwerpen geordend op ordinaalNumber
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Module-id
|
moduleId | True | uuid |
Module-id |
Retouren
- Body
- TopicListResponse
PDF-certificaat downloaden
Hiermee wordt het pdf-bestand van het certificaat gestreamd. Retourneert 404 als het certificaat nog geen PDF heeft
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
Retouren
- response
- StreamingResponseBody
Quizvragen over een onderwerp weergeven
Hiermee worden toetsvragen geretourneerd die zijn gekoppeld aan het opgegeven onderwerp.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Onderwerp-id
|
topicId | True | uuid |
Onderwerp-id |
Retouren
- Body
- QuestionListResponse
Rollen toewijzen aan een cursus
Additief: rollen die al zijn toegewezen, worden overgeslagen. Retourneert de bijgewerkte cursusdetails
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
roleIds
|
roleIds | True | array of uuid |
Retouren
- Body
- CourseDetailDto
Rollen toewijzen aan een expert
Additief — reeds toegewezen rollen worden bewaard; nieuwe toegevoegd. Retourneert bijgewerkte expert
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
roleIds
|
roleIds | True | array of uuid |
Retouren
- Body
- ExpertDetailDto
Status van AI-generatie voor een cursus ophalen
Retourneert de lijst met actieve AI-generatieaanvragen voor de cursus met voortgang en doelgegevens
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
Retouren
Toetsvragen over een onderwerp opnieuw ordenen
questionIds moeten elke actieve toetsvraag voor het onderwerp bevatten, in de nieuwe volgorde.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Onderwerp-id
|
topicId | True | uuid |
Onderwerp-id |
|
questionIds
|
questionIds | True | array of uuid |
Retouren
- Body
- QuestionListResponse
Toetsvragen voor een module opnieuw ordenen
questionIds moeten elke actieve toetsvraag voor de module bevatten, in de nieuwe volgorde.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Module-id
|
moduleId | True | uuid |
Module-id |
|
questionIds
|
questionIds | True | array of uuid |
Retouren
- Body
- QuestionListResponse
Toetsvragen weergeven in een module
Hiermee worden toetsvragen geretourneerd die zijn gekoppeld aan de opgegeven module.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Module-id
|
moduleId | True | uuid |
Module-id |
Retouren
- Body
- QuestionListResponse
Videoverwerking opnieuw uitvoeren
Verzendt de video opnieuw voor AI-segmentatie. U kunt eventueel de verwerkingsprompt overschrijven.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
processingPrompt
|
processingPrompt | string |
Retouren
- Body
- DemoTrainingDto
Definities
QuizSettingDto
| Name | Pad | Type | Description |
|---|---|---|---|
|
questionType
|
questionType | string | |
|
aantal
|
count | integer |
TopicDto
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
moduleId
|
moduleId | uuid | |
|
naam
|
name | string | |
|
beschrijving
|
description | string | |
|
rangnummer
|
ordinalNumber | integer | |
|
hasContent
|
hasContent | boolean | |
|
quizSettings
|
quizSettings | array of QuizSettingDto |
Inleiding tot
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
component-ID
|
componentId | uuid | |
|
componentType
|
componentType | string | |
|
Introductie
|
introduction | string | |
|
source
|
source | string | |
|
createdAt
|
createdAt | date-time | |
|
updatedAt
|
updatedAt | date-time |
ModuleDetailDto
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
courseId
|
courseId | uuid | |
|
naam
|
name | string | |
|
beschrijving
|
description | string | |
|
productId
|
productId | uuid | |
|
rangnummer
|
ordinalNumber | integer | |
|
lockedForGeneration
|
lockedForGeneration | boolean | |
|
quizSettings
|
quizSettings | array of QuizSettingDto | |
|
topics
|
topics | array of TopicDto |
MediaDetailDto
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
naam
|
name | string | |
|
beschrijving
|
description | string | |
|
vriendelijk
|
kind | string | |
|
Mimetype
|
mimeType | string | |
|
groottebytes
|
sizeBytes | integer | |
|
status
|
status | string | |
|
processingStatus
|
processingStatus | string | |
|
createdAt
|
createdAt | date-time | |
|
uploadedBy
|
uploadedBy | UploadedByDto | |
|
downloadUrl
|
downloadUrl | string |
UploadedByDto
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
vriendelijk
|
kind | string | |
|
naam
|
name | string |
DocumentDetailDto
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
naam
|
name | string | |
|
beschrijving
|
description | string | |
|
Mimetype
|
mimeType | string | |
|
groottebytes
|
sizeBytes | integer | |
|
status
|
status | string | |
|
createdAt
|
createdAt | date-time | |
|
uploadedBy
|
uploadedBy | UploadedByDto | |
|
downloadUrl
|
downloadUrl | string |
DepartmentRoleDto
| Name | Pad | Type | Description |
|---|---|---|---|
|
departmentId
|
departmentId | uuid | |
|
departmentName
|
departmentName | string | |
|
rol-ID
|
roleId | uuid | |
|
rolNaam
|
roleName | string |
UserDto
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
email
|
string | ||
|
firstName
|
firstName | string | |
|
lastName
|
lastName | string | |
|
status
|
status | string | |
|
vriendelijk
|
kind | string | |
|
isAdmin
|
isAdmin | boolean | |
|
createdAt
|
createdAt | date-time | |
|
departmentRoles
|
departmentRoles | array of DepartmentRoleDto |
Vraagdto
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
type
|
type | string | |
|
ouder-ID
|
parentId | uuid | |
|
bovenliggend type
|
parentType | string | |
|
tekst
|
text | string | |
|
rangnummer
|
ordinalNumber | integer | |
|
source
|
source | string | |
|
expectedAnswer
|
expectedAnswer | string | |
|
options
|
options | array of QuestionOptionDto | |
|
createdAt
|
createdAt | date-time | |
|
updatedAt
|
updatedAt | date-time |
QuestionOptionDto
| Name | Pad | Type | Description |
|---|---|---|---|
|
tekst
|
text | string | |
|
isCorrectie
|
isCorrect | boolean | |
|
rangnummer
|
ordinalNumber | integer |
QuestionListResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
items
|
items | array of QuestionDto |
LearningByteDetailDto
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
topicId
|
topicId | uuid | |
|
naam
|
name | string | |
|
beschrijving
|
description | string | |
|
rangnummer
|
ordinalNumber | integer | |
|
source
|
source | string | |
|
createdAt
|
createdAt | date-time | |
|
updatedAt
|
updatedAt | date-time | |
|
lessen
|
lessons | array of LessonDto |
LesDto
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
learningByteId
|
learningByteId | uuid | |
|
inhoud
|
content | string | |
|
rangnummer
|
ordinalNumber | integer | |
|
source
|
source | string | |
|
questionCount
|
questionCount | integer | |
|
mediaCount
|
mediaCount | integer | |
|
createdAt
|
createdAt | date-time | |
|
updatedAt
|
updatedAt | date-time |
Oefening:
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
topicId
|
topicId | uuid | |
|
type
|
type | string | |
|
Prompt
|
prompt | string | |
|
rangnummer
|
ordinalNumber | integer | |
|
source
|
source | string | |
|
isGenerated
|
isGenerated | boolean | |
|
avatarPictureId
|
avatarPictureId | uuid | |
|
avatarCharacteristics
|
avatarCharacteristics | string | |
|
reverseRolePlayEnabled
|
reverseRolePlayEnabled | boolean | |
|
reverseRolePlayMandatory
|
reverseRolePlayMandatory | boolean | |
|
generatedContent
|
generatedContent | ExerciseGeneratedContentDto | |
|
createdAt
|
createdAt | date-time | |
|
updatedAt
|
updatedAt | date-time |
ExerciseGeneratedContentDto
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
regeneratieId
|
regenerationId | uuid | |
|
situatie
|
scenario | string | |
|
traineeRole
|
traineeRole | string | |
|
avatarName
|
avatarName | string | |
|
avatarDescription
|
avatarDescription | string | |
|
operationalChallenge
|
operationalChallenge | string | |
|
successMetric
|
successMetric | string | |
|
instructie
|
instruction | string | |
|
instructionReverse
|
instructionReverse | string | |
|
oefeningKnowledgeBase
|
exerciseKnowledgeBase | string | |
|
topicKnowledgeBase
|
topicKnowledgeBase | string |
TopicListResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
items
|
items | array of TopicDto |
LessonDetailDto
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
learningByteId
|
learningByteId | uuid | |
|
inhoud
|
content | string | |
|
rangnummer
|
ordinalNumber | integer | |
|
source
|
source | string | |
|
createdAt
|
createdAt | date-time | |
|
updatedAt
|
updatedAt | date-time | |
|
media
|
media | array of MediaLinkDto | |
|
Vragen
|
questions | array of QuestionDto |
MediaLinkDto
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
fileId
|
fileId | uuid | |
|
rangnummer
|
ordinalNumber | integer | |
|
source
|
source | string |
ExpertDetailDto
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
naam
|
name | string | |
|
beschrijving
|
description | string | |
|
status
|
status | string | |
|
linkedDocumentCount
|
linkedDocumentCount | integer | |
|
createdAt
|
createdAt | date-time | |
|
updatedAt
|
updatedAt | date-time | |
|
assignedRoleIds
|
assignedRoleIds | array of uuid | |
|
assignedDepartmentIds
|
assignedDepartmentIds | array of uuid | |
|
linkedDocuments
|
linkedDocuments | array of LinkedDocumentDto |
LinkedDocumentDto
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
naam
|
name | string | |
|
uitbreiding
|
extension | string | |
|
groottebytes
|
sizeBytes | integer | |
|
beschrijving
|
description | string | |
|
linkedAt
|
linkedAt | date-time |
AskResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
antwoord
|
answer | string | |
|
durationMs
|
durationMs | integer |
DepartmentDto
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
naam
|
name | string | |
|
beschrijving
|
description | string | |
|
status
|
status | string | |
|
createdAt
|
createdAt | date-time | |
|
roles
|
roles | array of DepartmentRoleDto |
DemoTrainingDto
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
companyId
|
companyId | uuid | |
|
departmentId
|
departmentId | uuid | |
|
naam
|
name | string | |
|
beschrijving
|
description | string | |
|
trainingType
|
trainingType | string | |
|
status
|
status | string | |
|
isBeschikbaar
|
isAvailable | boolean | |
|
videoFileId
|
videoFileId | uuid | |
|
processingPrompt
|
processingPrompt | string | |
|
errorMessage
|
errorMessage | string | |
|
assignedRoleIds
|
assignedRoleIds | array of uuid | |
|
segments
|
segments | array of DemoTrainingSegmentDto | |
|
createdAt
|
createdAt | date-time | |
|
updatedAt
|
updatedAt | date-time |
DemoTrainingSegmentDto
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
rangnummer
|
ordinalNumber | integer | |
|
naam
|
name | string | |
|
transcript
|
transcript | string | |
|
duurSeconden
|
durationSeconds | integer |
CourseDetailDto
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
naam
|
name | string | |
|
status
|
status | string | |
|
moduleCount
|
moduleCount | integer | |
|
topicCount
|
topicCount | integer | |
|
hasUnpublishedChanges
|
hasUnpublishedChanges | boolean | |
|
currentVersionNumber
|
currentVersionNumber | integer | |
|
createdAt
|
createdAt | date-time | |
|
updatedAt
|
updatedAt | date-time | |
|
assignedRoleIds
|
assignedRoleIds | array of uuid | |
|
assignedDepartmentIds
|
assignedDepartmentIds | array of uuid | |
|
modules
|
modules | array of ModuleSummaryDto |
ModuleSummaryDto
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
naam
|
name | string | |
|
rangnummer
|
ordinalNumber | integer | |
|
topicCount
|
topicCount | integer |
GenerationRequestResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
status
|
status | string |
ModuleDto
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
courseId
|
courseId | uuid | |
|
naam
|
name | string | |
|
beschrijving
|
description | string | |
|
productId
|
productId | uuid | |
|
rangnummer
|
ordinalNumber | integer | |
|
lockedForGeneration
|
lockedForGeneration | boolean | |
|
topicCount
|
topicCount | integer | |
|
quizSettings
|
quizSettings | array of QuizSettingDto |
ModuleListResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
items
|
items | array of ModuleDto |
GenerateCourseResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
courseId
|
courseId | uuid | |
|
generationRequestId
|
generationRequestId | uuid |
PageInfo
| Name | Pad | Type | Description |
|---|---|---|---|
|
size
|
size | integer | |
|
nummer
|
number | integer | |
|
totalElements
|
totalElements | integer | |
|
totalPages
|
totalPages | integer |
UserListResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
items
|
items | array of UserDto | |
|
bladzijde
|
page | PageInfo |
TopicLinkedDocumentDto
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
naam
|
name | string | |
|
uitbreiding
|
extension | string | |
|
size
|
size | integer | |
|
processingStatus
|
processingStatus | string | |
|
beschrijving
|
description | string | |
|
source
|
source | string | |
|
linkType
|
linkType | string | |
|
linkedAt
|
linkedAt | date-time |
TopicLinkedDocumentListResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
items
|
items | array of TopicLinkedDocumentDto | |
|
bladzijde
|
page | PageInfo |
LearningByteDto
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
topicId
|
topicId | uuid | |
|
naam
|
name | string | |
|
beschrijving
|
description | string | |
|
rangnummer
|
ordinalNumber | integer | |
|
source
|
source | string | |
|
lessonCount
|
lessonCount | integer | |
|
createdAt
|
createdAt | date-time | |
|
updatedAt
|
updatedAt | date-time |
LearningByteListResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
items
|
items | array of LearningByteDto |
ExerciseListResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
items
|
items | array of ExerciseDto |
CertificateDto
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
inschrijvings-ID
|
enrollmentId | uuid | |
|
studentId
|
studentId | uuid | |
|
companyId
|
companyId | uuid | |
|
courseId
|
courseId | uuid | |
|
courseVersionId
|
courseVersionId | uuid | |
|
studentName
|
studentName | string | |
|
companyName
|
companyName | string | |
|
courseName
|
courseName | string | |
|
serialNumber
|
serialNumber | string | |
|
completedAt
|
completedAt | date-time | |
|
uitgegeven op
|
issuedAt | date-time | |
|
pdfFileId
|
pdfFileId | uuid | |
|
pdfAvailable
|
pdfAvailable | boolean |
CertificateListResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
items
|
items | array of CertificateDto |
MediaDto
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
naam
|
name | string | |
|
beschrijving
|
description | string | |
|
vriendelijk
|
kind | string | |
|
Mimetype
|
mimeType | string | |
|
groottebytes
|
sizeBytes | integer | |
|
status
|
status | string | |
|
processingStatus
|
processingStatus | string | |
|
createdAt
|
createdAt | date-time | |
|
uploadedBy
|
uploadedBy | UploadedByDto |
MediaListResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
items
|
items | array of MediaDto | |
|
bladzijde
|
page | PageInfo |
LessonListResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
items
|
items | array of LessonDto |
CourseBreakdownDto
| Name | Pad | Type | Description |
|---|---|---|---|
|
courseId
|
courseId | uuid | |
|
courseName
|
courseName | string | |
|
progressPercent
|
progressPercent | integer | |
|
hoursSpent
|
hoursSpent | double | |
|
startedAt
|
startedAt | date-time | |
|
completedAt
|
completedAt | date-time |
StudentInsightsDto
| Name | Pad | Type | Description |
|---|---|---|---|
|
userId
|
userId | uuid | |
|
venster
|
window | WindowDto | |
|
samenvatting
|
summary | StudentSummaryDto | |
|
per cursus
|
byCourse | array of CourseBreakdownDto |
StudentSummaryDto
| Name | Pad | Type | Description |
|---|---|---|---|
|
activeDays
|
activeDays | integer | |
|
lessonsCompleted
|
lessonsCompleted | integer | |
|
oefeningenCompleted
|
exercisesCompleted | integer | |
|
quizzesPassed
|
quizzesPassed | integer | |
|
hoursSpent
|
hoursSpent | double |
WindowDto
| Name | Pad | Type | Description |
|---|---|---|---|
|
vriendelijk
|
kind | string | |
|
from
|
from | date-time | |
|
naar / te
|
to | date-time |
EventItemDto
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
vriendelijk
|
kind | string | |
|
action
|
action | string | |
|
courseId
|
courseId | uuid | |
|
courseName
|
courseName | string | |
|
opgetredenAt
|
occurredAt | date-time |
EventListResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
items
|
items | array of EventItemDto | |
|
bladzijde
|
page | PageInfo |
CompanyInsightsDto
| Name | Pad | Type | Description |
|---|---|---|---|
|
companyId
|
companyId | uuid | |
|
samenvatting
|
summary | CompanySummaryDto |
CompanySummaryDto
| Name | Pad | Type | Description |
|---|---|---|---|
|
totalStudents
|
totalStudents | integer | |
|
averageProgressPercent
|
averageProgressPercent | integer | |
|
activeThisWeekCount
|
activeThisWeekCount | integer | |
|
completedCount
|
completedCount | integer | |
|
completionRatePercent
|
completionRatePercent | integer |
ExpertDto
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
naam
|
name | string | |
|
beschrijving
|
description | string | |
|
status
|
status | string | |
|
linkedDocumentCount
|
linkedDocumentCount | integer | |
|
createdAt
|
createdAt | date-time | |
|
updatedAt
|
updatedAt | date-time |
ExpertListResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
items
|
items | array of ExpertDto | |
|
bladzijde
|
page | PageInfo |
DocumentDto
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
naam
|
name | string | |
|
beschrijving
|
description | string | |
|
Mimetype
|
mimeType | string | |
|
groottebytes
|
sizeBytes | integer | |
|
status
|
status | string | |
|
createdAt
|
createdAt | date-time | |
|
uploadedBy
|
uploadedBy | UploadedByDto |
DocumentListResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
items
|
items | array of DocumentDto | |
|
bladzijde
|
page | PageInfo |
DepartmentListResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
items
|
items | array of DepartmentDto |
DemoTrainingListItemDto
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
departmentId
|
departmentId | uuid | |
|
videoFileId
|
videoFileId | uuid | |
|
naam
|
name | string | |
|
beschrijving
|
description | string | |
|
trainingType
|
trainingType | string | |
|
status
|
status | string | |
|
isBeschikbaar
|
isAvailable | boolean | |
|
assignedRoleIds
|
assignedRoleIds | array of uuid | |
|
segmentCount
|
segmentCount | integer | |
|
duurSeconden
|
durationSeconds | integer | |
|
createdAt
|
createdAt | date-time |
DemoTrainingListResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
items
|
items | array of DemoTrainingListItemDto | |
|
bladzijde
|
page | PageInfo |
CourseDto
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
naam
|
name | string | |
|
status
|
status | string | |
|
moduleCount
|
moduleCount | integer | |
|
topicCount
|
topicCount | integer | |
|
hasUnpublishedChanges
|
hasUnpublishedChanges | boolean | |
|
currentVersionNumber
|
currentVersionNumber | integer | |
|
latestPublishedAt
|
latestPublishedAt | date-time | |
|
createdAt
|
createdAt | date-time |
CourseListResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
items
|
items | array of CourseDto | |
|
bladzijde
|
page | PageInfo |
GenerationProgressDto
| Name | Pad | Type | Description |
|---|---|---|---|
|
totalTasks
|
totalTasks | integer | |
|
completedTasks
|
completedTasks | integer | |
|
failedTasks
|
failedTasks | integer |
GenerationRequestInfoDto
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
status
|
status | string | |
|
createdAt
|
createdAt | string | |
|
completedAt
|
completedAt | string | |
|
fout
|
error | string | |
|
progress
|
progress | GenerationProgressDto | |
|
target
|
target | string | |
|
targetId
|
targetId | uuid | |
|
bovenliggend type
|
parentType | string | |
|
topicIds
|
topicIds | array of uuid | |
|
moduleIds
|
moduleIds | array of uuid |
GenerationStatusResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
activeRequests
|
activeRequests | array of GenerationRequestInfoDto |
CourseVersionDto
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
courseId
|
courseId | uuid | |
|
versionNumber
|
versionNumber | integer | |
|
publishedAt
|
publishedAt | date-time | |
|
publishedBy
|
publishedBy | uuid | |
|
moduleCount
|
moduleCount | integer | |
|
topicCount
|
topicCount | integer | |
|
lessonCount
|
lessonCount | integer | |
|
exerciseCount
|
exerciseCount | integer | |
|
questionCount
|
questionCount | integer | |
|
estimatedTimeSeconds
|
estimatedTimeSeconds | integer |
CourseVersionListResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
items
|
items | array of CourseVersionDto |
AuditSnapshot
| Name | Pad | Type | Description |
|---|---|---|---|
|
createdAt
|
createdAt | date-time | |
|
gemaakt door
|
createdBy | uuid | |
|
updatedAt
|
updatedAt | date-time | |
|
bijgewerktDoor
|
updatedBy | uuid |
CourseSnapshot
| Name | Pad | Type | Description |
|---|---|---|---|
|
naam
|
name | string | |
|
coverImageId
|
coverImageId | uuid | |
|
prerequisiteCourseId
|
prerequisiteCourseId | uuid | |
|
courseGuideline
|
courseGuideline | string | |
|
lessonsGuideline
|
lessonsGuideline | string | |
|
questionsGuideline
|
questionsGuideline | string | |
|
oefeningenGuideline
|
exercisesGuideline | string | |
|
modules
|
modules | array of ModuleSnapshot |
CourseVersionSnapshotDto
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
courseId
|
courseId | uuid | |
|
versionNumber
|
versionNumber | integer | |
|
momentopname
|
snapshot | CourseSnapshot |
ExerciseSnapshot
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
topicId
|
topicId | uuid | |
|
exerciseType
|
exerciseType | string | |
|
Prompt
|
prompt | string | |
|
rangnummer
|
ordinalNumber | integer | |
|
isGenerated
|
isGenerated | boolean | |
|
source
|
source | string | |
|
audit
|
audit | AuditSnapshot | |
|
avatarCharacteristics
|
avatarCharacteristics | string | |
|
avatarPictureId
|
avatarPictureId | uuid | |
|
reverseRolePlayEnabled
|
reverseRolePlayEnabled | boolean | |
|
reverseRolePlayMandatory
|
reverseRolePlayMandatory | boolean | |
|
situatie
|
scenario | string | |
|
traineeRole
|
traineeRole | string | |
|
avatarName
|
avatarName | string | |
|
avatarDescription
|
avatarDescription | string | |
|
operationalChallenge
|
operationalChallenge | string | |
|
successMetric
|
successMetric | string | |
|
instructie
|
instruction | string | |
|
instructionReverse
|
instructionReverse | string | |
|
oefeningKnowledgeBase
|
exerciseKnowledgeBase | string |
LearningByteSnapshot
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
topicId
|
topicId | uuid | |
|
naam
|
name | string | |
|
beschrijving
|
description | string | |
|
rangnummer
|
ordinalNumber | integer | |
|
source
|
source | string | |
|
audit
|
audit | AuditSnapshot | |
|
lessen
|
lessons | array of LessonSnapshot |
LessonSnapshot
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
learningByteId
|
learningByteId | uuid | |
|
inhoud
|
content | string | |
|
rangnummer
|
ordinalNumber | integer | |
|
source
|
source | string | |
|
audit
|
audit | AuditSnapshot | |
|
media
|
media | array of MediaSnapshot | |
|
Vragen
|
questions | array of QuestionSnapshot |
LinkedDocumentSnapshot
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
fileId
|
fileId | uuid | |
|
linkType
|
linkType | string | |
|
isSupplement
|
isSupplement | boolean | |
|
naam
|
name | string | |
|
uitbreiding
|
extension | string | |
|
size
|
size | integer | |
|
beschrijving
|
description | string |
MediaSnapshot
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
fileId
|
fileId | uuid | |
|
rangnummer
|
ordinalNumber | integer | |
|
mediaType
|
mediaType | string | |
|
source
|
source | string |
ModuleSnapshot
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
courseId
|
courseId | uuid | |
|
productId
|
productId | uuid | |
|
naam
|
name | string | |
|
beschrijving
|
description | string | |
|
inleiding
|
intro | string | |
|
rangnummer
|
ordinalNumber | integer | |
|
quizSettings
|
quizSettings | array of QuizSettingSnapshot | |
|
quizQuestions
|
quizQuestions | array of QuestionSnapshot | |
|
topics
|
topics | array of TopicSnapshot |
OptionSnapshot
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
optionText
|
optionText | string | |
|
isCorrectie
|
isCorrect | boolean | |
|
rangnummer
|
ordinalNumber | integer |
QuestionSnapshot
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
questionType
|
questionType | string | |
|
questionText
|
questionText | string | |
|
expectedAnswer
|
expectedAnswer | string | |
|
rangnummer
|
ordinalNumber | integer | |
|
source
|
source | string | |
|
audit
|
audit | AuditSnapshot | |
|
options
|
options | array of OptionSnapshot |
QuizSettingSnapshot
| Name | Pad | Type | Description |
|---|---|---|---|
|
questionType
|
questionType | string | |
|
aantal
|
count | integer |
TopicSnapshot
| Name | Pad | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
moduleId
|
moduleId | uuid | |
|
naam
|
name | string | |
|
beschrijving
|
description | string | |
|
inleiding
|
intro | string | |
|
rangnummer
|
ordinalNumber | integer | |
|
quizSettings
|
quizSettings | array of QuizSettingSnapshot | |
|
quizQuestions
|
quizQuestions | array of QuestionSnapshot | |
|
learningBytes
|
learningBytes | array of LearningByteSnapshot | |
|
oefeningen
|
exercises | array of ExerciseSnapshot | |
|
linkedDocuments
|
linkedDocuments | array of LinkedDocumentSnapshot | |
|
topicKnowledgeBase
|
topicKnowledgeBase | string |