Tidsdator (förhandsversion)
Time Machine är en AI-baserad företagsinlärningsplattform. Den omvandlar företagsdokument, videor och expertkunskaper till strukturerade kurser med moduler, ämnen, frågesporter och rollspelsövningar och spårar elevernas framsteg. Byggd för HR- och L&D-team som registrerar, tränar och certifierar anställda i stor skala. Anslutningsappen automatiserar hela utbildningslivscykeln: hantera kurser, användare, avdelningar och roller; generera frågesporter från dokument; och läsa slutförandeanalys.
Den här anslutningsappen är tillgänglig i följande produkter och regioner:
| Service | Class | Regioner |
|---|---|---|
| Copilot Studio | Premium | Alla Power Automate regioner förutom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD) |
| Logiska appar | Standard | Alla Logic Apps-regioner utom följande: - Azure Government regioner - Azure kinaregioner - US Department of Defense (DoD) |
| Power Apps | Premium | Alla Power Apps regioner förutom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | Alla Power Automate regioner förutom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Name | Stöd för tidsdator |
| URL | https://timeml.ai |
| Metadata för anslutningsprogram | |
|---|---|
| Publisher | Time Machine AI |
| Webbplats | https://timeml.ai |
| Sekretesspolicy | https://timeml.ai/privacy-policy |
| Kategorier | Produktivitet; AI |
Tidsdator – Power Automate anslutningsapp
Vad är Tidsdator
Time Machine är en AI-baserad organisationsinlärningsplattform som hjälper företag att bygga, driva och kontinuerligt förbättra anpassningsbara inlärningssystem för moderna team. Organisationer använder Time Machine för att omvandla befintlig kunskap, dokument, inspelningar och arbetsflöden till skalbara utbildningsupplevelser som påskyndar registrering, förbättrar personalens beredskap och replikerar expertis som är bäst i organisationen.
Klientadministratörer hanterar användare, utbildningsinnehåll, organisationsresurser och plattformskonfiguration via TIME Machine REST API. Den här anslutningsappen exponerar det offentliga REST-API:et som Power Automate åtgärder, så att du kan automatisera användaretablering, innehållsinmatning, kunskapssynkronisering och livscykelhantering utan att skriva kod.
Förutsättningar
- En aktiv Time Machine-klientorganisation med administratörsåtkomst
- En Time Machine API-nyckel utfärdad från Inställningar → API-nycklar i administratörspanelen (
https://web.timeml.ai). Nyckeln är ett värde som börjar medtm_live_.
Authentication
Varje åtgärd autentiserar Authorization med en API-nyckel i rubriken. När du skapar en anslutning i Power Automate:
-
Fält:
API key -
Värde: klistra in
Bearer tm_live_<your-token>(den fullständiga strängen, inklusive prefixetBeareroch ett blanksteg före token)
Tillgängliga åtgärder
Anslutningsappen speglar det offentliga REST API:et för Time Machine (116 slutpunkter). Åtgärder grupperas efter resurs:
- Kurser – lista/skapa/uppdatera/ta bort/publicera kurser, tilldela roller, generera AI-redigerat innehåll
- Användare – lista/skapa/uppdatera/inaktivera/återaktivera användare
- Dokument – lista/ladda upp/uppdatera/ta bort dokument
- Media – lista/ladda upp/uppdatera/ta bort medieobjekt
- Avdelningar – lista/skapa/uppdatera/ta bort avdelningar, hantera roller, tilldela användare till roller
- Experter – lista/skapa expertprofiler, ställa frågor till experter, tilldela dokument och roller
- Demoträningar – lista/skapa/uppdatera/ta bort demoträningar
- Kursinnehåll – moduler, ämnen, lektioner, övningar, frågesportsfrågor
- Insikter – analys per elev, per kurs och analys på företagsnivå
- Certifikat – lista elevcertifikat, ladda ned certifikat-PDF-filer
Fullständig slutpunktsreferens är tillgänglig på https://api.timeml.ai/api/v1/docs.
Exempelarbetsflöden
- Confluence-versionen → Time Machine: När en versionssida publiceras i Confluence laddar du upp den som ett dokument i time machine så att den flödar in i biblioteket för utbildningsbyte.
- HR-registrering: När en ny personalrad visas i din HRIS skapar du en Time Machine-användare med sina avdelnings- och rolltilldelningar, vilket utlöser inbjudan till magic-link.
- Meddelanden om slutförande av kursen: När en student slutför en kurs skickar du ett PDF-certifikat till Slack och loggar slutförandet till ett Google-blad.
Kända begränsningar
- ROTATION AV API-nyckel: Anslutningar måste uppdateras manuellt när API-nyckeln roteras. Det finns ingen mekanism för automatisk uppdatering.
- Uppladdningar med flera delar: Filuppladdningsåtgärder (ladda upp dokument, ladda upp media) accepterar filer upp till 50 MB. För större media kan du dela upp i flera uppladdningar eller kontakta time machine-supporten.
- Batchåtgärder: API:et körs på en post i taget. För massåtgärder använder du Power Automate inbyggda apply-to-each-kontroll.
Support
Om du har frågor eller problem med anslutningsappen kontaktar du time machine-kontoteamet eller e-postsupporten på support@timeml.ai.
Skapa en anslutning
Anslutningsappen stöder följande autentiseringstyper:
| Standardinställning | Parametrar för att skapa anslutning. | Alla regioner | Går inte att dela |
Standard
Tillämpligt: Alla regioner
Parametrar för att skapa anslutning.
Det här är inte delningsbar anslutning. Om power-appen delas med en annan användare uppmanas en annan användare att skapa en ny anslutning explicit.
| Name | Type | Description | Required |
|---|---|---|---|
| Time Machine API-nyckel (format: Bearer tm_live_...) | securestring | Time Machine API-nyckeln (format: Bearer tm_live_...) för det här API:et | Sann |
Åtgärder
| Aktivitetshändelser per elev |
Sidnumrerad framåtriktad händelseström |
| Ange antal ämnesquiz för en frågetyp |
Ersätter antalet för den angivna questionType (MULTIPLE_CHOICE eller OPEN_ENDED). Antalet andra typer bevaras |
| Ange antalet frågesporter för modulen för en frågetyp |
Ersätter antalet för den angivna questionType (MULTIPLE_CHOICE eller OPEN_ENDED). Antalet andra typer bevaras |
| Ange eller ersätt ett ämnes-intro |
Upsert – skapar om det saknas, ersätter om det finns |
| Ange eller ersätt intro för en modul |
Upsert – skapar om det saknas, ersätter om det finns |
| Avtilldela en användare från en roll |
Idempotent – 204 även om det inte tilldelades |
| Avtilldela ett dokument från en expert |
Idempotent |
| Certifikatinformation |
Returnerar ett certifikat som är begränsat till anroparens företag |
| Ersätt binärt dokument |
Ersätter filbinärfilen för ett befintligt dokument. metadata bevaras |
| Ersätt binärt media |
Ersätter filbinärfilen för ett befintligt medieobjekt på plats. metadata bevaras |
| Flytta ett ämne till en annan modul |
targetOrdinalNumber är valfritt. om det utelämnas läggs ämnet till i målmodulen |
| Få en demoträning |
Returnerar den fullständiga demoträningen med segment |
| Få en fråga i lektionen |
Returnerar en enskild fråga under lektionen med dess ID. |
| Få en frågefråga i en modul |
Returnerar en frågefråga som är kopplad till den angivna modulen. |
| Få en frågefråga om ett ämne |
Returnerar en frågefråga som är kopplad till det angivna ämnet. |
| Hämta AI-generationsstatus för en kurs |
Returnerar listan över aktiva AI-generationsbegäranden för kursen med förlopps- och målinformation |
| Hämta en användare |
Returnerar användarmetadata och avdelnings-/rolltilldelningar |
| Hämta en inlärningsbyte |
Returnerar metadata och kapslade lektioner |
| Hämta en kurs |
Returnerar kursmetadata med modulsammanfattningar och tilldelade roller/avdelningar |
| Hämta en lektion |
Returnerar lektionsinnehåll, media och lektionsfrågor |
| Hämta en modul |
Returnerar modulinformation för det angivna ID:t. |
| Hämta en ögonblicksbild av kursversionen |
Returnerar det fullständiga innehållsträdet (moduler, ämnen, lektioner, övningar, frågor) för den angivna versionen |
| Hämta en övning |
Returnerar övningsinformation för det angivna ID:t. |
| Hämta ett dokument |
Returnerar dokumentmetadata och en kortlivad signerad nedladdnings-URL |
| Hämta ett medieobjekt |
Returnerar mediemetadata och en kortlivad signerad nedladdnings-URL |
| Hämta ett modul-introduktion |
Returnerar introtextuppsättningen för den angivna modulen. |
| Hämta ett ämne |
Returnerar ämnesinformation för det angivna ID:t. |
| Hämta ett ämnes-introduktion |
Returnerar introtextuppsättningen för det angivna ämnet. |
| Inaktivera en användare |
Idempotent – returnerar användaren även om den redan är inaktiverad |
| Insikter per elev |
Aggregerad sammanfattning och uppdelning per kurs för det angivna fönstret |
| Insikter på företagsnivå |
KPI:er på översta raden för uppringarens företag |
| Kör videobearbetning på nytt |
Skickar videon på nytt för AI-segmentering. Du kan också åsidosätta bearbetningsprompten. |
| Ladda ned pdf-certifikat |
Strömmar certifikat-PDF:en. Returnerar 404 om certifikatet inte har någon PDF ännu |
| Ladda upp ett medieobjekt |
Uppladdning av flera delar (fil + valfri beskrivning). Max 50 MB för bilder, 500 MB för videor. |
| Lista användare |
Sidnumrerad lista över användare i uppringarens företag |
| Lista avdelningar |
Alla avdelningar i anroparens företag med kapslade roller |
| Lista experter |
Sidnumrerad lista över experter i uppringarens företag |
| Lista frågefrågor om ett ämne |
Returnerar frågefrågor som är kopplade till det angivna ämnet. |
| Lista frågor om frågesporter i en modul |
Returnerar frågefrågor som är kopplade till den angivna modulen. |
| Lista frågor under lektionen |
Returnerar kunskapstestfrågor som är kopplade till den angivna lektionen. |
| Lista kurser |
Sidnumrerad lista över kurser i uppringarens företag |
| Lista kursversioner |
Returnerar publicerade versionsmetadata (antal + publiceringsinformation) ordnade efter versionsnummer |
| Lista lektioner i en inlärningsbyte |
Returnerar lektioner som tillhör det angivna inlärningsbytet. |
| Lista moduler i en kurs |
Returnerar aktiva moduler ordnade efter ordinalNumber |
| Lista ämnen i en modul |
Returnerar aktiva ämnen ordnade efter ordinalNumber |
| Lista övningar i ett ämne |
Blandade typer (ILE_TEXT/RPE_VOICE/RPE_VIDEO) ordnade efter ordinalNumber |
| Lägg till en fråga under lektionen |
måste vara MULTIPLE_CHOICE (kräver alternativ) eller OPEN_ENDED |
| Lägga till en frågefråga i en modul |
Skapar en ny frågefråga i den angivna modulen. |
| Lägga till en frågefråga i ett ämne |
Skapar en ny frågefråga i det angivna ämnet. |
| Lägga till en ILE_TEXT övning i ett ämne |
Skapar en ny ILE_TEXT övning i det angivna ämnet. |
| Lägga till en lektion i en inlärningsbyte |
Skapar en ny lektion i det angivna inlärningsbytet. |
| Lägga till en modul i en kurs |
Skapar en ny modul i den angivna kursen. |
| Lägga till en RPE_VIDEO övning i ett ämne |
Skapar en ny RPE_VIDEO rollspelsövning i det angivna ämnet. |
| Lägga till en RPE_VOICE övning i ett ämne |
Skapar en ny RPE_VOICE rollspelsövning i det angivna ämnet. |
| Lägga till en utbildningsbyte i ett ämne |
Skapar en ny inlärningsbyte i det angivna ämnet. |
| Lägga till ett ämne i en modul |
Skapar ett nytt ämne i den angivna modulen. |
| Länka dokument till ett ämne |
Additiv – redan länkade dokument hoppas över |
| Ordna om frågefrågor om ett ämne |
questionIds måste innehålla varje aktiv frågefråga för ämnet, i den nya ordningen. |
| Ordna om moduler i en kurs |
moduleIds måste innehålla varje aktiv modul exakt en gång, i den nya ordningen |
| Publicera en kurs |
Publicerar kursen; misslyckas med 400 om det inte har något publiceringsbart innehåll |
| Skaffa en expert |
Returnerar expertmetadata, länkade dokument och tilldelade roller/avdelningar |
| Skapa en användare |
Skapar en användare och utlöser det magiska länkinbjudan |
| Skapa en avdelning |
Skapar en ny avdelning i uppringarens företag. |
| Skapa en demoträning |
Skapar en demoträning från en tidigare uppladdad videofil och börjar bearbetas |
| Skapa en fullständig kurs med AI-innehåll |
Skapar kursgränssnittet, alla moduler, alla ämnen och skapar AI-innehåll för varje ämne |
| Skapa en roll inom en avdelning |
Skapar en ny roll som är begränsad till den angivna avdelningen. |
| Skapa en tom kurs |
Skapar ett nytt kursgränssnitt med förnamnet |
| Ställ en fråga till en expert |
Synkron omslutning runt den strömmande AI-chatten. Returnerar det sammansatta svaret. |
| Ta bort (inaktivera) en avdelning |
Idempotent – returnerar 204 även om det redan är inaktiverat. Kaskad till rolltilldelningar. |
| Ta bort (inaktivera) ett dokument |
Idempotent – returnerar 204 även om dokumentet redan har tagits bort eller saknas |
| Ta bort (inaktivera) ett medieobjekt |
Idempotent – returnerar 204 även om objektet redan har tagits bort eller saknas |
| Ta bort (mjuk) en kurs |
Idempotent – returnerar 204 även om kursen redan har tagits bort |
| Ta bort alla rolltilldelningar från en expert |
Idempotent |
| Ta bort alla rolltilldelningar från en kurs |
Idempotent |
| Ta bort en demoträning |
Idempotent – returnerar 204 även om demoträningen inte finns eller redan är borta |
| Ta bort en fråga under lektionen |
Idempotent – 204 även om det redan har tagits bort |
| Ta bort en frågefråga i en modul |
Idempotent – 204 även om det redan har tagits bort |
| Ta bort en frågefråga om ett ämne |
Idempotent – 204 även om det redan har tagits bort |
| Ta bort en inlärningsbyte (mjuk) |
Idempotent – 204 även om det redan har tagits bort |
| Ta bort en lektion (mjuk) |
Idempotent – 204 även om det redan har tagits bort |
| Ta bort en modul (mjuk) |
Idempotent – returnerar 204 även om modulen redan har tagits bort |
| Ta bort en rolltilldelning från en expert |
Idempotent |
| Ta bort en rolltilldelning från en kurs |
Idempotent |
| Ta bort en övning |
Idempotent – 204 även om det redan har tagits bort |
| Ta bort ett modulintro |
Idempotent – 204 även om inget intro har angetts |
| Ta bort ett ämne (mjukt) |
Idempotent – returnerar 204 även om ämnet redan har tagits bort |
| Ta bort ett ämnesintro |
Idempotent – 204 även om inget intro har angetts |
| Ta bort länk till ett dokument från ett ämne |
Idempotent |
| Tilldela dokument till en expert |
Masslänka dokument till experten. Idempotent. |
| Tilldela en användare till en roll |
Idempotent |
| Tilldela roller till en expert |
Additiv – redan tilldelade roller behålls; nya som läggs till. Returnerar uppdaterad expert |
| Tilldela roller till en kurs |
Additiv – roller som redan har tilldelats hoppas över. Returnerar den uppdaterade kursinformationen |
| Uppdatera dokumentmetadata |
Uppdatera namn och/eller beskrivning |
| Uppdatera en användare |
Uppdatera firstName, lastName, isAdmin och rolltilldelningar. E-post kan inte redigeras i v1. |
| Uppdatera en avdelning |
Uppdatera namn och/eller beskrivning |
| Uppdatera en demoträning |
Partiell uppdatering. Skicka bara de fält som du vill ändra. assignedRoleIds ersätter den aktuella uppsättningen. |
| Uppdatera en fråga under lektionen |
Ange fält som matchar den lagrade typen. orelaterade fält ignoreras |
| Uppdatera en frågefråga i en modul |
Ange fält som matchar den lagrade typen. orelaterade fält ignoreras. |
| Uppdatera en frågefråga om ett ämne |
Ange fält som matchar den lagrade typen. orelaterade fält ignoreras. |
| Uppdatera en övning |
Typmedveten: ILE_TEXT använder endast prompt + generatedContent.scenario; RPE_* använder alla RPE-fält. Utelämnade fält bevarar aktuella värden. |
| Uppdatera kursmetadata |
Uppdatera kursnamn |
| Uppdatera lektionsinnehåll |
Utelämnat innehåll bevarar aktuellt värde |
| Uppdatera mediemetadata |
Uppdatera namn och/eller beskrivning |
| Uppdatera metadata för utbildningsbyte |
Utelämnade fält bevarar aktuella värden |
| Uppdatera modulmetadata |
Uppdaterar namn och/eller beskrivning. Utelämnade fält bevarar aktuella värden |
| Uppdatera ämnesmetadata |
Uppdaterar namn och/eller beskrivning. Utelämnade fält bevarar aktuella värden |
| Utlösa AI-innehållsgenerering för ämnen |
Genererar AI-innehåll för de angivna ämnena i kursen |
| Visa en lista över demoträningar |
Sidnumrerad lista som är begränsad till anroparens företag |
| Visa en lista över dokument |
Sidnumrerad lista över dokument i uppringarens företag |
| Visa en lista över dokument som är länkade till ett ämne |
Sidnumrerad; valfri sökning efter dokumentnamn |
| Visa en lista över en elevs certifikat |
Returnerar certifikat som den angivna eleven har tjänat in i uppringarens företag |
| Visa en lista över media |
Sidnumrerad lista över medieobjekt i anroparens företag |
| Visa en lista över utbildningsbyte i ett ämne |
Returnerar inlärningsbyte som tillhör det angivna ämnet. |
| Växla tillgänglighet för studenter |
Ange om demoträningen ska publiceras till eleverna. Idempotent. |
| Ändra ordning på frågesportsfrågor i en modul |
questionIds måste innehålla varje aktiv frågefråga för modulen, i den nya ordningen. |
| Ändra ordning på frågor i lektionen |
questionIds måste innehålla varje aktiv fråga för lektionen, i den nya ordningen |
| Ändra ordning på ämnen i en modul |
topicIds måste innehålla varje aktivt ämne exakt en gång, i den nya ordningen |
| Återaktivera en användare |
Idempotent – returnerar användaren även om den redan är aktiv |
| Återskapa ett specifikt objekt via AI |
Återskapar en enskild lektion, lektionsfrågor, frågesport, introduktion eller övning |
| Överför ett dokument |
Uppladdning av flera delar (fil + valfri beskrivning). Max 50 MB. |
Aktivitetshändelser per elev
Sidnumrerad framåtriktad händelseström
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Användar-ID
|
userId | True | uuid |
Användar-ID |
|
Sida
|
page | integer |
Sida |
|
|
Size
|
size | integer |
Size |
Returer
- Body
- EventListResponse
Ange antal ämnesquiz för en frågetyp
Ersätter antalet för den angivna questionType (MULTIPLE_CHOICE eller OPEN_ENDED). Antalet andra typer bevaras
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Ämnes-ID
|
topicId | True | uuid |
Ämnes-ID |
|
questionType
|
questionType | True | string | |
|
count
|
count | integer |
Returer
- Body
- TopicDto
Ange antalet frågesporter för modulen för en frågetyp
Ersätter antalet för den angivna questionType (MULTIPLE_CHOICE eller OPEN_ENDED). Antalet andra typer bevaras
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Modul-ID
|
moduleId | True | uuid |
Modul-ID |
|
questionType
|
questionType | True | string | |
|
count
|
count | integer |
Returer
- Body
- ModuleDetailDto
Ange eller ersätt ett ämnes-intro
Upsert – skapar om det saknas, ersätter om det finns
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Ämnes-ID
|
topicId | True | uuid |
Ämnes-ID |
|
Introduktion
|
introduction | string |
Returer
- Body
- IntroDto
Ange eller ersätt intro för en modul
Upsert – skapar om det saknas, ersätter om det finns
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Modul-ID
|
moduleId | True | uuid |
Modul-ID |
|
Introduktion
|
introduction | string |
Returer
- Body
- IntroDto
Avtilldela en användare från en roll
Idempotent – 204 även om det inte tilldelades
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
Roll-ID
|
roleId | True | uuid |
Roll-ID |
|
Användar-ID
|
userId | True | uuid |
Användar-ID |
Avtilldela ett dokument från en expert
Idempotent
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
Dokument-ID
|
documentId | True | uuid |
Dokument-ID |
Certifikatinformation
Returnerar ett certifikat som är begränsat till anroparens företag
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
Returer
- Body
- CertificateDto
Ersätt binärt dokument
Ersätter filbinärfilen för ett befintligt dokument. metadata bevaras
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
File
|
file | True | file |
File |
Returer
- Body
- DocumentDetailDto
Ersätt binärt media
Ersätter filbinärfilen för ett befintligt medieobjekt på plats. metadata bevaras
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
File
|
file | True | file |
File |
Returer
- Body
- MediaDetailDto
Flytta ett ämne till en annan modul
targetOrdinalNumber är valfritt. om det utelämnas läggs ämnet till i målmodulen
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Ämnes-ID
|
topicId | True | uuid |
Ämnes-ID |
|
targetModuleId
|
targetModuleId | True | uuid | |
|
targetOrdinalNumber
|
targetOrdinalNumber | integer |
Returer
- Body
- TopicDto
Få en demoträning
Returnerar den fullständiga demoträningen med segment
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
Returer
- Body
- DemoTrainingDto
Få en fråga i lektionen
Returnerar en enskild fråga under lektionen med dess ID.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Lektions-ID
|
lessonId | True | uuid |
Lektions-ID |
|
Fråge-ID
|
questionId | True | uuid |
Fråge-ID |
Returer
- Body
- QuestionDto
Få en frågefråga i en modul
Returnerar en frågefråga som är kopplad till den angivna modulen.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Modul-ID
|
moduleId | True | uuid |
Modul-ID |
|
Fråge-ID
|
questionId | True | uuid |
Fråge-ID |
Returer
- Body
- QuestionDto
Få en frågefråga om ett ämne
Returnerar en frågefråga som är kopplad till det angivna ämnet.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Ämnes-ID
|
topicId | True | uuid |
Ämnes-ID |
|
Fråge-ID
|
questionId | True | uuid |
Fråge-ID |
Returer
- Body
- QuestionDto
Hämta AI-generationsstatus för en kurs
Returnerar listan över aktiva AI-generationsbegäranden för kursen med förlopps- och målinformation
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
Returer
Hämta en användare
Returnerar användarmetadata och avdelnings-/rolltilldelningar
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
Returer
- Body
- UserDto
Hämta en inlärningsbyte
Returnerar metadata och kapslade lektioner
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Lb-ID
|
lbId | True | uuid |
Lb-ID |
Returer
Hämta en kurs
Returnerar kursmetadata med modulsammanfattningar och tilldelade roller/avdelningar
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
Returer
- Body
- CourseDetailDto
Hämta en lektion
Returnerar lektionsinnehåll, media och lektionsfrågor
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Lektions-ID
|
lessonId | True | uuid |
Lektions-ID |
Returer
- Body
- LessonDetailDto
Hämta en modul
Returnerar modulinformation för det angivna ID:t.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Modul-ID
|
moduleId | True | uuid |
Modul-ID |
Returer
- Body
- ModuleDetailDto
Hämta en ögonblicksbild av kursversionen
Returnerar det fullständiga innehållsträdet (moduler, ämnen, lektioner, övningar, frågor) för den angivna versionen
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Kurs-ID
|
courseId | True | uuid |
Kurs-ID |
|
Versionsnummer
|
versionNumber | True | integer |
Versionsnummer |
Returer
Hämta en övning
Returnerar övningsinformation för det angivna ID:t.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
Returer
- Body
- ExerciseDto
Hämta ett dokument
Returnerar dokumentmetadata och en kortlivad signerad nedladdnings-URL
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
Returer
- Body
- DocumentDetailDto
Hämta ett medieobjekt
Returnerar mediemetadata och en kortlivad signerad nedladdnings-URL
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
Returer
- Body
- MediaDetailDto
Hämta ett modul-introduktion
Returnerar introtextuppsättningen för den angivna modulen.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Modul-ID
|
moduleId | True | uuid |
Modul-ID |
Returer
- Body
- IntroDto
Hämta ett ämne
Returnerar ämnesinformation för det angivna ID:t.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Ämnes-ID
|
topicId | True | uuid |
Ämnes-ID |
Returer
- Body
- TopicDto
Hämta ett ämnes-introduktion
Returnerar introtextuppsättningen för det angivna ämnet.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Ämnes-ID
|
topicId | True | uuid |
Ämnes-ID |
Returer
- Body
- IntroDto
Inaktivera en användare
Idempotent – returnerar användaren även om den redan är inaktiverad
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
Returer
- Body
- UserDto
Insikter per elev
Aggregerad sammanfattning och uppdelning per kurs för det angivna fönstret
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Användar-ID
|
userId | True | uuid |
Användar-ID |
|
Fönster
|
window | string |
Fönster |
Returer
- Body
- StudentInsightsDto
Insikter på företagsnivå
Kör videobearbetning på nytt
Skickar videon på nytt för AI-segmentering. Du kan också åsidosätta bearbetningsprompten.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
processingPrompt
|
processingPrompt | string |
Returer
- Body
- DemoTrainingDto
Ladda ned pdf-certifikat
Strömmar certifikat-PDF:en. Returnerar 404 om certifikatet inte har någon PDF ännu
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
Returer
- response
- StreamingResponseBody
Ladda upp ett medieobjekt
Uppladdning av flera delar (fil + valfri beskrivning). Max 50 MB för bilder, 500 MB för videor.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
File
|
file | True | file |
File |
|
Description
|
description | string |
Description |
Returer
- Body
- MediaDetailDto
Lista användare
Sidnumrerad lista över användare i uppringarens företag
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Sida
|
page | integer |
Sida |
|
|
Size
|
size | integer |
Size |
|
|
Sökning
|
search | string |
Sökning |
|
|
Status
|
status | string |
Status |
|
|
Avdelnings-ID:t
|
departmentIds | string |
Avdelnings-ID:t |
|
|
Roll-ID:t
|
roleIds | string |
Roll-ID:t |
|
|
Typ
|
kind | string |
Typ |
Returer
- Body
- UserListResponse
Lista avdelningar
Lista experter
Sidnumrerad lista över experter i uppringarens företag
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Sida
|
page | integer |
Sida |
|
|
Size
|
size | integer |
Size |
|
|
Sökning
|
search | string |
Sökning |
Returer
- Body
- ExpertListResponse
Lista frågefrågor om ett ämne
Returnerar frågefrågor som är kopplade till det angivna ämnet.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Ämnes-ID
|
topicId | True | uuid |
Ämnes-ID |
Returer
- Body
- QuestionListResponse
Lista frågor om frågesporter i en modul
Returnerar frågefrågor som är kopplade till den angivna modulen.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Modul-ID
|
moduleId | True | uuid |
Modul-ID |
Returer
- Body
- QuestionListResponse
Lista frågor under lektionen
Returnerar kunskapstestfrågor som är kopplade till den angivna lektionen.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Lektions-ID
|
lessonId | True | uuid |
Lektions-ID |
Returer
- Body
- QuestionListResponse
Lista kurser
Sidnumrerad lista över kurser i uppringarens företag
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Sida
|
page | integer |
Sida |
|
|
Size
|
size | integer |
Size |
|
|
Sökning
|
search | string |
Sökning |
|
|
Status
|
status | string |
Status |
|
|
Avdelningsroll-ID:t
|
departmentRoleIds | string |
Avdelningsroll-ID:t |
Returer
- Body
- CourseListResponse
Lista kursversioner
Returnerar publicerade versionsmetadata (antal + publiceringsinformation) ordnade efter versionsnummer
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Kurs-ID
|
courseId | True | uuid |
Kurs-ID |
Returer
Lista lektioner i en inlärningsbyte
Returnerar lektioner som tillhör det angivna inlärningsbytet.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Lb-ID
|
lbId | True | uuid |
Lb-ID |
Returer
- Body
- LessonListResponse
Lista moduler i en kurs
Returnerar aktiva moduler ordnade efter ordinalNumber
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Kurs-ID
|
courseId | True | uuid |
Kurs-ID |
Returer
- Body
- ModuleListResponse
Lista ämnen i en modul
Returnerar aktiva ämnen ordnade efter ordinalNumber
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Modul-ID
|
moduleId | True | uuid |
Modul-ID |
Returer
- Body
- TopicListResponse
Lista övningar i ett ämne
Blandade typer (ILE_TEXT/RPE_VOICE/RPE_VIDEO) ordnade efter ordinalNumber
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Ämnes-ID
|
topicId | True | uuid |
Ämnes-ID |
Returer
- Body
- ExerciseListResponse
Lägg till en fråga under lektionen
måste vara MULTIPLE_CHOICE (kräver alternativ) eller OPEN_ENDED
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Lektions-ID
|
lessonId | True | uuid |
Lektions-ID |
|
type
|
type | True | string | |
|
text
|
text | True | string | |
|
ordinalNumber
|
ordinalNumber | integer | ||
|
text
|
text | True | string | |
|
isCorrect
|
isCorrect | boolean | ||
|
expectedAnswer
|
expectedAnswer | string |
Returer
- Body
- QuestionDto
Lägga till en frågefråga i en modul
Skapar en ny frågefråga i den angivna modulen.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Modul-ID
|
moduleId | True | uuid |
Modul-ID |
|
type
|
type | True | string | |
|
text
|
text | True | string | |
|
ordinalNumber
|
ordinalNumber | integer | ||
|
text
|
text | True | string | |
|
isCorrect
|
isCorrect | boolean | ||
|
expectedAnswer
|
expectedAnswer | string |
Returer
- Body
- QuestionDto
Lägga till en frågefråga i ett ämne
Skapar en ny frågefråga i det angivna ämnet.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Ämnes-ID
|
topicId | True | uuid |
Ämnes-ID |
|
type
|
type | True | string | |
|
text
|
text | True | string | |
|
ordinalNumber
|
ordinalNumber | integer | ||
|
text
|
text | True | string | |
|
isCorrect
|
isCorrect | boolean | ||
|
expectedAnswer
|
expectedAnswer | string |
Returer
- Body
- QuestionDto
Lägga till en ILE_TEXT övning i ett ämne
Skapar en ny ILE_TEXT övning i det angivna ämnet.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Ämnes-ID
|
topicId | True | uuid |
Ämnes-ID |
|
prompt
|
prompt | string |
Returer
- Body
- ExerciseDto
Lägga till en lektion i en inlärningsbyte
Skapar en ny lektion i det angivna inlärningsbytet.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Lb-ID
|
lbId | True | uuid |
Lb-ID |
|
innehåll
|
content | True | string |
Returer
- Body
- LessonDetailDto
Lägga till en modul i en kurs
Skapar en ny modul i den angivna kursen.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Kurs-ID
|
courseId | True | uuid |
Kurs-ID |
|
Namn
|
name | True | string | |
|
description
|
description | string |
Returer
- Body
- ModuleDetailDto
Lägga till en RPE_VIDEO övning i ett ämne
Skapar en ny RPE_VIDEO rollspelsövning i det angivna ämnet.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Ämnes-ID
|
topicId | True | uuid |
Ämnes-ID |
|
prompt
|
prompt | string | ||
|
avatarPictureId
|
avatarPictureId | uuid | ||
|
avatarCharacteristics
|
avatarCharacteristics | string | ||
|
reverseRolePlayEnabled
|
reverseRolePlayEnabled | boolean | ||
|
reverseRolePlayMandatory
|
reverseRolePlayMandatory | boolean |
Returer
- Body
- ExerciseDto
Lägga till en RPE_VOICE övning i ett ämne
Skapar en ny RPE_VOICE rollspelsövning i det angivna ämnet.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Ämnes-ID
|
topicId | True | uuid |
Ämnes-ID |
|
prompt
|
prompt | string | ||
|
avatarPictureId
|
avatarPictureId | uuid | ||
|
avatarCharacteristics
|
avatarCharacteristics | string | ||
|
reverseRolePlayEnabled
|
reverseRolePlayEnabled | boolean | ||
|
reverseRolePlayMandatory
|
reverseRolePlayMandatory | boolean |
Returer
- Body
- ExerciseDto
Lägga till en utbildningsbyte i ett ämne
Skapar en ny inlärningsbyte i det angivna ämnet.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Ämnes-ID
|
topicId | True | uuid |
Ämnes-ID |
|
Namn
|
name | True | string | |
|
description
|
description | string |
Returer
Lägga till ett ämne i en modul
Skapar ett nytt ämne i den angivna modulen.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Modul-ID
|
moduleId | True | uuid |
Modul-ID |
|
Namn
|
name | True | string | |
|
description
|
description | string |
Returer
- Body
- TopicDto
Länka dokument till ett ämne
Additiv – redan länkade dokument hoppas över
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Ämnes-ID
|
topicId | True | uuid |
Ämnes-ID |
|
documentIds
|
documentIds | True | array of uuid |
Ordna om frågefrågor om ett ämne
questionIds måste innehålla varje aktiv frågefråga för ämnet, i den nya ordningen.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Ämnes-ID
|
topicId | True | uuid |
Ämnes-ID |
|
questionIds
|
questionIds | True | array of uuid |
Returer
- Body
- QuestionListResponse
Ordna om moduler i en kurs
moduleIds måste innehålla varje aktiv modul exakt en gång, i den nya ordningen
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Kurs-ID
|
courseId | True | uuid |
Kurs-ID |
|
moduleIds
|
moduleIds | True | array of uuid |
Returer
- Body
- ModuleListResponse
Publicera en kurs
Publicerar kursen; misslyckas med 400 om det inte har något publiceringsbart innehåll
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
Returer
- Body
- CourseDetailDto
Skaffa en expert
Returnerar expertmetadata, länkade dokument och tilldelade roller/avdelningar
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
Returer
- Body
- ExpertDetailDto
Skapa en användare
Skapar en användare och utlöser det magiska länkinbjudan
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
email
|
True | |||
|
firstName
|
firstName | string | ||
|
lastName
|
lastName | string | ||
|
isAdmin
|
isAdmin | boolean | ||
|
departmentRoleIds
|
departmentRoleIds | array of uuid |
Returer
- Body
- UserDto
Skapa en avdelning
Skapar en ny avdelning i uppringarens företag.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Namn
|
name | True | string | |
|
description
|
description | string |
Returer
- Body
- DepartmentDto
Skapa en demoträning
Skapar en demoträning från en tidigare uppladdad videofil och börjar bearbetas
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Namn
|
name | True | string | |
|
description
|
description | string | ||
|
trainingType
|
trainingType | True | string | |
|
videoFileId
|
videoFileId | True | uuid | |
|
departmentId
|
departmentId | uuid | ||
|
processingPrompt
|
processingPrompt | string |
Returer
- Body
- DemoTrainingDto
Skapa en fullständig kurs med AI-innehåll
Skapar kursgränssnittet, alla moduler, alla ämnen och skapar AI-innehåll för varje ämne
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Namn
|
name | True | string | |
|
description
|
description | string | ||
|
Namn
|
name | True | string | |
|
description
|
description | string | ||
|
Namn
|
name | True | string | |
|
description
|
description | string |
Returer
Skapa en roll inom en avdelning
Skapar en ny roll som är begränsad till den angivna avdelningen.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
Namn
|
name | True | string | |
|
fullständigt namn
|
fullName | string | ||
|
description
|
description | string |
Returer
- Body
- DepartmentDto
Skapa en tom kurs
Skapar ett nytt kursgränssnitt med förnamnet
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Namn
|
name | True | string |
Returer
- Body
- CourseDetailDto
Ställ en fråga till en expert
Synkron omslutning runt den strömmande AI-chatten. Returnerar det sammansatta svaret.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
fråga
|
question | True | string |
Returer
- Body
- AskResponse
Ta bort (inaktivera) en avdelning
Idempotent – returnerar 204 även om det redan är inaktiverat. Kaskad till rolltilldelningar.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
Ta bort (inaktivera) ett dokument
Idempotent – returnerar 204 även om dokumentet redan har tagits bort eller saknas
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
Ta bort (inaktivera) ett medieobjekt
Idempotent – returnerar 204 även om objektet redan har tagits bort eller saknas
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
Ta bort (mjuk) en kurs
Idempotent – returnerar 204 även om kursen redan har tagits bort
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
Ta bort alla rolltilldelningar från en expert
Idempotent
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
Ta bort alla rolltilldelningar från en kurs
Idempotent
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
Ta bort en demoträning
Idempotent – returnerar 204 även om demoträningen inte finns eller redan är borta
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
Ta bort en fråga under lektionen
Idempotent – 204 även om det redan har tagits bort
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Lektions-ID
|
lessonId | True | uuid |
Lektions-ID |
|
Fråge-ID
|
questionId | True | uuid |
Fråge-ID |
Ta bort en frågefråga i en modul
Idempotent – 204 även om det redan har tagits bort
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Modul-ID
|
moduleId | True | uuid |
Modul-ID |
|
Fråge-ID
|
questionId | True | uuid |
Fråge-ID |
Ta bort en frågefråga om ett ämne
Idempotent – 204 även om det redan har tagits bort
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Ämnes-ID
|
topicId | True | uuid |
Ämnes-ID |
|
Fråge-ID
|
questionId | True | uuid |
Fråge-ID |
Ta bort en inlärningsbyte (mjuk)
Idempotent – 204 även om det redan har tagits bort
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Lb-ID
|
lbId | True | uuid |
Lb-ID |
Ta bort en lektion (mjuk)
Idempotent – 204 även om det redan har tagits bort
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Lektions-ID
|
lessonId | True | uuid |
Lektions-ID |
Ta bort en modul (mjuk)
Idempotent – returnerar 204 även om modulen redan har tagits bort
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Modul-ID
|
moduleId | True | uuid |
Modul-ID |
Ta bort en rolltilldelning från en expert
Idempotent
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
Roll-ID
|
roleId | True | uuid |
Roll-ID |
Ta bort en rolltilldelning från en kurs
Idempotent
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
Roll-ID
|
roleId | True | uuid |
Roll-ID |
Ta bort en övning
Idempotent – 204 även om det redan har tagits bort
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
Ta bort ett modulintro
Idempotent – 204 även om inget intro har angetts
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Modul-ID
|
moduleId | True | uuid |
Modul-ID |
Ta bort ett ämne (mjukt)
Idempotent – returnerar 204 även om ämnet redan har tagits bort
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Ämnes-ID
|
topicId | True | uuid |
Ämnes-ID |
Ta bort ett ämnesintro
Idempotent – 204 även om inget intro har angetts
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Ämnes-ID
|
topicId | True | uuid |
Ämnes-ID |
Ta bort länk till ett dokument från ett ämne
Idempotent
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Ämnes-ID
|
topicId | True | uuid |
Ämnes-ID |
|
Dokument-ID
|
documentId | True | uuid |
Dokument-ID |
Tilldela dokument till en expert
Masslänka dokument till experten. Idempotent.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
documentIds
|
documentIds | True | array of uuid |
Returer
- Body
- ExpertDetailDto
Tilldela en användare till en roll
Idempotent
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
Roll-ID
|
roleId | True | uuid |
Roll-ID |
|
userId
|
userId | True | uuid |
Returer
- Body
- DepartmentDto
Tilldela roller till en expert
Additiv – redan tilldelade roller behålls; nya som läggs till. Returnerar uppdaterad expert
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
roleIds
|
roleIds | True | array of uuid |
Returer
- Body
- ExpertDetailDto
Tilldela roller till en kurs
Additiv – roller som redan har tilldelats hoppas över. Returnerar den uppdaterade kursinformationen
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
roleIds
|
roleIds | True | array of uuid |
Returer
- Body
- CourseDetailDto
Uppdatera dokumentmetadata
Uppdatera namn och/eller beskrivning
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
Namn
|
name | string | ||
|
description
|
description | string |
Returer
- Body
- DocumentDetailDto
Uppdatera en användare
Uppdatera firstName, lastName, isAdmin och rolltilldelningar. E-post kan inte redigeras i v1.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
firstName
|
firstName | string | ||
|
lastName
|
lastName | string | ||
|
isAdmin
|
isAdmin | boolean | ||
|
departmentRoleIds
|
departmentRoleIds | array of uuid |
Returer
- Body
- UserDto
Uppdatera en avdelning
Uppdatera namn och/eller beskrivning
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
Namn
|
name | string | ||
|
description
|
description | string |
Returer
- Body
- DepartmentDto
Uppdatera en demoträning
Partiell uppdatering. Skicka bara de fält som du vill ändra. assignedRoleIds ersätter den aktuella uppsättningen.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
Namn
|
name | string | ||
|
description
|
description | string | ||
|
trainingType
|
trainingType | string | ||
|
departmentId
|
departmentId | uuid | ||
|
assignedRoleIds
|
assignedRoleIds | array of uuid |
Returer
- Body
- DemoTrainingDto
Uppdatera en fråga under lektionen
Ange fält som matchar den lagrade typen. orelaterade fält ignoreras
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Lektions-ID
|
lessonId | True | uuid |
Lektions-ID |
|
Fråge-ID
|
questionId | True | uuid |
Fråge-ID |
|
text
|
text | string | ||
|
text
|
text | True | string | |
|
isCorrect
|
isCorrect | boolean | ||
|
expectedAnswer
|
expectedAnswer | string |
Returer
- Body
- QuestionDto
Uppdatera en frågefråga i en modul
Ange fält som matchar den lagrade typen. orelaterade fält ignoreras.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Modul-ID
|
moduleId | True | uuid |
Modul-ID |
|
Fråge-ID
|
questionId | True | uuid |
Fråge-ID |
|
text
|
text | string | ||
|
text
|
text | True | string | |
|
isCorrect
|
isCorrect | boolean | ||
|
expectedAnswer
|
expectedAnswer | string |
Returer
- Body
- QuestionDto
Uppdatera en frågefråga om ett ämne
Ange fält som matchar den lagrade typen. orelaterade fält ignoreras.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Ämnes-ID
|
topicId | True | uuid |
Ämnes-ID |
|
Fråge-ID
|
questionId | True | uuid |
Fråge-ID |
|
text
|
text | string | ||
|
text
|
text | True | string | |
|
isCorrect
|
isCorrect | boolean | ||
|
expectedAnswer
|
expectedAnswer | string |
Returer
- Body
- QuestionDto
Uppdatera en övning
Typmedveten: ILE_TEXT använder endast prompt + generatedContent.scenario; RPE_* använder alla RPE-fält. Utelämnade fält bevarar aktuella värden.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
prompt
|
prompt | string | ||
|
avatarPictureId
|
avatarPictureId | uuid | ||
|
avatarCharacteristics
|
avatarCharacteristics | string | ||
|
reverseRolePlayEnabled
|
reverseRolePlayEnabled | boolean | ||
|
reverseRolePlayMandatory
|
reverseRolePlayMandatory | boolean | ||
|
scenarie
|
scenario | string | ||
|
traineeRole
|
traineeRole | string | ||
|
avatarName
|
avatarName | string | ||
|
avatarDescription
|
avatarDescription | string | ||
|
operationalChallenge
|
operationalChallenge | string | ||
|
successMetric
|
successMetric | string |
Returer
- Body
- ExerciseDto
Uppdatera kursmetadata
Uppdatera kursnamn
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
Namn
|
name | string |
Returer
- Body
- CourseDetailDto
Uppdatera lektionsinnehåll
Utelämnat innehåll bevarar aktuellt värde
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Lektions-ID
|
lessonId | True | uuid |
Lektions-ID |
|
innehåll
|
content | string |
Returer
- Body
- LessonDetailDto
Uppdatera mediemetadata
Uppdatera namn och/eller beskrivning
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
Namn
|
name | string | ||
|
description
|
description | string |
Returer
- Body
- MediaDetailDto
Uppdatera metadata för utbildningsbyte
Utelämnade fält bevarar aktuella värden
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Lb-ID
|
lbId | True | uuid |
Lb-ID |
|
Namn
|
name | string | ||
|
description
|
description | string |
Returer
Uppdatera modulmetadata
Uppdaterar namn och/eller beskrivning. Utelämnade fält bevarar aktuella värden
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Modul-ID
|
moduleId | True | uuid |
Modul-ID |
|
Namn
|
name | string | ||
|
description
|
description | string |
Returer
- Body
- ModuleDetailDto
Uppdatera ämnesmetadata
Uppdaterar namn och/eller beskrivning. Utelämnade fält bevarar aktuella värden
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Ämnes-ID
|
topicId | True | uuid |
Ämnes-ID |
|
Namn
|
name | string | ||
|
description
|
description | string |
Returer
- Body
- TopicDto
Utlösa AI-innehållsgenerering för ämnen
Genererar AI-innehåll för de angivna ämnena i kursen
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
topicIds
|
topicIds | True | array of uuid |
Returer
Visa en lista över demoträningar
Sidnumrerad lista som är begränsad till anroparens företag
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Sida
|
page | integer |
Sida |
|
|
Size
|
size | integer |
Size |
|
|
Sökning
|
search | string |
Sökning |
|
|
Träningstyper
|
trainingTypes | string |
Träningstyper |
|
|
Status
|
statuses | string |
Status |
|
|
Avdelnings-ID:t
|
departmentIds | string |
Avdelnings-ID:t |
|
|
Är tillgänglig
|
isAvailable | boolean |
Är tillgänglig |
Returer
Visa en lista över dokument
Sidnumrerad lista över dokument i uppringarens företag
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Sida
|
page | integer |
Sida |
|
|
Size
|
size | integer |
Size |
|
|
Sökning
|
search | string |
Sökning |
|
|
Mime-typer
|
mimeTypes | string |
Mime-typer |
|
|
Status
|
status | string |
Status |
Returer
- Body
- DocumentListResponse
Visa en lista över dokument som är länkade till ett ämne
Sidnumrerad; valfri sökning efter dokumentnamn
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Ämnes-ID
|
topicId | True | uuid |
Ämnes-ID |
|
Sida
|
page | integer |
Sida |
|
|
Size
|
size | integer |
Size |
|
|
Sökning
|
search | string |
Sökning |
Returer
Visa en lista över en elevs certifikat
Returnerar certifikat som den angivna eleven har tjänat in i uppringarens företag
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Användar-ID
|
userId | True | uuid |
Användar-ID |
Returer
Visa en lista över media
Sidnumrerad lista över medieobjekt i anroparens företag
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Sida
|
page | integer |
Sida |
|
|
Size
|
size | integer |
Size |
|
|
Sökning
|
search | string |
Sökning |
|
|
Typ
|
kind | string |
Typ |
|
|
Status
|
status | string |
Status |
Returer
- Body
- MediaListResponse
Visa en lista över utbildningsbyte i ett ämne
Returnerar inlärningsbyte som tillhör det angivna ämnet.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Ämnes-ID
|
topicId | True | uuid |
Ämnes-ID |
Returer
Växla tillgänglighet för studenter
Ange om demoträningen ska publiceras till eleverna. Idempotent.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
available
|
available | True | boolean |
Returer
- Body
- DemoTrainingDto
Ändra ordning på frågesportsfrågor i en modul
questionIds måste innehålla varje aktiv frågefråga för modulen, i den nya ordningen.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Modul-ID
|
moduleId | True | uuid |
Modul-ID |
|
questionIds
|
questionIds | True | array of uuid |
Returer
- Body
- QuestionListResponse
Ändra ordning på frågor i lektionen
questionIds måste innehålla varje aktiv fråga för lektionen, i den nya ordningen
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Lektions-ID
|
lessonId | True | uuid |
Lektions-ID |
|
questionIds
|
questionIds | True | array of uuid |
Returer
- Body
- QuestionListResponse
Ändra ordning på ämnen i en modul
topicIds måste innehålla varje aktivt ämne exakt en gång, i den nya ordningen
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Modul-ID
|
moduleId | True | uuid |
Modul-ID |
|
topicIds
|
topicIds | True | array of uuid |
Returer
- Body
- TopicListResponse
Återaktivera en användare
Idempotent – returnerar användaren även om den redan är aktiv
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
Returer
- Body
- UserDto
Återskapa ett specifikt objekt via AI
Återskapar en enskild lektion, lektionsfrågor, frågesport, introduktion eller övning
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
mål
|
target | True | string | |
|
targetId
|
targetId | True | uuid | |
|
föräldertyp
|
parentType | string |
Returer
Överför ett dokument
Uppladdning av flera delar (fil + valfri beskrivning). Max 50 MB.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
File
|
file | True | file |
File |
|
Description
|
description | string |
Description |
Returer
- Body
- DocumentDetailDto
Definitioner
QuizSettingDto
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
questionType
|
questionType | string | |
|
count
|
count | integer |
TopicDto
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
moduleId
|
moduleId | uuid | |
|
Namn
|
name | string | |
|
description
|
description | string | |
|
ordinalNumber
|
ordinalNumber | integer | |
|
hasContent
|
hasContent | boolean | |
|
quizSettings
|
quizSettings | array of QuizSettingDto |
Introduktion
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
componentId
|
componentId | uuid | |
|
componentType
|
componentType | string | |
|
Introduktion
|
introduction | string | |
|
source
|
source | string | |
|
createdAt
|
createdAt | date-time | |
|
updatedAt
|
updatedAt | date-time |
ModuleDetailDto
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
courseId
|
courseId | uuid | |
|
Namn
|
name | string | |
|
description
|
description | string | |
|
productId
|
productId | uuid | |
|
ordinalNumber
|
ordinalNumber | integer | |
|
lockedForGeneration
|
lockedForGeneration | boolean | |
|
quizSettings
|
quizSettings | array of QuizSettingDto | |
|
topics
|
topics | array of TopicDto |
MediaDetailDto
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
Namn
|
name | string | |
|
description
|
description | string | |
|
Typ
|
kind | string | |
|
Mimetype
|
mimeType | string | |
|
sizeBytes
|
sizeBytes | integer | |
|
status
|
status | string | |
|
processingStatus
|
processingStatus | string | |
|
createdAt
|
createdAt | date-time | |
|
uploadedBy
|
uploadedBy | UploadedByDto | |
|
downloadUrl
|
downloadUrl | string |
UploadedByDto
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
Typ
|
kind | string | |
|
Namn
|
name | string |
DocumentDetailDto
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
Namn
|
name | string | |
|
description
|
description | string | |
|
Mimetype
|
mimeType | string | |
|
sizeBytes
|
sizeBytes | integer | |
|
status
|
status | string | |
|
createdAt
|
createdAt | date-time | |
|
uploadedBy
|
uploadedBy | UploadedByDto | |
|
downloadUrl
|
downloadUrl | string |
DepartmentRoleDto
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
departmentId
|
departmentId | uuid | |
|
departmentName
|
departmentName | string | |
|
role-id
|
roleId | uuid | |
|
rollnamn
|
roleName | string |
UserDto
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
email
|
string | ||
|
firstName
|
firstName | string | |
|
lastName
|
lastName | string | |
|
status
|
status | string | |
|
Typ
|
kind | string | |
|
isAdmin
|
isAdmin | boolean | |
|
createdAt
|
createdAt | date-time | |
|
departmentRoles
|
departmentRoles | array of DepartmentRoleDto |
QuestionDto
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
type
|
type | string | |
|
parentId
|
parentId | uuid | |
|
föräldertyp
|
parentType | string | |
|
text
|
text | string | |
|
ordinalNumber
|
ordinalNumber | integer | |
|
source
|
source | string | |
|
expectedAnswer
|
expectedAnswer | string | |
|
options
|
options | array of QuestionOptionDto | |
|
createdAt
|
createdAt | date-time | |
|
updatedAt
|
updatedAt | date-time |
QuestionOptionDto
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
text
|
text | string | |
|
isCorrect
|
isCorrect | boolean | |
|
ordinalNumber
|
ordinalNumber | integer |
QuestionListResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
items
|
items | array of QuestionDto |
LearningByteDetailDto
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
topicId
|
topicId | uuid | |
|
Namn
|
name | string | |
|
description
|
description | string | |
|
ordinalNumber
|
ordinalNumber | integer | |
|
source
|
source | string | |
|
createdAt
|
createdAt | date-time | |
|
updatedAt
|
updatedAt | date-time | |
|
lektioner
|
lessons | array of LessonDto |
LessonDto
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
learningByteId
|
learningByteId | uuid | |
|
innehåll
|
content | string | |
|
ordinalNumber
|
ordinalNumber | integer | |
|
source
|
source | string | |
|
questionCount
|
questionCount | integer | |
|
mediaCount
|
mediaCount | integer | |
|
createdAt
|
createdAt | date-time | |
|
updatedAt
|
updatedAt | date-time |
ExerciseDto
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
topicId
|
topicId | uuid | |
|
type
|
type | string | |
|
prompt
|
prompt | string | |
|
ordinalNumber
|
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 | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
regenerationId
|
regenerationId | uuid | |
|
scenarie
|
scenario | string | |
|
traineeRole
|
traineeRole | string | |
|
avatarName
|
avatarName | string | |
|
avatarDescription
|
avatarDescription | string | |
|
operationalChallenge
|
operationalChallenge | string | |
|
successMetric
|
successMetric | string | |
|
undervisning
|
instruction | string | |
|
instructionReverse
|
instructionReverse | string | |
|
exerciseKnowledgeBase
|
exerciseKnowledgeBase | string | |
|
topicKnowledgeBase
|
topicKnowledgeBase | string |
TopicListResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
items
|
items | array of TopicDto |
LessonDetailDto
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
learningByteId
|
learningByteId | uuid | |
|
innehåll
|
content | string | |
|
ordinalNumber
|
ordinalNumber | integer | |
|
source
|
source | string | |
|
createdAt
|
createdAt | date-time | |
|
updatedAt
|
updatedAt | date-time | |
|
media
|
media | array of MediaLinkDto | |
|
frågor
|
questions | array of QuestionDto |
MediaLinkDto
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
Fileid
|
fileId | uuid | |
|
ordinalNumber
|
ordinalNumber | integer | |
|
source
|
source | string |
ExpertDetailDto
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
Namn
|
name | string | |
|
description
|
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 | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
Namn
|
name | string | |
|
utbyggnad
|
extension | string | |
|
sizeBytes
|
sizeBytes | integer | |
|
description
|
description | string | |
|
linkedAt
|
linkedAt | date-time |
AskResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
svar
|
answer | string | |
|
durationMs
|
durationMs | integer |
AvdelningDto
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
Namn
|
name | string | |
|
description
|
description | string | |
|
status
|
status | string | |
|
createdAt
|
createdAt | date-time | |
|
roles
|
roles | array of DepartmentRoleDto |
DemoTrainingDto
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
companyId
|
companyId | uuid | |
|
departmentId
|
departmentId | uuid | |
|
Namn
|
name | string | |
|
description
|
description | string | |
|
trainingType
|
trainingType | string | |
|
status
|
status | string | |
|
ärTillgänglig
|
isAvailable | boolean | |
|
videoFileId
|
videoFileId | uuid | |
|
processingPrompt
|
processingPrompt | string | |
|
errorMessage
|
errorMessage | string | |
|
assignedRoleIds
|
assignedRoleIds | array of uuid | |
|
Segment
|
segments | array of DemoTrainingSegmentDto | |
|
createdAt
|
createdAt | date-time | |
|
updatedAt
|
updatedAt | date-time |
DemoTrainingSegmentDto
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
ordinalNumber
|
ordinalNumber | integer | |
|
Namn
|
name | string | |
|
Utskrift
|
transcript | string | |
|
varaktighet Sekunder
|
durationSeconds | integer |
CourseDetailDto
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
Namn
|
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 | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
Namn
|
name | string | |
|
ordinalNumber
|
ordinalNumber | integer | |
|
topicCount
|
topicCount | integer |
GenerationRequestResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
status
|
status | string |
ModuleDto
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
courseId
|
courseId | uuid | |
|
Namn
|
name | string | |
|
description
|
description | string | |
|
productId
|
productId | uuid | |
|
ordinalNumber
|
ordinalNumber | integer | |
|
lockedForGeneration
|
lockedForGeneration | boolean | |
|
topicCount
|
topicCount | integer | |
|
quizSettings
|
quizSettings | array of QuizSettingDto |
ModuleListResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
items
|
items | array of ModuleDto |
GenerateCourseResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
courseId
|
courseId | uuid | |
|
generationRequestId
|
generationRequestId | uuid |
PageInfo
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
size
|
size | integer | |
|
nummer
|
number | integer | |
|
totalElements
|
totalElements | integer | |
|
totalPages
|
totalPages | integer |
UserListResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
items
|
items | array of UserDto | |
|
sida
|
page | PageInfo |
TopicLinkedDocumentDto
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
Namn
|
name | string | |
|
utbyggnad
|
extension | string | |
|
size
|
size | integer | |
|
processingStatus
|
processingStatus | string | |
|
description
|
description | string | |
|
source
|
source | string | |
|
linkType
|
linkType | string | |
|
linkedAt
|
linkedAt | date-time |
TopicLinkedDocumentListResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
items
|
items | array of TopicLinkedDocumentDto | |
|
sida
|
page | PageInfo |
LearningByteDto
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
topicId
|
topicId | uuid | |
|
Namn
|
name | string | |
|
description
|
description | string | |
|
ordinalNumber
|
ordinalNumber | integer | |
|
source
|
source | string | |
|
lessonCount
|
lessonCount | integer | |
|
createdAt
|
createdAt | date-time | |
|
updatedAt
|
updatedAt | date-time |
LearningByteListResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
items
|
items | array of LearningByteDto |
ExerciseListResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
items
|
items | array of ExerciseDto |
CertificateDto
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
enrollmentId
|
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 | |
|
utfärdad vid
|
issuedAt | date-time | |
|
pdfFileId
|
pdfFileId | uuid | |
|
pdfAvailable
|
pdfAvailable | boolean |
CertificateListResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
items
|
items | array of CertificateDto |
MediaDto
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
Namn
|
name | string | |
|
description
|
description | string | |
|
Typ
|
kind | string | |
|
Mimetype
|
mimeType | string | |
|
sizeBytes
|
sizeBytes | integer | |
|
status
|
status | string | |
|
processingStatus
|
processingStatus | string | |
|
createdAt
|
createdAt | date-time | |
|
uploadedBy
|
uploadedBy | UploadedByDto |
MediaListResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
items
|
items | array of MediaDto | |
|
sida
|
page | PageInfo |
LessonListResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
items
|
items | array of LessonDto |
CourseBreakdownDto
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
courseId
|
courseId | uuid | |
|
courseName
|
courseName | string | |
|
progressPercent
|
progressPercent | integer | |
|
hoursSpent
|
hoursSpent | double | |
|
startedAt
|
startedAt | date-time | |
|
completedAt
|
completedAt | date-time |
StudentInsightsDto
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
userId
|
userId | uuid | |
|
fönster
|
window | WindowDto | |
|
summary
|
summary | StudentSummaryDto | |
|
byCourse
|
byCourse | array of CourseBreakdownDto |
StudentSummaryDto
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
activeDays
|
activeDays | integer | |
|
lessonsCompleted
|
lessonsCompleted | integer | |
|
exercisesCompleted
|
exercisesCompleted | integer | |
|
quizzesPassed
|
quizzesPassed | integer | |
|
hoursSpent
|
hoursSpent | double |
WindowDto
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Typ
|
kind | string | |
|
från
|
from | date-time | |
|
till
|
to | date-time |
EventItemDto
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
Typ
|
kind | string | |
|
action
|
action | string | |
|
courseId
|
courseId | uuid | |
|
courseName
|
courseName | string | |
|
occurredAt
|
occurredAt | date-time |
EventListResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
items
|
items | array of EventItemDto | |
|
sida
|
page | PageInfo |
CompanyInsightsDto
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
companyId
|
companyId | uuid | |
|
summary
|
summary | CompanySummaryDto |
CompanySummaryDto
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
totalStudents
|
totalStudents | integer | |
|
averageProgressPercent
|
averageProgressPercent | integer | |
|
activeThisWeekCount
|
activeThisWeekCount | integer | |
|
completedCount
|
completedCount | integer | |
|
completionRatePercent
|
completionRatePercent | integer |
ExpertDto
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
Namn
|
name | string | |
|
description
|
description | string | |
|
status
|
status | string | |
|
linkedDocumentCount
|
linkedDocumentCount | integer | |
|
createdAt
|
createdAt | date-time | |
|
updatedAt
|
updatedAt | date-time |
ExpertListResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
items
|
items | array of ExpertDto | |
|
sida
|
page | PageInfo |
DocumentDto
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
Namn
|
name | string | |
|
description
|
description | string | |
|
Mimetype
|
mimeType | string | |
|
sizeBytes
|
sizeBytes | integer | |
|
status
|
status | string | |
|
createdAt
|
createdAt | date-time | |
|
uploadedBy
|
uploadedBy | UploadedByDto |
DocumentListResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
items
|
items | array of DocumentDto | |
|
sida
|
page | PageInfo |
DepartmentListResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
items
|
items | array of DepartmentDto |
DemoTrainingListItemDto
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
departmentId
|
departmentId | uuid | |
|
videoFileId
|
videoFileId | uuid | |
|
Namn
|
name | string | |
|
description
|
description | string | |
|
trainingType
|
trainingType | string | |
|
status
|
status | string | |
|
ärTillgänglig
|
isAvailable | boolean | |
|
assignedRoleIds
|
assignedRoleIds | array of uuid | |
|
segmentCount
|
segmentCount | integer | |
|
varaktighet Sekunder
|
durationSeconds | integer | |
|
createdAt
|
createdAt | date-time |
DemoTrainingListResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
items
|
items | array of DemoTrainingListItemDto | |
|
sida
|
page | PageInfo |
CourseDto
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
Namn
|
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 | Sökväg | Typ | Description |
|---|---|---|---|
|
items
|
items | array of CourseDto | |
|
sida
|
page | PageInfo |
GenerationProgressDto
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
totalTasks
|
totalTasks | integer | |
|
completedTasks
|
completedTasks | integer | |
|
failedTasks
|
failedTasks | integer |
GenerationRequestInfoDto
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
status
|
status | string | |
|
createdAt
|
createdAt | string | |
|
completedAt
|
completedAt | string | |
|
fel
|
error | string | |
|
Förlopp
|
progress | GenerationProgressDto | |
|
mål
|
target | string | |
|
targetId
|
targetId | uuid | |
|
föräldertyp
|
parentType | string | |
|
topicIds
|
topicIds | array of uuid | |
|
moduleIds
|
moduleIds | array of uuid |
GenerationStatusResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
activeRequests
|
activeRequests | array of GenerationRequestInfoDto |
CourseVersionDto
| Name | Sökväg | Typ | 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 | Sökväg | Typ | Description |
|---|---|---|---|
|
items
|
items | array of CourseVersionDto |
AuditSnapshot
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
createdAt
|
createdAt | date-time | |
|
skapadAv
|
createdBy | uuid | |
|
updatedAt
|
updatedAt | date-time | |
|
updatedBy
|
updatedBy | uuid |
CourseSnapshot
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Namn
|
name | string | |
|
coverImageId
|
coverImageId | uuid | |
|
prerequisiteCourseId
|
prerequisiteCourseId | uuid | |
|
courseGuideline
|
courseGuideline | string | |
|
lessonsGuideline
|
lessonsGuideline | string | |
|
questionsGuideline
|
questionsGuideline | string | |
|
exercisesGuideline
|
exercisesGuideline | string | |
|
modules
|
modules | array of ModuleSnapshot |
CourseVersionSnapshotDto
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
courseId
|
courseId | uuid | |
|
versionNumber
|
versionNumber | integer | |
|
snapshot
|
snapshot | CourseSnapshot |
ExerciseSnapshot
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
topicId
|
topicId | uuid | |
|
exerciseType
|
exerciseType | string | |
|
prompt
|
prompt | string | |
|
ordinalNumber
|
ordinalNumber | integer | |
|
isGenerated
|
isGenerated | boolean | |
|
source
|
source | string | |
|
revision
|
audit | AuditSnapshot | |
|
avatarCharacteristics
|
avatarCharacteristics | string | |
|
avatarPictureId
|
avatarPictureId | uuid | |
|
reverseRolePlayEnabled
|
reverseRolePlayEnabled | boolean | |
|
reverseRolePlayMandatory
|
reverseRolePlayMandatory | boolean | |
|
scenarie
|
scenario | string | |
|
traineeRole
|
traineeRole | string | |
|
avatarName
|
avatarName | string | |
|
avatarDescription
|
avatarDescription | string | |
|
operationalChallenge
|
operationalChallenge | string | |
|
successMetric
|
successMetric | string | |
|
undervisning
|
instruction | string | |
|
instructionReverse
|
instructionReverse | string | |
|
exerciseKnowledgeBase
|
exerciseKnowledgeBase | string |
LearningByteSnapshot
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
topicId
|
topicId | uuid | |
|
Namn
|
name | string | |
|
description
|
description | string | |
|
ordinalNumber
|
ordinalNumber | integer | |
|
source
|
source | string | |
|
revision
|
audit | AuditSnapshot | |
|
lektioner
|
lessons | array of LessonSnapshot |
LessonSnapshot
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
learningByteId
|
learningByteId | uuid | |
|
innehåll
|
content | string | |
|
ordinalNumber
|
ordinalNumber | integer | |
|
source
|
source | string | |
|
revision
|
audit | AuditSnapshot | |
|
media
|
media | array of MediaSnapshot | |
|
frågor
|
questions | array of QuestionSnapshot |
LinkedDocumentSnapshot
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
Fileid
|
fileId | uuid | |
|
linkType
|
linkType | string | |
|
isSupplement
|
isSupplement | boolean | |
|
Namn
|
name | string | |
|
utbyggnad
|
extension | string | |
|
size
|
size | integer | |
|
description
|
description | string |
MediaSnapshot
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
Fileid
|
fileId | uuid | |
|
ordinalNumber
|
ordinalNumber | integer | |
|
mediaType
|
mediaType | string | |
|
source
|
source | string |
ModuleSnapshot
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
courseId
|
courseId | uuid | |
|
productId
|
productId | uuid | |
|
Namn
|
name | string | |
|
description
|
description | string | |
|
Intro
|
intro | string | |
|
ordinalNumber
|
ordinalNumber | integer | |
|
quizSettings
|
quizSettings | array of QuizSettingSnapshot | |
|
quizQuestions
|
quizQuestions | array of QuestionSnapshot | |
|
topics
|
topics | array of TopicSnapshot |
AlternativSnapshot
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
optionText
|
optionText | string | |
|
isCorrect
|
isCorrect | boolean | |
|
ordinalNumber
|
ordinalNumber | integer |
QuestionSnapshot
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
questionType
|
questionType | string | |
|
questionText
|
questionText | string | |
|
expectedAnswer
|
expectedAnswer | string | |
|
ordinalNumber
|
ordinalNumber | integer | |
|
source
|
source | string | |
|
revision
|
audit | AuditSnapshot | |
|
options
|
options | array of OptionSnapshot |
QuizSettingSnapshot
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
questionType
|
questionType | string | |
|
count
|
count | integer |
TopicSnapshot
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
moduleId
|
moduleId | uuid | |
|
Namn
|
name | string | |
|
description
|
description | string | |
|
Intro
|
intro | string | |
|
ordinalNumber
|
ordinalNumber | integer | |
|
quizSettings
|
quizSettings | array of QuizSettingSnapshot | |
|
quizQuestions
|
quizQuestions | array of QuestionSnapshot | |
|
learningBytes
|
learningBytes | array of LearningByteSnapshot | |
|
övningar
|
exercises | array of ExerciseSnapshot | |
|
linkedDocuments
|
linkedDocuments | array of LinkedDocumentSnapshot | |
|
topicKnowledgeBase
|
topicKnowledgeBase | string |