Time Machine (anteprima)

Time Machine è una piattaforma di apprendimento aziendale basata sull'intelligenza artificiale. Trasforma documenti aziendali, video e conoscenze di esperti in corsi strutturati con moduli, argomenti, quiz e esercizi di gioco di ruolo e tiene traccia dello stato di avanzamento degli apprendimento. Creato per i team HR e L&D che caricano, addestrano e certificano i dipendenti su larga scala. Il connettore automatizza il ciclo di vita di apprendimento completo: gestire corsi, utenti, reparti e ruoli; generare quiz dai documenti; e leggere l'analisi del completamento.

Questo connettore è disponibile nei prodotti e nelle aree seguenti:

Service Class Regions
Copilot Studio Premium Tutte le aree di Power Automate , ad eccezione delle seguenti:
     - Governo degli Stati Uniti (GCC)
     - Us Government (GCC High)
     - China Cloud gestito da 21Vianet
     - Dipartimento della Difesa degli Stati Uniti (DoD)
App per la logica Standard Tutte le aree di App per la logica , ad eccezione delle seguenti:
     - Aree di Azure per enti pubblici
     - Aree di Azure Cina
     - Dipartimento della Difesa degli Stati Uniti (DoD)
Power Apps Premium Tutte le aree di Power Apps , ad eccezione dei seguenti:
     - Governo degli Stati Uniti (GCC)
     - Us Government (GCC High)
     - China Cloud gestito da 21Vianet
     - Dipartimento della Difesa degli Stati Uniti (DoD)
Power Automate Premium Tutte le aree di Power Automate , ad eccezione delle seguenti:
     - Governo degli Stati Uniti (GCC)
     - Us Government (GCC High)
     - China Cloud gestito da 21Vianet
     - Dipartimento della Difesa degli Stati Uniti (DoD)
Contatto
Nome Supporto di Time Machine
URL https://timeml.ai
Metadati del connettore
Publisher Intelligenza artificiale time machine
Sito web https://timeml.ai
Informativa sulla privacy https://timeml.ai/privacy-policy
Categorie Produttività; Intelligenza artificiale

Time Machine - connettore Power Automate

Che cos'è Time Machine

Time Machine è una piattaforma di apprendimento aziendale basata sull'intelligenza artificiale che consente alle aziende di creare, gestire e migliorare continuamente i sistemi di apprendimento adattivo per i team moderni. Le organizzazioni usano Time Machine per trasformare le conoscenze, i documenti, le registrazioni e i flussi di lavoro esistenti in esperienze di formazione scalabili che accelerano l'onboarding, migliorano la preparazione della forza lavoro e replicano le migliori competenze nell'intera organizzazione.

Gli amministratori tenant gestiscono gli utenti, i contenuti di apprendimento, le risorse dell'organizzazione e la configurazione della piattaforma tramite l'API REST time machine. Questo connettore espone l'API REST pubblica come azioni Power Automate, consentendo di automatizzare il provisioning degli utenti, l'inserimento di contenuti, la sincronizzazione delle informazioni e la gestione del ciclo di vita senza scrivere codice.

Prerequisites

  • Un tenant attivo di Time Machine con accesso amministratore
  • Una chiave API time machine rilasciata da Impostazioni → chiavi API nel pannello di amministrazione (https://web.timeml.ai). La chiave è un valore che inizia con tm_live_.

Authentication

Ogni azione viene autenticata con una chiave API nell'intestazione Authorization . Quando si crea una connessione in Power Automate:

  • Campo: API key
  • Valore: incollare Bearer tm_live_<your-token> (la stringa completa, incluso il Bearer prefisso e uno spazio prima del token)

Azioni disponibili

Il connettore rispecchia l'API REST pubblica time machine (116 endpoint). Le azioni vengono raggruppate per risorsa:

  • Corsi — list/create/update/delete/publish courses, assign roles, generate AI-authored content
  • Utenti — list/create/update/deactivate/reactivate users
  • Documenti — elenco/caricamento/aggiornamento/eliminazione di documenti
  • Media — elenco/caricamento/aggiornamento/eliminazione di elementi multimediali
  • Reparti — list/create/update/delete departments, manage roles, assign users to roles to roles
  • Esperti — list/ creare profili esperti, porre domande agli esperti, assegnare documenti e ruoli
  • Demo Trainings — list/create/update/delete demo trainings
  • Contenuto del corso : moduli, argomenti, lezioni, esercizi, domande quiz
  • Insights : analisi per studente, per corso e analisi a livello aziendale
  • Certificati : elencare i certificati degli studenti, scaricare pdf dei certificati

Il riferimento completo all'endpoint è disponibile all'indirizzo https://api.timeml.ai/api/v1/docs.

Flussi di lavoro di esempio

  • Versione di Confluence → Time Machine: quando una pagina di rilascio viene pubblicata in Confluence, caricarla come documento in time machine in modo che passi alla raccolta di byte di apprendimento.
  • Onboarding delle risorse umane: quando viene visualizzata una nuova riga dipendente in HRIS, creare un utente di Time Machine con il reparto e le assegnazioni di ruolo, attivando l'invito magic-link.
  • Notifiche di completamento del corso: quando uno studente completa un corso, inviare un certificato PDF a Slack e registrare il completamento a un foglio Google.

Limitazioni note

  • Rotazione delle chiavi API: le connessioni devono essere aggiornate manualmente quando la chiave API viene ruotata. Non esiste alcun meccanismo di aggiornamento automatico.
  • Caricamenti in più parti: le azioni di caricamento dei file (Carica documento, Carica file multimediali) accettano file fino a 50 MB. Per supporti di dimensioni maggiori, suddivisi in più caricamenti o contattare il supporto di Time Machine.
  • Operazioni batch: l'API opera su un record alla volta. Per le azioni in blocco, usare Power Automate controllo apply-to-each predefinito.

Support

Per domande o problemi con il connettore, contattare il team dell'account time machine o inviare un messaggio di posta elettronica all'indirizzo support@timeml.ai.

Creazione di una connessione

Il connettore supporta i tipi di autenticazione seguenti:

Predefinita Parametri per la creazione della connessione. Tutte le aree geografiche Non condivisibile

Predefinito

Applicabile: tutte le aree

Parametri per la creazione della connessione.

Questa non è una connessione condivisibile. Se l'app power viene condivisa con un altro utente, verrà richiesto a un altro utente di creare una nuova connessione in modo esplicito.

Nome Tipo Description Required
Chiave API time machine (formato: Bearer tm_live_...) securestring Chiave API Time Machine (formato: Bearer tm_live_...) per questa API True

Azioni

Aggiornare i metadati degli argomenti

Aggiorna il nome e/o la descrizione. I campi omessi mantengono i valori correnti

Aggiornare i metadati dei byte di apprendimento

I campi omessi mantengono i valori correnti

Aggiornare i metadati dei corsi

Aggiornare il nome del corso

Aggiornare i metadati del documento

Aggiornare il nome e/o la descrizione

Aggiornare i metadati del modulo

Aggiorna il nome e/o la descrizione. I campi omessi mantengono i valori correnti

Aggiornare i metadati multimediali

Aggiornare il nome e/o la descrizione

Aggiornare il contenuto della lezione

Il contenuto omesso mantiene il valore corrente

Aggiornare un esercizio

Riconoscimento dei tipi: ILE_TEXT usa solo prompt + generatedContent.scenario; RPE_* usa tutti i campi RPE. I campi omessi mantengono i valori correnti.

Aggiornare un reparto

Aggiornare il nome e/o la descrizione

Aggiornare un training demo

Aggiornamento parziale. Passare solo i campi da modificare. assignedRoleIds sostituisce il set corrente.

Aggiornare un utente

Aggiornare firstName, lastName, isAdmin e le assegnazioni di ruolo. La posta elettronica non è modificabile nella versione 1.

Aggiornare una domanda del quiz in un modulo

Specificare i campi corrispondenti al tipo archiviato; i campi non correlati vengono ignorati.

Aggiornare una domanda del quiz su un argomento

Specificare i campi corrispondenti al tipo archiviato; i campi non correlati vengono ignorati.

Aggiornare una domanda in lezione

Specificare i campi corrispondenti al tipo archiviato; i campi non correlati vengono ignorati

Aggiungere un argomento a un modulo

Crea un nuovo argomento all'interno del modulo specificato.

Aggiungere un byte di apprendimento a un argomento

Crea un nuovo byte di apprendimento all'interno dell'argomento specificato.

Aggiungere un esercizio ILE_TEXT a un argomento

Crea un nuovo esercizio ILE_TEXT all'interno dell'argomento specificato.

Aggiungere un esercizio RPE_VIDEO a un argomento

Crea un nuovo esercizio di RPE_VIDEO ruolo all'interno dell'argomento specificato.

Aggiungere un esercizio RPE_VOICE a un argomento

Crea un nuovo esercizio di RPE_VOICE ruolo all'interno dell'argomento specificato.

Aggiungere un modulo a un corso

Crea un nuovo modulo all'interno del corso specificato.

Aggiungere una domanda di quiz a un argomento

Crea una nuova domanda del quiz all'interno dell'argomento specificato.

Aggiungere una domanda di quiz a un modulo

Crea una nuova domanda del quiz all'interno del modulo specificato.

Aggiungere una domanda in lezione

il tipo deve essere MULTIPLE_CHOICE (richiede opzioni) o OPEN_ENDED

Aggiungere una lezione a un byte di apprendimento

Crea una nuova lezione all'interno del byte di apprendimento specificato.

Annullare l'assegnazione di un documento da un esperto

Idempotente

Annullare l'assegnazione di un utente da un ruolo

Idempotente — 204 anche se non è stato assegnato

Assegnare documenti a un esperto

Collegare in blocco i documenti all'esperto. Idempotente.

Assegnare ruoli a un corso

Additive: i ruoli già assegnati vengono ignorati. Restituisce i dettagli del corso aggiornato

Assegnare ruoli a un esperto

Additivi : i ruoli già assegnati vengono mantenuti; quelli nuovi accodati. Restituisce un esperto aggiornato

Assegnare un utente a un ruolo

Idempotente

Attivare la generazione di contenuti di intelligenza artificiale per argomenti

Accoda la generazione di contenuti di intelligenza artificiale per gli argomenti specificati all'interno del corso

Attivare o disattivare la disponibilità agli studenti

Impostare se la formazione demo viene pubblicata per gli studenti. Idempotente.

Caricare un documento

Caricamento in più parti (file e descrizione facoltativa). Massimo 50 MB.

Caricare un elemento multimediale

Caricamento in più parti (file e descrizione facoltativa). Massimo 50 MB per le immagini, 500 MB per i video.

Collegare documenti a un argomento

Additivi: i documenti già collegati vengono ignorati

Creare un corso vuoto

Crea una nuova shell dei corsi con il nome specificato

Creare un reparto

Crea un nuovo reparto nella società del chiamante.

Creare un ruolo all'interno di un reparto

Crea un nuovo ruolo con ambito per il reparto specificato.

Creare un training dimostrativo

Crea un training demo da un file video caricato in precedenza e avvia l'elaborazione

Creare un utente

Crea un utente e attiva il flusso di invito magic-link

Dettagli certificato

Restituisce un certificato con ambito alla società del chiamante

Disattivare un utente

Idempotente: restituisce l'utente anche se già disattivato

Elencare gli argomenti in un modulo

Restituisce gli argomenti attivi ordinati per ordinalNumber

Elencare gli esercizi in un argomento

Tipi misti (ILE_TEXT/RPE_VOICE/RPE_VIDEO) ordinati per ordinalNumber

Elencare gli esperti

Elenco impaginato di esperti nella società del chiamante

Elencare gli utenti

Elenco impaginato di utenti nella società del chiamante

Elencare i byte di apprendimento in un argomento

Restituisce i byte di apprendimento che appartengono all'argomento specificato.

Elencare i certificati di uno studente

Restituisce i certificati ottenuti dallo studente specificato all'interno della società del chiamante

Elencare i corsi

Elenco impaginato di corsi nell'azienda del chiamante

Elencare i documenti

Elenco impaginato di documenti nella società del chiamante

Elencare i documenti collegati a un argomento

Impaginato; ricerca facoltativa in base al nome del documento

Elencare i moduli in un corso

Restituisce i moduli attivi ordinati per ordinalNumber

Elencare i reparti

Tutti i reparti dell'azienda del chiamante con ruoli annidati

Elencare i supporti

Elenco impaginato di elementi multimediali nell'azienda del chiamante

Elencare i training demo

Elenco impaginato con ambito della società del chiamante

Elencare le domande in lezione

Restituisce le domande di verifica delle conoscenze associate alla lezione specificata.

Elencare le domande sui quiz in un modulo

Restituisce le domande del quiz associate al modulo specificato.

Elencare le domande sui quiz su un argomento

Restituisce le domande del quiz associate all'argomento specificato.

Elencare le lezioni in un byte di apprendimento

Restituisce lezioni che appartengono al byte di apprendimento specificato.

Elencare le versioni dei corsi

Restituisce i metadati della versione pubblicata (conteggi e informazioni di pubblicazione) ordinati in base al numero di versione

Eliminare (disattivare) un documento

Idempotente : restituisce il 204 anche se il documento è già stato eliminato o mancante

Eliminare (disattivare) un elemento multimediale

Idempotente : restituisce 204 anche se l'elemento è già stato eliminato o mancante

Eliminare (disattivare) un reparto

Idempotente : restituisce il 204 anche se già disattivato. Si propaga alle assegnazioni di ruolo.

Eliminare (soft) un corso

Idempotente — restituisce il 204 anche se il corso è già stato rimosso

Eliminare un argomento (soft)

Idempotente : restituisce il 204 anche se l'argomento è già stato rimosso

Eliminare un byte di apprendimento (soft)

Idempotente — 204 anche se già rimosso

Eliminare un esercizio

Idempotente — 204 anche se già rimosso

Eliminare un modulo (soft)

Idempotente: restituisce 204 anche se il modulo è già stato rimosso

Eliminare un training dimostrativo

Idempotente : restituisce il 204 anche se il training demo non esiste o è già scomparso

Eliminare una domanda del quiz in un modulo

Idempotente — 204 anche se già rimosso

Eliminare una domanda del quiz su un argomento

Idempotente — 204 anche se già rimosso

Eliminare una domanda in lezione

Idempotente — 204 anche se già rimosso

Eliminare una lezione (soft)

Idempotente — 204 anche se già rimosso

Eventi di attività per studente

Flusso di eventi forward-only impaginato

Generare un corso completo con contenuto di intelligenza artificiale

Crea la shell dei corsi, tutti i moduli, tutti gli argomenti e accoda la generazione di contenuti di intelligenza artificiale per ogni argomento

Impostare il numero di quiz degli argomenti per un tipo di domanda

Sostituisce il conteggio per il tipo di domanda specificato (MULTIPLE_CHOICE o OPEN_ENDED). Il conteggio di altri tipi viene mantenuto

Impostare il numero di quiz del modulo per un tipo di domanda

Sostituisce il conteggio per il tipo di domanda specificato (MULTIPLE_CHOICE o OPEN_ENDED). Il conteggio di altri tipi viene mantenuto

Impostare o sostituire un argomento introduttivo

Upsert : crea se mancante, sostituisce se presente

Impostare o sostituire un modulo introduttivo

Upsert : crea se mancante, sostituisce se presente

Informazioni dettagliate a livello aziendale

Indicatori KPI top line per l'azienda del chiamante

Informazioni dettagliate per studente

Riepilogo aggregato e scomposizione per corso per la finestra specificata

Introduzione a un argomento

Restituisce il testo introduttivo impostato sull'argomento specificato.

Introduzione a un modulo

Restituisce il testo introduttivo impostato nel modulo specificato.

Ottenere lo stato di generazione dell'intelligenza artificiale per un corso

Restituisce l'elenco delle richieste di generazione di intelligenza artificiale attive per il corso con informazioni sullo stato e sulla destinazione

Ottenere un argomento

Restituisce i dettagli dell'argomento per l'ID specificato.

Ottenere un byte di apprendimento

Restituisce metadati e lezioni annidate

Ottenere un corso

Restituisce i metadati del corso con riepiloghi dei moduli e ruoli/reparti assegnati

Ottenere un elemento multimediale

Restituisce i metadati multimediali e un URL di download firmato di breve durata

Ottenere un esercizio

Restituisce i dettagli dell'esercizio per l'ID specificato.

Ottenere un esperto

Restituisce metadati esperti, documenti collegati e ruoli/reparti assegnati

Ottenere un modulo

Restituisce i dettagli del modulo per l'ID specificato.

Ottenere un training dimostrativo

Restituisce il training demo completo con segmenti

Ottenere un utente

Restituisce i metadati utente e le assegnazioni di reparto/ruolo

Ottenere una domanda del quiz su un argomento

Restituisce una singola domanda del quiz collegata all'argomento specificato.

Ottenere una domanda di quiz su un modulo

Restituisce una singola domanda del quiz collegata al modulo specificato.

Ottenere una domanda in lezione

Restituisce una singola domanda in lezione in base al relativo ID.

Ottenere una lezione

Restituisce contenuti, contenuti multimediali e domande in lezione

Ottenere uno snapshot della versione del corso

Restituisce l'albero del contenuto completo (moduli, argomenti, lezioni, esercizi, domande) per la versione specificata

Porre una domanda a un esperto

Wrapper sincrono intorno alla chat di intelligenza artificiale in streaming. Restituisce la risposta assemblata.

Pubblicare un corso

Pubblica il corso; ha esito negativo con 400 se non ha contenuto pubblicabile

Recupera un documento

Restituisce i metadati del documento e un URL di download firmato di breve durata

Riattivare un utente

Idempotente: restituisce l'utente anche se già attivo

Riesegua l'elaborazione video

Invia nuovamente il video per la segmentazione di intelligenza artificiale. Facoltativamente, eseguire l'override del prompt di elaborazione.

Rigenerare un elemento specifico tramite intelligenza artificiale

Rigenera una singola lezione, domande di lezione, quiz, intro o esercizio

Rimuovere tutte le assegnazioni di ruolo da un corso

Idempotente

Rimuovere tutte le assegnazioni di ruolo da un esperto

Idempotente

Rimuovere un'assegnazione di ruolo da un corso

Idempotente

Rimuovere un'assegnazione di ruolo da un esperto

Idempotente

Rimuovere un'introduzione a un argomento

Idempotente — 204 anche se non è impostata alcuna introduzione

Rimuovere un'introduzione a un modulo

Idempotente — 204 anche se non è impostata alcuna introduzione

Riordinare gli argomenti all'interno di un modulo

topicIds deve includere ogni argomento attivo una sola volta, nel nuovo ordine

Riordinare i moduli in un corso

moduleIds deve includere ogni modulo attivo esattamente una volta, nel nuovo ordine

Riordinare le domande in lezione

questionIds deve includere ogni domanda attiva per la lezione, nel nuovo ordine

Riordinare le domande sui quiz in un modulo

questionIds deve includere ogni domanda del quiz attiva per il modulo, nel nuovo ordine.

Riordinare le domande sui quiz su un argomento

questionIds deve includere ogni domanda del quiz attiva per l'argomento, nel nuovo ordine.

Scaricare il pdf del certificato

Trasmette il file PDF del certificato. Restituisce 404 se il certificato non ha ancora un PDF

Scollegare un documento da un argomento

Idempotente

Sostituire il file binario del documento

Sostituisce il file binario di un documento esistente; i metadati vengono mantenuti

Sostituire il file binario multimediale

Sostituisce il file binario di un elemento multimediale esistente; i metadati vengono mantenuti

Spostare un argomento in un altro modulo

targetOrdinalNumber è facoltativo; se omesso, l'argomento viene aggiunto al modulo di destinazione

Aggiornare i metadati degli argomenti

Aggiorna il nome e/o la descrizione. I campi omessi mantengono i valori correnti

Parametri

Nome Chiave Necessario Tipo Descrizione
ID argomento
topicId True uuid

ID argomento

nome
name string
description
description string

Valori restituiti

Corpo
TopicDto

Aggiornare i metadati dei byte di apprendimento

I campi omessi mantengono i valori correnti

Parametri

Nome Chiave Necessario Tipo Descrizione
Lb Id
lbId True uuid

Lb Id

nome
name string
description
description string

Valori restituiti

Aggiornare i metadati dei corsi

Aggiornare il nome del corso

Parametri

Nome Chiave Necessario Tipo Descrizione
Id
id True uuid

Id

nome
name string

Valori restituiti

Aggiornare i metadati del documento

Aggiornare il nome e/o la descrizione

Parametri

Nome Chiave Necessario Tipo Descrizione
Id
id True uuid

Id

nome
name string
description
description string

Valori restituiti

Aggiornare i metadati del modulo

Aggiorna il nome e/o la descrizione. I campi omessi mantengono i valori correnti

Parametri

Nome Chiave Necessario Tipo Descrizione
ID modulo
moduleId True uuid

ID modulo

nome
name string
description
description string

Valori restituiti

Aggiornare i metadati multimediali

Aggiornare il nome e/o la descrizione

Parametri

Nome Chiave Necessario Tipo Descrizione
Id
id True uuid

Id

nome
name string
description
description string

Valori restituiti

Aggiornare il contenuto della lezione

Il contenuto omesso mantiene il valore corrente

Parametri

Nome Chiave Necessario Tipo Descrizione
ID lezione
lessonId True uuid

ID lezione

contenuto
content string

Valori restituiti

Aggiornare un esercizio

Riconoscimento dei tipi: ILE_TEXT usa solo prompt + generatedContent.scenario; RPE_* usa tutti i campi RPE. I campi omessi mantengono i valori correnti.

Parametri

Nome Chiave Necessario Tipo Descrizione
Id
id True uuid

Id

prompt
prompt string
avatarPictureId
avatarPictureId uuid
avatarCharacteristics
avatarCharacteristics string
reverseRolePlayEnabled
reverseRolePlayEnabled boolean
reverseRolePlayMandatory
reverseRolePlayMandatory boolean
situazione
scenario string
traineeRole
traineeRole string
avatarName
avatarName string
avatarDescription
avatarDescription string
operationalChallenge
operationalChallenge string
successMetric
successMetric string

Valori restituiti

Corpo
ExerciseDto

Aggiornare un reparto

Aggiornare il nome e/o la descrizione

Parametri

Nome Chiave Necessario Tipo Descrizione
Id
id True uuid

Id

nome
name string
description
description string

Valori restituiti

Aggiornare un training demo

Aggiornamento parziale. Passare solo i campi da modificare. assignedRoleIds sostituisce il set corrente.

Parametri

Nome Chiave Necessario Tipo Descrizione
Id
id True uuid

Id

nome
name string
description
description string
trainingType
trainingType string
departmentId
departmentId uuid
assignedRoleIds
assignedRoleIds array of uuid

Valori restituiti

Aggiornare un utente

Aggiornare firstName, lastName, isAdmin e le assegnazioni di ruolo. La posta elettronica non è modificabile nella versione 1.

Parametri

Nome Chiave Necessario Tipo Descrizione
Id
id True uuid

Id

firstName
firstName string
lastName
lastName string
isAdmin
isAdmin boolean
departmentRoleIds
departmentRoleIds array of uuid

Valori restituiti

Corpo
UserDto

Aggiornare una domanda del quiz in un modulo

Specificare i campi corrispondenti al tipo archiviato; i campi non correlati vengono ignorati.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID modulo
moduleId True uuid

ID modulo

ID domanda
questionId True uuid

ID domanda

text
text string
text
text True string
isCorrect
isCorrect boolean
expectedAnswer
expectedAnswer string

Valori restituiti

Corpo
QuestionDto

Aggiornare una domanda del quiz su un argomento

Specificare i campi corrispondenti al tipo archiviato; i campi non correlati vengono ignorati.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID argomento
topicId True uuid

ID argomento

ID domanda
questionId True uuid

ID domanda

text
text string
text
text True string
isCorrect
isCorrect boolean
expectedAnswer
expectedAnswer string

Valori restituiti

Corpo
QuestionDto

Aggiornare una domanda in lezione

Specificare i campi corrispondenti al tipo archiviato; i campi non correlati vengono ignorati

Parametri

Nome Chiave Necessario Tipo Descrizione
ID lezione
lessonId True uuid

ID lezione

ID domanda
questionId True uuid

ID domanda

text
text string
text
text True string
isCorrect
isCorrect boolean
expectedAnswer
expectedAnswer string

Valori restituiti

Corpo
QuestionDto

Aggiungere un argomento a un modulo

Crea un nuovo argomento all'interno del modulo specificato.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID modulo
moduleId True uuid

ID modulo

nome
name True string
description
description string

Valori restituiti

Corpo
TopicDto

Aggiungere un byte di apprendimento a un argomento

Crea un nuovo byte di apprendimento all'interno dell'argomento specificato.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID argomento
topicId True uuid

ID argomento

nome
name True string
description
description string

Valori restituiti

Aggiungere un esercizio ILE_TEXT a un argomento

Crea un nuovo esercizio ILE_TEXT all'interno dell'argomento specificato.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID argomento
topicId True uuid

ID argomento

prompt
prompt string

Valori restituiti

Corpo
ExerciseDto

Aggiungere un esercizio RPE_VIDEO a un argomento

Crea un nuovo esercizio di RPE_VIDEO ruolo all'interno dell'argomento specificato.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID argomento
topicId True uuid

ID argomento

prompt
prompt string
avatarPictureId
avatarPictureId uuid
avatarCharacteristics
avatarCharacteristics string
reverseRolePlayEnabled
reverseRolePlayEnabled boolean
reverseRolePlayMandatory
reverseRolePlayMandatory boolean

Valori restituiti

Corpo
ExerciseDto

Aggiungere un esercizio RPE_VOICE a un argomento

Crea un nuovo esercizio di RPE_VOICE ruolo all'interno dell'argomento specificato.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID argomento
topicId True uuid

ID argomento

prompt
prompt string
avatarPictureId
avatarPictureId uuid
avatarCharacteristics
avatarCharacteristics string
reverseRolePlayEnabled
reverseRolePlayEnabled boolean
reverseRolePlayMandatory
reverseRolePlayMandatory boolean

Valori restituiti

Corpo
ExerciseDto

Aggiungere un modulo a un corso

Crea un nuovo modulo all'interno del corso specificato.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID corso
courseId True uuid

ID corso

nome
name True string
description
description string

Valori restituiti

Aggiungere una domanda di quiz a un argomento

Crea una nuova domanda del quiz all'interno dell'argomento specificato.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID argomento
topicId True uuid

ID argomento

type
type True string
text
text True string
ordinalNumber
ordinalNumber integer
text
text True string
isCorrect
isCorrect boolean
expectedAnswer
expectedAnswer string

Valori restituiti

Corpo
QuestionDto

Aggiungere una domanda di quiz a un modulo

Crea una nuova domanda del quiz all'interno del modulo specificato.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID modulo
moduleId True uuid

ID modulo

type
type True string
text
text True string
ordinalNumber
ordinalNumber integer
text
text True string
isCorrect
isCorrect boolean
expectedAnswer
expectedAnswer string

Valori restituiti

Corpo
QuestionDto

Aggiungere una domanda in lezione

il tipo deve essere MULTIPLE_CHOICE (richiede opzioni) o OPEN_ENDED

Parametri

Nome Chiave Necessario Tipo Descrizione
ID lezione
lessonId True uuid

ID lezione

type
type True string
text
text True string
ordinalNumber
ordinalNumber integer
text
text True string
isCorrect
isCorrect boolean
expectedAnswer
expectedAnswer string

Valori restituiti

Corpo
QuestionDto

Aggiungere una lezione a un byte di apprendimento

Crea una nuova lezione all'interno del byte di apprendimento specificato.

Parametri

Nome Chiave Necessario Tipo Descrizione
Lb Id
lbId True uuid

Lb Id

contenuto
content True string

Valori restituiti

Annullare l'assegnazione di un documento da un esperto

Idempotente

Parametri

Nome Chiave Necessario Tipo Descrizione
Id
id True uuid

Id

ID documento
documentId True uuid

ID documento

Annullare l'assegnazione di un utente da un ruolo

Idempotente — 204 anche se non è stato assegnato

Parametri

Nome Chiave Necessario Tipo Descrizione
Id
id True uuid

Id

ID ruolo
roleId True uuid

ID ruolo

ID utente
userId True uuid

ID utente

Assegnare documenti a un esperto

Collegare in blocco i documenti all'esperto. Idempotente.

Parametri

Nome Chiave Necessario Tipo Descrizione
Id
id True uuid

Id

documentIds
documentIds True array of uuid

Valori restituiti

Assegnare ruoli a un corso

Additive: i ruoli già assegnati vengono ignorati. Restituisce i dettagli del corso aggiornato

Parametri

Nome Chiave Necessario Tipo Descrizione
Id
id True uuid

Id

roleIds
roleIds True array of uuid

Valori restituiti

Assegnare ruoli a un esperto

Additivi : i ruoli già assegnati vengono mantenuti; quelli nuovi accodati. Restituisce un esperto aggiornato

Parametri

Nome Chiave Necessario Tipo Descrizione
Id
id True uuid

Id

roleIds
roleIds True array of uuid

Valori restituiti

Assegnare un utente a un ruolo

Idempotente

Parametri

Nome Chiave Necessario Tipo Descrizione
Id
id True uuid

Id

ID ruolo
roleId True uuid

ID ruolo

userId
userId True uuid

Valori restituiti

Attivare la generazione di contenuti di intelligenza artificiale per argomenti

Accoda la generazione di contenuti di intelligenza artificiale per gli argomenti specificati all'interno del corso

Parametri

Nome Chiave Necessario Tipo Descrizione
Id
id True uuid

Id

topicIds
topicIds True array of uuid

Valori restituiti

Attivare o disattivare la disponibilità agli studenti

Impostare se la formazione demo viene pubblicata per gli studenti. Idempotente.

Parametri

Nome Chiave Necessario Tipo Descrizione
Id
id True uuid

Id

available
available True boolean

Valori restituiti

Caricare un documento

Caricamento in più parti (file e descrizione facoltativa). Massimo 50 MB.

Parametri

Nome Chiave Necessario Tipo Descrizione
File
file True file

File

Description
description string

Description

Valori restituiti

Caricare un elemento multimediale

Caricamento in più parti (file e descrizione facoltativa). Massimo 50 MB per le immagini, 500 MB per i video.

Parametri

Nome Chiave Necessario Tipo Descrizione
File
file True file

File

Description
description string

Description

Valori restituiti

Collegare documenti a un argomento

Additivi: i documenti già collegati vengono ignorati

Parametri

Nome Chiave Necessario Tipo Descrizione
ID argomento
topicId True uuid

ID argomento

documentIds
documentIds True array of uuid

Creare un corso vuoto

Crea una nuova shell dei corsi con il nome specificato

Parametri

Nome Chiave Necessario Tipo Descrizione
nome
name True string

Valori restituiti

Creare un reparto

Crea un nuovo reparto nella società del chiamante.

Parametri

Nome Chiave Necessario Tipo Descrizione
nome
name True string
description
description string

Valori restituiti

Creare un ruolo all'interno di un reparto

Crea un nuovo ruolo con ambito per il reparto specificato.

Parametri

Nome Chiave Necessario Tipo Descrizione
Id
id True uuid

Id

nome
name True string
nomeCompleto
fullName string
description
description string

Valori restituiti

Creare un training dimostrativo

Crea un training demo da un file video caricato in precedenza e avvia l'elaborazione

Parametri

Nome Chiave Necessario Tipo Descrizione
nome
name True string
description
description string
trainingType
trainingType True string
videoFileId
videoFileId True uuid
departmentId
departmentId uuid
processingPrompt
processingPrompt string

Valori restituiti

Creare un utente

Crea un utente e attiva il flusso di invito magic-link

Parametri

Nome Chiave Necessario Tipo Descrizione
email
email True email
firstName
firstName string
lastName
lastName string
isAdmin
isAdmin boolean
departmentRoleIds
departmentRoleIds array of uuid

Valori restituiti

Corpo
UserDto

Dettagli certificato

Restituisce un certificato con ambito alla società del chiamante

Parametri

Nome Chiave Necessario Tipo Descrizione
Id
id True uuid

Id

Valori restituiti

Disattivare un utente

Idempotente: restituisce l'utente anche se già disattivato

Parametri

Nome Chiave Necessario Tipo Descrizione
Id
id True uuid

Id

Valori restituiti

Corpo
UserDto

Elencare gli argomenti in un modulo

Restituisce gli argomenti attivi ordinati per ordinalNumber

Parametri

Nome Chiave Necessario Tipo Descrizione
ID modulo
moduleId True uuid

ID modulo

Valori restituiti

Elencare gli esercizi in un argomento

Tipi misti (ILE_TEXT/RPE_VOICE/RPE_VIDEO) ordinati per ordinalNumber

Parametri

Nome Chiave Necessario Tipo Descrizione
ID argomento
topicId True uuid

ID argomento

Valori restituiti

Elencare gli esperti

Elenco impaginato di esperti nella società del chiamante

Parametri

Nome Chiave Necessario Tipo Descrizione
Pagina
page integer

Pagina

Dimensione
size integer

Dimensione

Search
search string

Search

Valori restituiti

Elencare gli utenti

Elenco impaginato di utenti nella società del chiamante

Parametri

Nome Chiave Necessario Tipo Descrizione
Pagina
page integer

Pagina

Dimensione
size integer

Dimensione

Search
search string

Search

Status
status string

Status

ID reparto
departmentIds string

ID reparto

ID ruolo
roleIds string

ID ruolo

Kind
kind string

Kind

Valori restituiti

Elencare i byte di apprendimento in un argomento

Restituisce i byte di apprendimento che appartengono all'argomento specificato.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID argomento
topicId True uuid

ID argomento

Valori restituiti

Elencare i certificati di uno studente

Restituisce i certificati ottenuti dallo studente specificato all'interno della società del chiamante

Parametri

Nome Chiave Necessario Tipo Descrizione
ID utente
userId True uuid

ID utente

Valori restituiti

Elencare i corsi

Elenco impaginato di corsi nell'azienda del chiamante

Parametri

Nome Chiave Necessario Tipo Descrizione
Pagina
page integer

Pagina

Dimensione
size integer

Dimensione

Search
search string

Search

Status
status string

Status

ID ruolo reparto
departmentRoleIds string

ID ruolo reparto

Valori restituiti

Elencare i documenti

Elenco impaginato di documenti nella società del chiamante

Parametri

Nome Chiave Necessario Tipo Descrizione
Pagina
page integer

Pagina

Dimensione
size integer

Dimensione

Search
search string

Search

Tipi mime
mimeTypes string

Tipi mime

Status
status string

Status

Valori restituiti

Elencare i documenti collegati a un argomento

Impaginato; ricerca facoltativa in base al nome del documento

Parametri

Nome Chiave Necessario Tipo Descrizione
ID argomento
topicId True uuid

ID argomento

Pagina
page integer

Pagina

Dimensione
size integer

Dimensione

Search
search string

Search

Valori restituiti

Elencare i moduli in un corso

Restituisce i moduli attivi ordinati per ordinalNumber

Parametri

Nome Chiave Necessario Tipo Descrizione
ID corso
courseId True uuid

ID corso

Valori restituiti

Elencare i reparti

Tutti i reparti dell'azienda del chiamante con ruoli annidati

Valori restituiti

Elencare i supporti

Elenco impaginato di elementi multimediali nell'azienda del chiamante

Parametri

Nome Chiave Necessario Tipo Descrizione
Pagina
page integer

Pagina

Dimensione
size integer

Dimensione

Search
search string

Search

Kind
kind string

Kind

Status
status string

Status

Valori restituiti

Elencare i training demo

Elenco impaginato con ambito della società del chiamante

Parametri

Nome Chiave Necessario Tipo Descrizione
Pagina
page integer

Pagina

Dimensione
size integer

Dimensione

Search
search string

Search

Tipi di training
trainingTypes string

Tipi di training

Stati
statuses string

Stati

ID reparto
departmentIds string

ID reparto

È disponibile
isAvailable boolean

È disponibile

Valori restituiti

Elencare le domande in lezione

Restituisce le domande di verifica delle conoscenze associate alla lezione specificata.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID lezione
lessonId True uuid

ID lezione

Valori restituiti

Elencare le domande sui quiz in un modulo

Restituisce le domande del quiz associate al modulo specificato.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID modulo
moduleId True uuid

ID modulo

Valori restituiti

Elencare le domande sui quiz su un argomento

Restituisce le domande del quiz associate all'argomento specificato.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID argomento
topicId True uuid

ID argomento

Valori restituiti

Elencare le lezioni in un byte di apprendimento

Restituisce lezioni che appartengono al byte di apprendimento specificato.

Parametri

Nome Chiave Necessario Tipo Descrizione
Lb Id
lbId True uuid

Lb Id

Valori restituiti

Elencare le versioni dei corsi

Restituisce i metadati della versione pubblicata (conteggi e informazioni di pubblicazione) ordinati in base al numero di versione

Parametri

Nome Chiave Necessario Tipo Descrizione
ID corso
courseId True uuid

ID corso

Valori restituiti

Eliminare (disattivare) un documento

Idempotente : restituisce il 204 anche se il documento è già stato eliminato o mancante

Parametri

Nome Chiave Necessario Tipo Descrizione
Id
id True uuid

Id

Eliminare (disattivare) un elemento multimediale

Idempotente : restituisce 204 anche se l'elemento è già stato eliminato o mancante

Parametri

Nome Chiave Necessario Tipo Descrizione
Id
id True uuid

Id

Eliminare (disattivare) un reparto

Idempotente : restituisce il 204 anche se già disattivato. Si propaga alle assegnazioni di ruolo.

Parametri

Nome Chiave Necessario Tipo Descrizione
Id
id True uuid

Id

Eliminare (soft) un corso

Idempotente — restituisce il 204 anche se il corso è già stato rimosso

Parametri

Nome Chiave Necessario Tipo Descrizione
Id
id True uuid

Id

Eliminare un argomento (soft)

Idempotente : restituisce il 204 anche se l'argomento è già stato rimosso

Parametri

Nome Chiave Necessario Tipo Descrizione
ID argomento
topicId True uuid

ID argomento

Eliminare un byte di apprendimento (soft)

Idempotente — 204 anche se già rimosso

Parametri

Nome Chiave Necessario Tipo Descrizione
Lb Id
lbId True uuid

Lb Id

Eliminare un esercizio

Idempotente — 204 anche se già rimosso

Parametri

Nome Chiave Necessario Tipo Descrizione
Id
id True uuid

Id

Eliminare un modulo (soft)

Idempotente: restituisce 204 anche se il modulo è già stato rimosso

Parametri

Nome Chiave Necessario Tipo Descrizione
ID modulo
moduleId True uuid

ID modulo

Eliminare un training dimostrativo

Idempotente : restituisce il 204 anche se il training demo non esiste o è già scomparso

Parametri

Nome Chiave Necessario Tipo Descrizione
Id
id True uuid

Id

Eliminare una domanda del quiz in un modulo

Idempotente — 204 anche se già rimosso

Parametri

Nome Chiave Necessario Tipo Descrizione
ID modulo
moduleId True uuid

ID modulo

ID domanda
questionId True uuid

ID domanda

Eliminare una domanda del quiz su un argomento

Idempotente — 204 anche se già rimosso

Parametri

Nome Chiave Necessario Tipo Descrizione
ID argomento
topicId True uuid

ID argomento

ID domanda
questionId True uuid

ID domanda

Eliminare una domanda in lezione

Idempotente — 204 anche se già rimosso

Parametri

Nome Chiave Necessario Tipo Descrizione
ID lezione
lessonId True uuid

ID lezione

ID domanda
questionId True uuid

ID domanda

Eliminare una lezione (soft)

Idempotente — 204 anche se già rimosso

Parametri

Nome Chiave Necessario Tipo Descrizione
ID lezione
lessonId True uuid

ID lezione

Eventi di attività per studente

Flusso di eventi forward-only impaginato

Parametri

Nome Chiave Necessario Tipo Descrizione
ID utente
userId True uuid

ID utente

Pagina
page integer

Pagina

Dimensione
size integer

Dimensione

Valori restituiti

Generare un corso completo con contenuto di intelligenza artificiale

Crea la shell dei corsi, tutti i moduli, tutti gli argomenti e accoda la generazione di contenuti di intelligenza artificiale per ogni argomento

Parametri

Nome Chiave Necessario Tipo Descrizione
nome
name True string
description
description string
nome
name True string
description
description string
nome
name True string
description
description string

Valori restituiti

Impostare il numero di quiz degli argomenti per un tipo di domanda

Sostituisce il conteggio per il tipo di domanda specificato (MULTIPLE_CHOICE o OPEN_ENDED). Il conteggio di altri tipi viene mantenuto

Parametri

Nome Chiave Necessario Tipo Descrizione
ID argomento
topicId True uuid

ID argomento

questionType
questionType True string
count
count integer

Valori restituiti

Corpo
TopicDto

Impostare il numero di quiz del modulo per un tipo di domanda

Sostituisce il conteggio per il tipo di domanda specificato (MULTIPLE_CHOICE o OPEN_ENDED). Il conteggio di altri tipi viene mantenuto

Parametri

Nome Chiave Necessario Tipo Descrizione
ID modulo
moduleId True uuid

ID modulo

questionType
questionType True string
count
count integer

Valori restituiti

Impostare o sostituire un argomento introduttivo

Upsert : crea se mancante, sostituisce se presente

Parametri

Nome Chiave Necessario Tipo Descrizione
ID argomento
topicId True uuid

ID argomento

introduzione
introduction string

Valori restituiti

Corpo
IntroDto

Impostare o sostituire un modulo introduttivo

Upsert : crea se mancante, sostituisce se presente

Parametri

Nome Chiave Necessario Tipo Descrizione
ID modulo
moduleId True uuid

ID modulo

introduzione
introduction string

Valori restituiti

Corpo
IntroDto

Informazioni dettagliate a livello aziendale

Indicatori KPI top line per l'azienda del chiamante

Valori restituiti

Informazioni dettagliate per studente

Riepilogo aggregato e scomposizione per corso per la finestra specificata

Parametri

Nome Chiave Necessario Tipo Descrizione
ID utente
userId True uuid

ID utente

Window
window string

Window

Valori restituiti

Introduzione a un argomento

Restituisce il testo introduttivo impostato sull'argomento specificato.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID argomento
topicId True uuid

ID argomento

Valori restituiti

Corpo
IntroDto

Introduzione a un modulo

Restituisce il testo introduttivo impostato nel modulo specificato.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID modulo
moduleId True uuid

ID modulo

Valori restituiti

Corpo
IntroDto

Ottenere lo stato di generazione dell'intelligenza artificiale per un corso

Restituisce l'elenco delle richieste di generazione di intelligenza artificiale attive per il corso con informazioni sullo stato e sulla destinazione

Parametri

Nome Chiave Necessario Tipo Descrizione
Id
id True uuid

Id

Valori restituiti

Ottenere un argomento

Restituisce i dettagli dell'argomento per l'ID specificato.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID argomento
topicId True uuid

ID argomento

Valori restituiti

Corpo
TopicDto

Ottenere un byte di apprendimento

Restituisce metadati e lezioni annidate

Parametri

Nome Chiave Necessario Tipo Descrizione
Lb Id
lbId True uuid

Lb Id

Valori restituiti

Ottenere un corso

Restituisce i metadati del corso con riepiloghi dei moduli e ruoli/reparti assegnati

Parametri

Nome Chiave Necessario Tipo Descrizione
Id
id True uuid

Id

Valori restituiti

Ottenere un elemento multimediale

Restituisce i metadati multimediali e un URL di download firmato di breve durata

Parametri

Nome Chiave Necessario Tipo Descrizione
Id
id True uuid

Id

Valori restituiti

Ottenere un esercizio

Restituisce i dettagli dell'esercizio per l'ID specificato.

Parametri

Nome Chiave Necessario Tipo Descrizione
Id
id True uuid

Id

Valori restituiti

Corpo
ExerciseDto

Ottenere un esperto

Restituisce metadati esperti, documenti collegati e ruoli/reparti assegnati

Parametri

Nome Chiave Necessario Tipo Descrizione
Id
id True uuid

Id

Valori restituiti

Ottenere un modulo

Restituisce i dettagli del modulo per l'ID specificato.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID modulo
moduleId True uuid

ID modulo

Valori restituiti

Ottenere un training dimostrativo

Restituisce il training demo completo con segmenti

Parametri

Nome Chiave Necessario Tipo Descrizione
Id
id True uuid

Id

Valori restituiti

Ottenere un utente

Restituisce i metadati utente e le assegnazioni di reparto/ruolo

Parametri

Nome Chiave Necessario Tipo Descrizione
Id
id True uuid

Id

Valori restituiti

Corpo
UserDto

Ottenere una domanda del quiz su un argomento

Restituisce una singola domanda del quiz collegata all'argomento specificato.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID argomento
topicId True uuid

ID argomento

ID domanda
questionId True uuid

ID domanda

Valori restituiti

Corpo
QuestionDto

Ottenere una domanda di quiz su un modulo

Restituisce una singola domanda del quiz collegata al modulo specificato.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID modulo
moduleId True uuid

ID modulo

ID domanda
questionId True uuid

ID domanda

Valori restituiti

Corpo
QuestionDto

Ottenere una domanda in lezione

Restituisce una singola domanda in lezione in base al relativo ID.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID lezione
lessonId True uuid

ID lezione

ID domanda
questionId True uuid

ID domanda

Valori restituiti

Corpo
QuestionDto

Ottenere una lezione

Restituisce contenuti, contenuti multimediali e domande in lezione

Parametri

Nome Chiave Necessario Tipo Descrizione
ID lezione
lessonId True uuid

ID lezione

Valori restituiti

Ottenere uno snapshot della versione del corso

Restituisce l'albero del contenuto completo (moduli, argomenti, lezioni, esercizi, domande) per la versione specificata

Parametri

Nome Chiave Necessario Tipo Descrizione
ID corso
courseId True uuid

ID corso

Numero di versione
versionNumber True integer

Numero di versione

Valori restituiti

Porre una domanda a un esperto

Wrapper sincrono intorno alla chat di intelligenza artificiale in streaming. Restituisce la risposta assemblata.

Parametri

Nome Chiave Necessario Tipo Descrizione
Id
id True uuid

Id

domanda
question True string

Valori restituiti

Corpo
AskResponse

Pubblicare un corso

Pubblica il corso; ha esito negativo con 400 se non ha contenuto pubblicabile

Parametri

Nome Chiave Necessario Tipo Descrizione
Id
id True uuid

Id

Valori restituiti

Recupera un documento

Restituisce i metadati del documento e un URL di download firmato di breve durata

Parametri

Nome Chiave Necessario Tipo Descrizione
Id
id True uuid

Id

Valori restituiti

Riattivare un utente

Idempotente: restituisce l'utente anche se già attivo

Parametri

Nome Chiave Necessario Tipo Descrizione
Id
id True uuid

Id

Valori restituiti

Corpo
UserDto

Riesegua l'elaborazione video

Invia nuovamente il video per la segmentazione di intelligenza artificiale. Facoltativamente, eseguire l'override del prompt di elaborazione.

Parametri

Nome Chiave Necessario Tipo Descrizione
Id
id True uuid

Id

processingPrompt
processingPrompt string

Valori restituiti

Rigenerare un elemento specifico tramite intelligenza artificiale

Rigenera una singola lezione, domande di lezione, quiz, intro o esercizio

Parametri

Nome Chiave Necessario Tipo Descrizione
target
target True string
targetId
targetId True uuid
parentType
parentType string

Valori restituiti

Rimuovere tutte le assegnazioni di ruolo da un corso

Idempotente

Parametri

Nome Chiave Necessario Tipo Descrizione
Id
id True uuid

Id

Rimuovere tutte le assegnazioni di ruolo da un esperto

Idempotente

Parametri

Nome Chiave Necessario Tipo Descrizione
Id
id True uuid

Id

Rimuovere un'assegnazione di ruolo da un corso

Idempotente

Parametri

Nome Chiave Necessario Tipo Descrizione
Id
id True uuid

Id

ID ruolo
roleId True uuid

ID ruolo

Rimuovere un'assegnazione di ruolo da un esperto

Idempotente

Parametri

Nome Chiave Necessario Tipo Descrizione
Id
id True uuid

Id

ID ruolo
roleId True uuid

ID ruolo

Rimuovere un'introduzione a un argomento

Idempotente — 204 anche se non è impostata alcuna introduzione

Parametri

Nome Chiave Necessario Tipo Descrizione
ID argomento
topicId True uuid

ID argomento

Rimuovere un'introduzione a un modulo

Idempotente — 204 anche se non è impostata alcuna introduzione

Parametri

Nome Chiave Necessario Tipo Descrizione
ID modulo
moduleId True uuid

ID modulo

Riordinare gli argomenti all'interno di un modulo

topicIds deve includere ogni argomento attivo una sola volta, nel nuovo ordine

Parametri

Nome Chiave Necessario Tipo Descrizione
ID modulo
moduleId True uuid

ID modulo

topicIds
topicIds True array of uuid

Valori restituiti

Riordinare i moduli in un corso

moduleIds deve includere ogni modulo attivo esattamente una volta, nel nuovo ordine

Parametri

Nome Chiave Necessario Tipo Descrizione
ID corso
courseId True uuid

ID corso

moduleIds
moduleIds True array of uuid

Valori restituiti

Riordinare le domande in lezione

questionIds deve includere ogni domanda attiva per la lezione, nel nuovo ordine

Parametri

Nome Chiave Necessario Tipo Descrizione
ID lezione
lessonId True uuid

ID lezione

questionIds
questionIds True array of uuid

Valori restituiti

Riordinare le domande sui quiz in un modulo

questionIds deve includere ogni domanda del quiz attiva per il modulo, nel nuovo ordine.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID modulo
moduleId True uuid

ID modulo

questionIds
questionIds True array of uuid

Valori restituiti

Riordinare le domande sui quiz su un argomento

questionIds deve includere ogni domanda del quiz attiva per l'argomento, nel nuovo ordine.

Parametri

Nome Chiave Necessario Tipo Descrizione
ID argomento
topicId True uuid

ID argomento

questionIds
questionIds True array of uuid

Valori restituiti

Scaricare il pdf del certificato

Trasmette il file PDF del certificato. Restituisce 404 se il certificato non ha ancora un PDF

Parametri

Nome Chiave Necessario Tipo Descrizione
Id
id True uuid

Id

Valori restituiti

Scollegare un documento da un argomento

Idempotente

Parametri

Nome Chiave Necessario Tipo Descrizione
ID argomento
topicId True uuid

ID argomento

ID documento
documentId True uuid

ID documento

Sostituire il file binario del documento

Sostituisce il file binario di un documento esistente; i metadati vengono mantenuti

Parametri

Nome Chiave Necessario Tipo Descrizione
Id
id True uuid

Id

File
file True file

File

Valori restituiti

Sostituire il file binario multimediale

Sostituisce il file binario di un elemento multimediale esistente; i metadati vengono mantenuti

Parametri

Nome Chiave Necessario Tipo Descrizione
Id
id True uuid

Id

File
file True file

File

Valori restituiti

Spostare un argomento in un altro modulo

targetOrdinalNumber è facoltativo; se omesso, l'argomento viene aggiunto al modulo di destinazione

Parametri

Nome Chiave Necessario Tipo Descrizione
ID argomento
topicId True uuid

ID argomento

targetModuleId
targetModuleId True uuid
targetOrdinalNumber
targetOrdinalNumber integer

Valori restituiti

Corpo
TopicDto

Definizioni

QuizSettingDto

Nome Percorso Tipo Descrizione
questionType
questionType string
count
count integer

ArgomentoDto

Nome Percorso Tipo Descrizione
id
id uuid
moduleId
moduleId uuid
nome
name string
description
description string
ordinalNumber
ordinalNumber integer
hasContent
hasContent boolean
quizSettings
quizSettings array of QuizSettingDto

IntroDto

Nome Percorso Tipo Descrizione
id
id uuid
componentId
componentId uuid
componentType
componentType string
introduzione
introduction string
source
source string
createdAt
createdAt date-time
updatedAt
updatedAt date-time

ModuleDetailDto

Nome Percorso Tipo Descrizione
id
id uuid
courseId
courseId uuid
nome
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

Nome Percorso Tipo Descrizione
id
id uuid
nome
name string
description
description string
kind
kind string
tipo MIME
mimeType string
sizeBytes
sizeBytes integer
stato
status string
processingStatus
processingStatus string
createdAt
createdAt date-time
uploadBy
uploadedBy UploadedByDto
scaricaUrl
downloadUrl string

UploadedByDto

Nome Percorso Tipo Descrizione
id
id uuid
kind
kind string
nome
name string

DocumentDetailDto

Nome Percorso Tipo Descrizione
id
id uuid
nome
name string
description
description string
tipo MIME
mimeType string
sizeBytes
sizeBytes integer
stato
status string
createdAt
createdAt date-time
uploadBy
uploadedBy UploadedByDto
scaricaUrl
downloadUrl string

DepartmentRoleDto

Nome Percorso Tipo Descrizione
departmentId
departmentId uuid
nomeDipartimento
departmentName string
roleId
roleId uuid
nomeruolo
roleName string

UserDto

Nome Percorso Tipo Descrizione
id
id uuid
email
email string
firstName
firstName string
lastName
lastName string
stato
status string
kind
kind string
isAdmin
isAdmin boolean
createdAt
createdAt date-time
departmentRoles
departmentRoles array of DepartmentRoleDto

QuestionDto

Nome Percorso Tipo Descrizione
id
id uuid
type
type string
parentId
parentId uuid
parentType
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

Nome Percorso Tipo Descrizione
text
text string
isCorrect
isCorrect boolean
ordinalNumber
ordinalNumber integer

QuestionListResponse

Nome Percorso Tipo Descrizione
elementi
items array of QuestionDto

LearningByteDetailDto

Nome Percorso Tipo Descrizione
id
id uuid
topicId
topicId uuid
nome
name string
description
description string
ordinalNumber
ordinalNumber integer
source
source string
createdAt
createdAt date-time
updatedAt
updatedAt date-time
lezioni
lessons array of LessonDto

LessonDto

Nome Percorso Tipo Descrizione
id
id uuid
learningByteId
learningByteId uuid
contenuto
content string
ordinalNumber
ordinalNumber integer
source
source string
questionCount
questionCount integer
mediaCount
mediaCount integer
createdAt
createdAt date-time
updatedAt
updatedAt date-time

ExerciseDto

Nome Percorso Tipo Descrizione
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

EsercizioGeneratedContentDto

Nome Percorso Tipo Descrizione
id
id uuid
rigenerazioneId
regenerationId uuid
situazione
scenario string
traineeRole
traineeRole string
avatarName
avatarName string
avatarDescription
avatarDescription string
operationalChallenge
operationalChallenge string
successMetric
successMetric string
istruzione
instruction string
instructionReverse
instructionReverse string
exerciseKnowledgeBase
exerciseKnowledgeBase string
topicKnowledgeBase
topicKnowledgeBase string

TopicListResponse

Nome Percorso Tipo Descrizione
elementi
items array of TopicDto

LessonDetailDto

Nome Percorso Tipo Descrizione
id
id uuid
learningByteId
learningByteId uuid
contenuto
content string
ordinalNumber
ordinalNumber integer
source
source string
createdAt
createdAt date-time
updatedAt
updatedAt date-time
media
media array of MediaLinkDto
Domande
questions array of QuestionDto

MediaLinkDto

Nome Percorso Tipo Descrizione
id
id uuid
fileId
fileId uuid
ordinalNumber
ordinalNumber integer
source
source string

ExpertDetailDto

Nome Percorso Tipo Descrizione
id
id uuid
nome
name string
description
description string
stato
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

Nome Percorso Tipo Descrizione
id
id uuid
nome
name string
extension
extension string
sizeBytes
sizeBytes integer
description
description string
linkedAt
linkedAt date-time

AskResponse

Nome Percorso Tipo Descrizione
risposta
answer string
durationMs
durationMs integer

DepartmentDto

Nome Percorso Tipo Descrizione
id
id uuid
nome
name string
description
description string
stato
status string
createdAt
createdAt date-time
roles
roles array of DepartmentRoleDto

DemoTrainingDto

Nome Percorso Tipo Descrizione
id
id uuid
companyId
companyId uuid
departmentId
departmentId uuid
nome
name string
description
description string
trainingType
trainingType string
stato
status string
èDisponibile
isAvailable boolean
videoFileId
videoFileId uuid
processingPrompt
processingPrompt string
errorMessage
errorMessage string
assignedRoleIds
assignedRoleIds array of uuid
Segmenti
segments array of DemoTrainingSegmentDto
createdAt
createdAt date-time
updatedAt
updatedAt date-time

DemoTrainingSegmentDto

Nome Percorso Tipo Descrizione
id
id uuid
ordinalNumber
ordinalNumber integer
nome
name string
Trascrizione
transcript string
durataSecondi
durationSeconds integer

CourseDetailDto

Nome Percorso Tipo Descrizione
id
id uuid
nome
name string
stato
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

Nome Percorso Tipo Descrizione
id
id uuid
nome
name string
ordinalNumber
ordinalNumber integer
topicCount
topicCount integer

GenerationRequestResponse

Nome Percorso Tipo Descrizione
id
id uuid
stato
status string

ModuleDto

Nome Percorso Tipo Descrizione
id
id uuid
courseId
courseId uuid
nome
name string
description
description string
productId
productId uuid
ordinalNumber
ordinalNumber integer
lockedForGeneration
lockedForGeneration boolean
topicCount
topicCount integer
quizSettings
quizSettings array of QuizSettingDto

ModuleListResponse

Nome Percorso Tipo Descrizione
elementi
items array of ModuleDto

GenerateCourseResponse

Nome Percorso Tipo Descrizione
courseId
courseId uuid
generationRequestId
generationRequestId uuid

PageInfo

Nome Percorso Tipo Descrizione
size
size integer
Numero
number integer
totalElements
totalElements integer
pagine totali
totalPages integer

UserListResponse

Nome Percorso Tipo Descrizione
elementi
items array of UserDto
pagina
page PageInfo

TopicLinkedDocumentDto

Nome Percorso Tipo Descrizione
id
id uuid
nome
name string
extension
extension string
size
size integer
processingStatus
processingStatus string
description
description string
source
source string
linkType
linkType string
linkedAt
linkedAt date-time

TopicLinkedDocumentListResponse

Nome Percorso Tipo Descrizione
elementi
items array of TopicLinkedDocumentDto
pagina
page PageInfo

LearningByteDto

Nome Percorso Tipo Descrizione
id
id uuid
topicId
topicId uuid
nome
name string
description
description string
ordinalNumber
ordinalNumber integer
source
source string
lessonCount
lessonCount integer
createdAt
createdAt date-time
updatedAt
updatedAt date-time

LearningByteListResponse

Nome Percorso Tipo Descrizione
elementi
items array of LearningByteDto

ExerciseListResponse

Nome Percorso Tipo Descrizione
elementi
items array of ExerciseDto

CertificateDto

Nome Percorso Tipo Descrizione
id
id uuid
ID iscrizione
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
emessoAt
issuedAt date-time
pdfFileId
pdfFileId uuid
pdfAvailable
pdfAvailable boolean

CertificateListResponse

Nome Percorso Tipo Descrizione
elementi
items array of CertificateDto

MediaDto

Nome Percorso Tipo Descrizione
id
id uuid
nome
name string
description
description string
kind
kind string
tipo MIME
mimeType string
sizeBytes
sizeBytes integer
stato
status string
processingStatus
processingStatus string
createdAt
createdAt date-time
uploadBy
uploadedBy UploadedByDto

MediaListResponse

Nome Percorso Tipo Descrizione
elementi
items array of MediaDto
pagina
page PageInfo

LessonListResponse

Nome Percorso Tipo Descrizione
elementi
items array of LessonDto

CourseBreakdownDto

Nome Percorso Tipo Descrizione
courseId
courseId uuid
courseName
courseName string
progressPercent
progressPercent integer
hoursSpent
hoursSpent double
startedAt
startedAt date-time
completedAt
completedAt date-time

StudentInsightsDto

Nome Percorso Tipo Descrizione
userId
userId uuid
finestra
window WindowDto
summary
summary StudentSummaryDto
byCourse
byCourse array of CourseBreakdownDto

StudentSummaryDto

Nome Percorso Tipo Descrizione
activeDays
activeDays integer
lezioniCompleted
lessonsCompleted integer
exercisesCompleted
exercisesCompleted integer
quizzesPassed
quizzesPassed integer
hoursSpent
hoursSpent double

WindowDto

Nome Percorso Tipo Descrizione
kind
kind string
da
from date-time
to
to date-time

EventItemDto

Nome Percorso Tipo Descrizione
id
id uuid
kind
kind string
azione
action string
courseId
courseId uuid
courseName
courseName string
si è verificatoAt
occurredAt date-time

EventListResponse

Nome Percorso Tipo Descrizione
elementi
items array of EventItemDto
pagina
page PageInfo

CompanyInsightsDto

Nome Percorso Tipo Descrizione
companyId
companyId uuid
summary
summary CompanySummaryDto

CompanySummaryDto

Nome Percorso Tipo Descrizione
totalStudents
totalStudents integer
averageProgressPercent
averageProgressPercent integer
activeThisWeekCount
activeThisWeekCount integer
completedCount
completedCount integer
completionRatePercent
completionRatePercent integer

ExpertDto

Nome Percorso Tipo Descrizione
id
id uuid
nome
name string
description
description string
stato
status string
linkedDocumentCount
linkedDocumentCount integer
createdAt
createdAt date-time
updatedAt
updatedAt date-time

ExpertListResponse

Nome Percorso Tipo Descrizione
elementi
items array of ExpertDto
pagina
page PageInfo

DocumentDto

Nome Percorso Tipo Descrizione
id
id uuid
nome
name string
description
description string
tipo MIME
mimeType string
sizeBytes
sizeBytes integer
stato
status string
createdAt
createdAt date-time
uploadBy
uploadedBy UploadedByDto

DocumentListResponse

Nome Percorso Tipo Descrizione
elementi
items array of DocumentDto
pagina
page PageInfo

DepartmentListResponse

Nome Percorso Tipo Descrizione
elementi
items array of DepartmentDto

DemoTrainingListItemDto

Nome Percorso Tipo Descrizione
id
id uuid
departmentId
departmentId uuid
videoFileId
videoFileId uuid
nome
name string
description
description string
trainingType
trainingType string
stato
status string
èDisponibile
isAvailable boolean
assignedRoleIds
assignedRoleIds array of uuid
segmentCount
segmentCount integer
durataSecondi
durationSeconds integer
createdAt
createdAt date-time

DemoTrainingListResponse

Nome Percorso Tipo Descrizione
elementi
items array of DemoTrainingListItemDto
pagina
page PageInfo

CourseDto

Nome Percorso Tipo Descrizione
id
id uuid
nome
name string
stato
status string
moduleCount
moduleCount integer
topicCount
topicCount integer
hasUnpublishedChanges
hasUnpublishedChanges boolean
currentVersionNumber
currentVersionNumber integer
latestPublishedAt
latestPublishedAt date-time
createdAt
createdAt date-time

CourseListResponse

Nome Percorso Tipo Descrizione
elementi
items array of CourseDto
pagina
page PageInfo

GenerationProgressDto

Nome Percorso Tipo Descrizione
totalTasks
totalTasks integer
completedTasks
completedTasks integer
failedTasks
failedTasks integer

GenerationRequestInfoDto

Nome Percorso Tipo Descrizione
id
id uuid
stato
status string
createdAt
createdAt string
completedAt
completedAt string
Errore
error string
Avanzamento
progress GenerationProgressDto
target
target string
targetId
targetId uuid
parentType
parentType string
topicIds
topicIds array of uuid
moduleIds
moduleIds array of uuid

GenerationStatusResponse

Nome Percorso Tipo Descrizione
activeRequests
activeRequests array of GenerationRequestInfoDto

CourseVersionDto

Nome Percorso Tipo Descrizione
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

Nome Percorso Tipo Descrizione
elementi
items array of CourseVersionDto

AuditSnapshot

Nome Percorso Tipo Descrizione
createdAt
createdAt date-time
creato da
createdBy uuid
updatedAt
updatedAt date-time
aggiornatoDa
updatedBy uuid

CourseSnapshot

Nome Percorso Tipo Descrizione
nome
name string
coverImageId
coverImageId uuid
prerequisiteCourseId
prerequisiteCourseId uuid
courseGuideline
courseGuideline string
lezioniGuideline
lessonsGuideline string
domandeGuideline
questionsGuideline string
exercisesGuideline
exercisesGuideline string
modules
modules array of ModuleSnapshot

CourseVersionSnapshotDto

Nome Percorso Tipo Descrizione
id
id uuid
courseId
courseId uuid
Versionnumber
versionNumber integer
snapshot
snapshot CourseSnapshot

ExerciseSnapshot

Nome Percorso Tipo Descrizione
id
id uuid
topicId
topicId uuid
exerciseType
exerciseType string
prompt
prompt string
ordinalNumber
ordinalNumber integer
isGenerated
isGenerated boolean
source
source string
revisione contabile
audit AuditSnapshot
avatarCharacteristics
avatarCharacteristics string
avatarPictureId
avatarPictureId uuid
reverseRolePlayEnabled
reverseRolePlayEnabled boolean
reverseRolePlayMandatory
reverseRolePlayMandatory boolean
situazione
scenario string
traineeRole
traineeRole string
avatarName
avatarName string
avatarDescription
avatarDescription string
operationalChallenge
operationalChallenge string
successMetric
successMetric string
istruzione
instruction string
instructionReverse
instructionReverse string
exerciseKnowledgeBase
exerciseKnowledgeBase string

LearningByteSnapshot

Nome Percorso Tipo Descrizione
id
id uuid
topicId
topicId uuid
nome
name string
description
description string
ordinalNumber
ordinalNumber integer
source
source string
revisione contabile
audit AuditSnapshot
lezioni
lessons array of LessonSnapshot

LessonSnapshot

Nome Percorso Tipo Descrizione
id
id uuid
learningByteId
learningByteId uuid
contenuto
content string
ordinalNumber
ordinalNumber integer
source
source string
revisione contabile
audit AuditSnapshot
media
media array of MediaSnapshot
Domande
questions array of QuestionSnapshot

LinkedDocumentSnapshot

Nome Percorso Tipo Descrizione
id
id uuid
fileId
fileId uuid
linkType
linkType string
isSupplement
isSupplement boolean
nome
name string
extension
extension string
size
size integer
description
description string

MediaSnapshot

Nome Percorso Tipo Descrizione
id
id uuid
fileId
fileId uuid
ordinalNumber
ordinalNumber integer
mediaType
mediaType string
source
source string

ModuleSnapshot

Nome Percorso Tipo Descrizione
id
id uuid
courseId
courseId uuid
productId
productId uuid
nome
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

OptionSnapshot

Nome Percorso Tipo Descrizione
id
id uuid
optionText
optionText string
isCorrect
isCorrect boolean
ordinalNumber
ordinalNumber integer

QuestionSnapshot

Nome Percorso Tipo Descrizione
id
id uuid
questionType
questionType string
questionText
questionText string
expectedAnswer
expectedAnswer string
ordinalNumber
ordinalNumber integer
source
source string
revisione contabile
audit AuditSnapshot
options
options array of OptionSnapshot

QuizSettingSnapshot

Nome Percorso Tipo Descrizione
questionType
questionType string
count
count integer

TopicSnapshot

Nome Percorso Tipo Descrizione
id
id uuid
moduleId
moduleId uuid
nome
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
esercizi
exercises array of ExerciseSnapshot
linkedDocuments
linkedDocuments array of LinkedDocumentSnapshot
topicKnowledgeBase
topicKnowledgeBase string

StreamingResponseBody