Máquina do Tempo (Pré-visualização)

A Time Machine é uma plataforma de aprendizagem corporativa alimentada por IA. Transforma documentos da empresa, vídeos e conhecimentos especializados em cursos estruturados com módulos, tópicos, questionários e exercícios de role-play, e acompanha o progresso do aprendiz. Construído para equipas de RH e L&D que integram, formam e certificam colaboradores em grande escala. O conector automatiza todo o ciclo de vida da aprendizagem: gere cursos, utilizadores, departamentos e funções; gerar questionários a partir de documentos; e análises de conclusão de leitura.

Este conector está disponível nos seguintes produtos e regiões:

Service	Class	Regiões
Estúdio Copiloto	Premium	Todas as regiões Power Automate exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas	Standard	Todas as regiões do Logic Apps , exceto as seguintes: - Regiões Azure Government - Regiões Azure China - Departamento de Defesa dos EUA (DoD)
Power Apps	Premium	Todas as regiões Power Apps exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Power Automate	Premium	Todas as regiões Power Automate exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)

Contact
Name	Suporte à Máquina do Tempo
URL	https://timeml.ai

Metadados do conector
Editora	IA da Máquina do Tempo
Sítio Web	https://timeml.ai
Política de privacidade	https://timeml.ai/privacy-policy
Categorias	Produtividade; IA

Time Machine — Conector Power Automate

O que é a Máquina do Tempo

A Time Machine é uma plataforma de aprendizagem organizacional alimentada por IA que ajuda as empresas a construir, operar e melhorar continuamente sistemas de aprendizagem adaptativa para equipas modernas. As organizações utilizam o Time Machine para transformar conhecimentos, documentos, gravações e fluxos de trabalho existentes em experiências de formação escaláveis que aceleram a integração, melhoram a preparação da força de trabalho e replicam a experiência de topo em toda a organização.

Os administradores de inquilinos gerem os utilizadores, conteúdos de aprendizagem, recursos organizacionais e configuração da plataforma através da API REST do Time Machine. Este conector expõe a API pública REST como ações do Power Automate, permitindo-lhe automatizar o provisionamento do utilizador, a ingestão de conteúdo, a sincronização de conhecimento e a gestão do ciclo de vida sem necessidade de escrever código.

Pré-requisitos

Um inquilino ativo do Time Machine com acesso de administrador
Uma chave API do Time Machine emitida pelas Definições → Chaves API no painel de administração (https://web.timeml.ai). A chave é um valor que começa por tm_live_.

Authentication

Cada ação autentica-se com uma chave API no Authorization cabeçalho. Ao criar uma ligação no Power Automate:

Campo: API key
Valor: colar Bearer tm_live_<your-token> (a cadeia completa, incluindo o Bearer prefixo e um espaço antes do token)

Ações disponíveis

O conector espelha a API pública REST do Time Machine (116 endpoints). As ações são agrupadas por recurso:

Cursos — listar / criar / atualizar / eliminar / publicar cursos, atribuir funções, gerar conteúdo criado por IA
Utilizadores — listar / criar / atualizar / desativar / reativar utilizadores
Documentos — listar / carregar / atualizar / eliminar documentos
Media — listar / carregar / atualizar / eliminar itens multimédia
Departamentos — listar / criar / atualizar / eliminar departamentos, gerir funções, atribuir utilizadores a funções
Especialistas — listem/criem perfis de especialistas, façam perguntas a especialistas, atribuam documentos e funções
Formações de demonstração — listar / criar / atualizar / eliminar formações de demonstração
Conteúdo do curso — módulos, tópicos, aulas, exercícios, perguntas de quiz
Insights — por aluno, por curso e análises a nível de empresa
Certificados — listar certificados de estudantes, descarregar PDFs de certificados

A referência completa do endpoint está disponível em https://api.timeml.ai/api/v1/docs.

Exemplos de fluxos de trabalho

Lançamento Confluence → Time Machine: Quando uma página de lançamento for publicada no Confluence, carregue-a como um Documento no Time Machine para que flua para a biblioteca de bytes de aprendizagem.
Integração de RH: Quando surgir uma nova linha de funcionário no seu HRIS, crie um utilizador do Time Machine com as atribuições do departamento e funções, ativando o convite mágico do link.
Notificações de conclusão de curso: Quando um estudante concluir um curso, envie um PDF de certificado para o Slack e registre a conclusão numa folha Google Sheet.

Limitações conhecidas

Rotação da chave API: as ligações devem ser atualizadas manualmente quando a chave API é rodada. Não existe mecanismo de atualização automática.
Uploads multipartes: ações de upload de ficheiros (Upload de Documento, Upload de Media) aceitam ficheiros até 50 MB. Para conteúdos maiores, divida-se em múltiplos carregamentos ou contacte o suporte da Time Machine.
Operações em lote: a API opera num registo de cada vez. Para ações em massa, utilize o controlo de aplicação a cada um incorporado do Power Automate.

Support

Para dúvidas ou problemas com o conector, contacte a equipa da sua conta Time Machine ou envie um email ao suporte para support@timeml.ai.

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:


Predefinição	Parâmetros para criar conexão.	Todas as regiões	Não compartilhável

Padrão

Aplicável: Todas as regiões

Parâmetros para criar conexão.

Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Name	Tipo	Description	Required
Chave API do Time Machine (formato: Portador tm_live_...)	securestring	A chave API do Time Machine (formato: Bearer tm_live_...) para esta API	Verdade

Ações

Adicionar um byte de aprendizagem a um tópico	Cria um novo byte de aprendizagem dentro do tópico dado.
Adicionar um tema a um módulo	Cria um novo tema dentro do módulo dado.
Adicionar uma lição a um byte de aprendizagem	Cria uma nova lição dentro do byte de aprendizagem dado.
Adicionar uma pergunta de quiz a um tema	Cria uma nova pergunta de quiz dentro do tópico dado.
Adicione um exercício ILE_TEXT a um tema	Cria um novo ILE_TEXT exercício dentro do tema em questão.
Adicione um exercício RPE_VIDEO a um tema	Cria um novo exercício RPE_VIDEO de role-play dentro do tema dado.
Adicione um exercício RPE_VOICE a um tema	Cria um novo exercício de role-play RPE_VOICE dentro do tema dado.
Adicione um módulo a um curso	Cria um novo módulo dentro do curso em questão.
Adicione uma pergunta de quiz a um módulo	Cria uma nova pergunta de quiz dentro do módulo dado.
Adicione uma pergunta durante a aula	O tipo deve ser MULTIPLE_CHOICE (requer opções) ou OPEN_ENDED
Alternar a disponibilidade para estudantes	Defina se a formação demonstrativa é publicada para os alunos. Idempotente.
Apagar (desativar) um documento	Idempotente — devolve 204 mesmo que o documento já esteja apagado ou em falta
Apagar (desativar) um elemento multimédia	Idempotente — devolve 204 mesmo que o item já esteja apagado ou em falta
Apagar um exercício	Idempotente — 204 mesmo que já removido
Apagar uma lição (suave)	Idempotente — 204 mesmo que já removido
Apagar uma pergunta de quiz num módulo	Idempotente — 204 mesmo que já removido
Apagar uma pergunta de quiz sobre um tema	Idempotente — 204 mesmo que já removido
Apagar uma pergunta durante a aula	Idempotente — 204 mesmo que já removido
Arranja um módulo	Devolve os detalhes do módulo para o ID indicado.
Arranja um tema	Devolve os detalhes do tópico para o ID indicado.
Atribuir documentos a um perito	Ligue em massa os documentos ao profissional. Idempotente.
Atribuir funções a um curso	Aditivo — as funções já atribuídas são saltadas. Devolve o detalhe atualizado do percurso
Atribuir funções a um especialista	Aditivo — os papéis já atribuídos são mantidos; Novas adicionadas. Devolve o especialista atualizado
Atribuir um utilizador a um papel	Idempotente
Atualizar metadados do curso	Atualizar o nome do curso
Atualizar metadados do documento	Atualizar nome e/ou descrição
Atualizar metadados do módulo	Atualiza o nome e/ou a descrição. Campos omitidos preservam os valores atuais
Atualizar metadados do tema	Atualiza o nome e/ou a descrição. Campos omitidos preservam os valores atuais
Atualizar metadados dos bytes de aprendizagem	Campos omitidos preservam os valores atuais
Atualizar metadados dos media	Atualizar nome e/ou descrição
Atualizar o conteúdo da aula	Conteúdo omitido preserva o valor atual
Atualizar um departamento	Atualizar nome e/ou descrição
Atualizar um exercício	Type-aware: ILE_TEXT só usa prompt + generationedContent.scenario; RPE_* utiliza todos os campos RPE. Campos omitidos preservam os valores atuais.
Atualizar um utilizador	Atualizar NomePróprio, ApelidoNome, Administrador e atribuições de funções. O email não é editável na v1.
Atualização de uma pergunta durante a aula	Fornecer campos que correspondam ao tipo armazenado; Campos não relacionados são ignorados
Atualize um treino de demonstração	Atualização parcial. Passa apenas os campos que queres mudar. assignedRoleIds substitui o conjunto atual.
Atualize uma pergunta de questionário sobre um tema	Fornecer campos que correspondam ao tipo armazenado; áreas não relacionadas são ignoradas.
Atualize uma pergunta de quiz sobre um módulo	Fornecer campos que correspondam ao tipo armazenado; áreas não relacionadas são ignoradas.
Carregar um documento	Upload em múltiplas partes (ficheiro + descrição opcional). No máximo 50MB.
Carregar um item de media	Upload em múltiplas partes (ficheiro + descrição opcional). Máximo 50MB para imagens, 500MB para vídeos.
Chama um especialista	Devolve metadados de especialistas, documentos ligados e funções/departamentos atribuídos
Cria um departamento	Cria um novo departamento na empresa do chamador.
Criar um cargo dentro de um departamento	Cria uma nova função com âmbito para o departamento em questão.
Criar um utilizador	Cria um utilizador e desencadeia o fluxo de convite magic-link
Crie um campo vazio	Cria uma nova estrutura de curso com o nome próprio
Crie uma formação de demonstração	Cria um treino de demonstração a partir de um ficheiro de vídeo previamente carregado e começa o processamento
Definir o número de questionários de tópicos para um tipo de pergunta	Substitui a contagem para o Tipo de pergunta dado (MULTIPLE_CHOICE ou OPEN_ENDED). A contagem de outros tipos é preservada
Definir o número de questionários do módulo para um tipo de pergunta	Substitui a contagem para o Tipo de pergunta dado (MULTIPLE_CHOICE ou OPEN_ENDED). A contagem de outros tipos é preservada
Definir ou substituir uma introdução de módulo	Upsert — cria se estiver em falta, substitui se estiver presente
Definir ou substituir uma introdução de tema	Upsert — cria se estiver em falta, substitui se estiver presente
Departamentos da lista	Todos os departamentos da companhia do chamador com funções aninhadas
Desativar um utilizador	Idempotente — devolve o utilizador mesmo que já esteja desativado
Desatribuir um documento a um perito	Idempotente
Desatribuir um utilizador de um papel	Idempotente — 204 mesmo que não tenha sido atribuído
Desvincular um documento de um tópico	Idempotente
Detalhe do certificado	Devolve um certificado com âmbito à empresa do chamador
Download do certificado PDF	Transmite o PDF do certificado. Devolve o 404 se o certificado ainda não tiver PDF
Eliminar (desativar) um departamento	Idempotente — devolve o 204 mesmo que já esteja desativado. Cascatas para atribuições de funções.
Eliminar (soft) um curso	Idempotente — devolve 204 mesmo que o curso já tenha sido removido
Eliminar um byte de aprendizagem (soft)	Idempotente — 204 mesmo que já removido
Eliminar um módulo (soft)	Idempotente — devolve 204 mesmo que o módulo já tenha sido removido
Eliminar um treino de demonstração	Idempotente — devolve o 204 mesmo que o treino demo não exista ou já tenha desaparecido
Eliminar um tópico (soft)	Idempotente — devolve 204 mesmo que o tema já tenha sido removido
Especialistas em listas	Lista paginada de especialistas na empresa do interlocutor
Eventos de atividades por aluno	Fluxo de eventos apenas para adiante paginado
Faz exercício	Devolve os detalhes do exercício para o ID indicado.
Faz uma formação de demonstração	Regressa ao treino demo completo com segmentos
Faz uma pergunta de quiz num módulo	Devolve uma única pergunta de quiz anexada ao módulo indicado.
Faz uma pergunta de quiz sobre um tema	Devolve uma única pergunta de quiz associada ao tópico indicado.
Faz uma pergunta durante a aula	Devolve uma única pergunta da lição junto ao seu ID.
Faça uma pergunta a um especialista	Wrapper síncrono à volta do chat de IA em streaming. Devolve a resposta reunida.
Gera um curso completo com conteúdo de IA	Cria a estrutura do curso, todos os módulos, todos os tópicos e coloca a geração de conteúdos por IA para cada tópico
Geração de conteúdos com IA de gatilho para tópicos	Enfileia geração de conteúdos por IA para os tópicos especificados dentro do curso
Ligar documentos a um tema	Aditivo — documentos já ligados são ignorados
Lista de documentos ligados a um tema	Paginado; Pesquisa opcional por nome do documento
Lista de perguntas durante a aula	Devolve perguntas de verificação de conhecimento associadas à lição dada.
Lista de treinos de demonstração	Lista paginada atribuída à empresa do interlocutor
Lista de utilizadores	Lista paginada de utilizadores na empresa do interlocutor
Lista perguntas de quiz num módulo	Devolve perguntas de quiz anexadas ao módulo indicado.
Listar bytes de aprendizagem num tópico	Devolve bytes de aprendizagem que pertencem ao tópico dado.
Listar documentos	Lista paginada de documentos na companhia do interlocutor
Listar exercícios num tema	Tipos mistos (ILE_TEXT / RPE_VOICE / RPE_VIDEO) ordenados por ordinalNumber
Listar módulos num curso	Devolve módulos ativos ordenados por ordinalNumber
Listar os certificados de um estudante	Certificados de devolução obtidos pelo estudante em questão dentro da empresa do chamador
Listar tópicos num módulo	Devolve tópicos ativos ordenados por ordinalNumber
Listas de cursos	Lista paginada de cursos na companhia do ouvinte
Listas de versões dos cursos	Devolve metadados da versão publicada (contagens + informação de publicação) ordenados por número de versão
Liste as lições num byte de aprendizagem	Devolve as lições que pertencem ao byte de aprendizagem dado.
Liste perguntas de quiz sobre um tema	Devolve perguntas de quiz associadas ao tema indicado.
Media de lista	Lista paginada de conteúdos mediáticos na companhia do interlocutor
Mude um tema para outro módulo	TargetOrdinalNumber é opcional; se omitido, o tema é acrescentado ao módulo alvo
Obtenha o estado de geração de IA para um curso	Devolve a lista de pedidos ativos de geração de IA para o curso com informação de progresso e alvo
Obtenha um byte de aprendizagem	Devolve metadados e lições aninhadas
Obtenha um snapshot da versão do curso	Devolve a árvore de conteúdos completa (módulos, tópicos, lições, exercícios, perguntas) para a versão dada
Obter um curso	Devolve metadados dos cursos com resumos dos módulos e funções/departamentos atribuídos
Obter um documento	Devolve metadados do documento e um URL de download assinado de curta duração
Obter um utilizador	Devolve metadados de utilizador e atribuições de departamentos/funções
Obtém uma introdução ao módulo	Devolve o conjunto de texto introdutório no módulo indicado.
Obtém uma introdução ao tema	Devolve o conjunto de texto introdutório sobre o tema dado.
Perceções por aluno	Resumo agregado e divisão por curso para a janela dada
Perspetivas ao nível da empresa	KPIs principais para a empresa do interlocutor
Publicar um curso	Publica o curso; falha com 400 se não tiver conteúdo publicável
Reativar um utilizador	Idempotente — devolve o utilizador mesmo que já esteja ativo
Recebe um artigo de comunicação	Devolve metadados de media e uma URL de download assinada de curta duração
Reexecute processamento de vídeo	Reenvia o vídeo para segmentação por IA. Opcionalmente, sobrepor o prompt de processamento.
Regenerar um item específico através da IA	Regenera uma única lição, perguntas de aula, questionário, introdução ou exercício
Remover todas as atribuições de funções a um especialista	Idempotente
Remover todas as atribuições de funções de um curso	Idempotente
Remover uma atribuição de função a um especialista	Idempotente
Remover uma atribuição de função de um curso	Idempotente
Remover uma introdução de módulo	Idempotente — 204 mesmo que não haja introdução definida
Remover uma introdução de tópico	Idempotente — 204 mesmo que não haja introdução definida
Reordenar as perguntas do quiz num módulo	Os questionIds devem incluir todas as perguntas ativas do quiz para o módulo, na nova ordem.
Reordenar as perguntas do quiz sobre um tema	Os questionIds devem incluir todas as perguntas ativas do questionário para o tema, na nova ordem.
Reordenar as perguntas durante a aula	o questionIds deve incluir todas as perguntas ativas da lição, na nova ordem
Reordenar módulos num curso	Os moduleIds devem incluir cada módulo ativo exatamente uma vez, na nova ordem
Reordenar os tópicos dentro de um módulo	topicIds deve incluir todos os tópicos ativos exatamente uma vez, na nova ordem
Substituir binário de media	Substitui o binário do ficheiro de um elemento multimédia existente no lugar; os metadados são preservados
Substituir binário do documento	Substitui o binário do ficheiro de um documento existente; os metadados são preservados
Tem uma lição	Devolve o conteúdo das aulas, os conteúdos mediáticos e as perguntas durante a aula

Adicionar um byte de aprendizagem a um tópico

ID da Operação:: addLearningByteToTopic

Cria um novo byte de aprendizagem dentro do tópico dado.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id do Tema	topicId	True	uuid	Id do Tema
Nome	name	True	string
description	description		string

Devoluções

Body: LearningByteDetailDto

Adicionar um tema a um módulo

ID da Operação:: addTopicToModule

Cria um novo tema dentro do módulo dado.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do Módulo	moduleId	True	uuid	ID do Módulo
Nome	name	True	string
description	description		string

Devoluções

Body: TopicDto

Adicionar uma lição a um byte de aprendizagem

ID da Operação:: addLessonToLearningByte

Cria uma nova lição dentro do byte de aprendizagem dado.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Lb Id	lbId	True	uuid	Lb Id
conteúdo	content	True	string

Devoluções

Body: LessonDetailDto

Adicionar uma pergunta de quiz a um tema

ID da Operação:: addTopicQuizQuestion

Cria uma nova pergunta de quiz dentro do tópico dado.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id do Tema	topicId	True	uuid	Id do Tema
tipo	type	True	string
enviar SMS	text	True	string
ordinalNumber	ordinalNumber		integer
enviar SMS	text	True	string
éCorreto	isCorrect		boolean
Resposta esperada	expectedAnswer		string

Devoluções

Body: QuestionDto

Adicione um exercício ILE_TEXT a um tema

ID da Operação:: addIleTextExercise

Cria um novo ILE_TEXT exercício dentro do tema em questão.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id do Tema	topicId	True	uuid	Id do Tema
avisar	prompt		string

Devoluções

Body: ExerciseDto

Adicione um exercício RPE_VIDEO a um tema

ID da Operação:: addRpeVideoExercise

Cria um novo exercício RPE_VIDEO de role-play dentro do tema dado.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id do Tema	topicId	True	uuid	Id do Tema
avisar	prompt		string
avatarPictureId	avatarPictureId		uuid
avatarCaracterísticas	avatarCharacteristics		string
reverseRolePlayEnabled	reverseRolePlayEnabled		boolean
reversoRolePlayObrigatório	reverseRolePlayMandatory		boolean

Devoluções

Body: ExerciseDto

Adicione um exercício RPE_VOICE a um tema

ID da Operação:: addRpeVoiceExercise

Cria um novo exercício de role-play RPE_VOICE dentro do tema dado.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id do Tema	topicId	True	uuid	Id do Tema
avisar	prompt		string
avatarPictureId	avatarPictureId		uuid
avatarCaracterísticas	avatarCharacteristics		string
reverseRolePlayEnabled	reverseRolePlayEnabled		boolean
reversoRolePlayObrigatório	reverseRolePlayMandatory		boolean

Devoluções

Body: ExerciseDto

Adicione um módulo a um curso

ID da Operação:: addModuleToCourse

Cria um novo módulo dentro do curso em questão.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do Curso	courseId	True	uuid	ID do Curso
Nome	name	True	string
description	description		string

Devoluções

Body: ModuleDetailDto

Adicione uma pergunta de quiz a um módulo

ID da Operação:: addModuleQuizQuestion

Cria uma nova pergunta de quiz dentro do módulo dado.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do Módulo	moduleId	True	uuid	ID do Módulo
tipo	type	True	string
enviar SMS	text	True	string
ordinalNumber	ordinalNumber		integer
enviar SMS	text	True	string
éCorreto	isCorrect		boolean
Resposta esperada	expectedAnswer		string

Devoluções

Body: QuestionDto

Adicione uma pergunta durante a aula

ID da Operação:: addLessonQuestion

O tipo deve ser MULTIPLE_CHOICE (requer opções) ou OPEN_ENDED

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Identificação da Lição	lessonId	True	uuid	Identificação da Lição
tipo	type	True	string
enviar SMS	text	True	string
ordinalNumber	ordinalNumber		integer
enviar SMS	text	True	string
éCorreto	isCorrect		boolean
Resposta esperada	expectedAnswer		string

Devoluções

Body: QuestionDto

Alternar a disponibilidade para estudantes

ID da Operação:: updateDemoTrainingAvailability

Defina se a formação demonstrativa é publicada para os alunos. Idempotente.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id	id	True	uuid	Id
available	available	True	boolean

Devoluções

Body: DemoTrainingDto

Apagar (desativar) um documento

ID da Operação:: deleteDocument

Idempotente — devolve 204 mesmo que o documento já esteja apagado ou em falta

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id	id	True	uuid	Id

Apagar (desativar) um elemento multimédia

ID da Operação:: deleteMedia

Idempotente — devolve 204 mesmo que o item já esteja apagado ou em falta

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id	id	True	uuid	Id

Apagar um exercício

ID da Operação:: deleteExercise

Idempotente — 204 mesmo que já removido

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id	id	True	uuid	Id

Apagar uma lição (suave)

ID da Operação:: deleteLesson

Idempotente — 204 mesmo que já removido

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Identificação da Lição	lessonId	True	uuid	Identificação da Lição

Apagar uma pergunta de quiz num módulo

ID da Operação:: deleteModuleQuizQuestion

Idempotente — 204 mesmo que já removido

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do Módulo	moduleId	True	uuid	ID do Módulo
ID da pergunta	questionId	True	uuid	ID da pergunta

Apagar uma pergunta de quiz sobre um tema

ID da Operação:: deleteTopicQuizQuestion

Idempotente — 204 mesmo que já removido

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id do Tema	topicId	True	uuid	Id do Tema
ID da pergunta	questionId	True	uuid	ID da pergunta

Apagar uma pergunta durante a aula

ID da Operação:: deleteLessonQuestion

Idempotente — 204 mesmo que já removido

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Identificação da Lição	lessonId	True	uuid	Identificação da Lição
ID da pergunta	questionId	True	uuid	ID da pergunta

Arranja um módulo

ID da Operação:: getModule

Devolve os detalhes do módulo para o ID indicado.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do Módulo	moduleId	True	uuid	ID do Módulo

Devoluções

Body: ModuleDetailDto

Arranja um tema

ID da Operação:: getTopic

Devolve os detalhes do tópico para o ID indicado.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id do Tema	topicId	True	uuid	Id do Tema

Devoluções

Body: TopicDto

Atribuir documentos a um perito

ID da Operação:: assignDocumentsToExpert

Ligue em massa os documentos ao profissional. Idempotente.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id	id	True	uuid	Id
documentIds	documentIds	True	array of uuid

Devoluções

Body: ExpertDetailDto

Atribuir funções a um curso

ID da Operação:: assignRolesToCourse

Aditivo — as funções já atribuídas são saltadas. Devolve o detalhe atualizado do percurso

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id	id	True	uuid	Id
roleIds	roleIds	True	array of uuid

Devoluções

Body: CourseDetailDto

Atribuir funções a um especialista

ID da Operação:: assignRolesToExpert

Aditivo — os papéis já atribuídos são mantidos; Novas adicionadas. Devolve o especialista atualizado

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id	id	True	uuid	Id
roleIds	roleIds	True	array of uuid

Devoluções

Body: ExpertDetailDto

Atribuir um utilizador a um papel

ID da Operação:: assignUserToRole

Idempotente

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id	id	True	uuid	Id
ID da função	roleId	True	uuid	ID da função
userId	userId	True	uuid

Devoluções

Body: DepartmentDto

Atualizar metadados do curso

ID da Operação:: updateCourse

Atualizar o nome do curso

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id	id	True	uuid	Id
Nome	name		string

Devoluções

Body: CourseDetailDto

Atualizar metadados do documento

ID da Operação:: updateDocumentMetadata

Atualizar nome e/ou descrição

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id	id	True	uuid	Id
Nome	name		string
description	description		string

Devoluções

Body: DocumentDetailDto

Atualizar metadados do módulo

ID da Operação:: updateModule

Atualiza o nome e/ou a descrição. Campos omitidos preservam os valores atuais

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do Módulo	moduleId	True	uuid	ID do Módulo
Nome	name		string
description	description		string

Devoluções

Body: ModuleDetailDto

Atualizar metadados do tema

ID da Operação:: updateTopic

Atualiza o nome e/ou a descrição. Campos omitidos preservam os valores atuais

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id do Tema	topicId	True	uuid	Id do Tema
Nome	name		string
description	description		string

Devoluções

Body: TopicDto

Atualizar metadados dos bytes de aprendizagem

ID da Operação:: updateLearningByte

Campos omitidos preservam os valores atuais

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Lb Id	lbId	True	uuid	Lb Id
Nome	name		string
description	description		string

Devoluções

Body: LearningByteDetailDto

Atualizar metadados dos media

ID da Operação:: updateMediaMetadata

Atualizar nome e/ou descrição

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id	id	True	uuid	Id
Nome	name		string
description	description		string

Devoluções

Body: MediaDetailDto

Atualizar o conteúdo da aula

ID da Operação:: updateLesson

Conteúdo omitido preserva o valor atual

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Identificação da Lição	lessonId	True	uuid	Identificação da Lição
conteúdo	content		string

Devoluções

Body: LessonDetailDto

Atualizar um departamento

ID da Operação:: updateDepartment

Atualizar nome e/ou descrição

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id	id	True	uuid	Id
Nome	name		string
description	description		string

Devoluções

Body: DepartmentDto

Atualizar um exercício

ID da Operação:: updateExercise

Type-aware: ILE_TEXT só usa prompt + generationedContent.scenario; RPE_* utiliza todos os campos RPE. Campos omitidos preservam os valores atuais.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id	id	True	uuid	Id
avisar	prompt		string
avatarPictureId	avatarPictureId		uuid
avatarCaracterísticas	avatarCharacteristics		string
reverseRolePlayEnabled	reverseRolePlayEnabled		boolean
reversoRolePlayObrigatório	reverseRolePlayMandatory		boolean
cenário	scenario		string
estagiárioPapel	traineeRole		string
avatarName	avatarName		string
avatarDescription	avatarDescription		string
Desafio operacional	operationalChallenge		string
Métrica de sucesso	successMetric		string

Devoluções

Body: ExerciseDto

Atualizar um utilizador

ID da Operação:: updateUser

Atualizar NomePróprio, ApelidoNome, Administrador e atribuições de funções. O email não é editável na v1.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id	id	True	uuid	Id
firstName	firstName		string
lastName	lastName		string
isAdmin	isAdmin		boolean
departamentRoleIds	departmentRoleIds		array of uuid

Devoluções

Body: UserDto

Atualização de uma pergunta durante a aula

ID da Operação:: updateLessonQuestion

Fornecer campos que correspondam ao tipo armazenado; Campos não relacionados são ignorados

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Identificação da Lição	lessonId	True	uuid	Identificação da Lição
ID da pergunta	questionId	True	uuid	ID da pergunta
enviar SMS	text		string
enviar SMS	text	True	string
éCorreto	isCorrect		boolean
Resposta esperada	expectedAnswer		string

Devoluções

Body: QuestionDto

Atualize um treino de demonstração

ID da Operação:: updateDemoTraining

Atualização parcial. Passa apenas os campos que queres mudar. assignedRoleIds substitui o conjunto atual.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id	id	True	uuid	Id
Nome	name		string
description	description		string
Tipo de treino	trainingType		string
departmentId	departmentId		uuid
assignedRoleIds	assignedRoleIds		array of uuid

Devoluções

Body: DemoTrainingDto

Atualize uma pergunta de questionário sobre um tema

ID da Operação:: updateTopicQuizQuestion

Fornecer campos que correspondam ao tipo armazenado; áreas não relacionadas são ignoradas.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id do Tema	topicId	True	uuid	Id do Tema
ID da pergunta	questionId	True	uuid	ID da pergunta
enviar SMS	text		string
enviar SMS	text	True	string
éCorreto	isCorrect		boolean
Resposta esperada	expectedAnswer		string

Devoluções

Body: QuestionDto

Atualize uma pergunta de quiz sobre um módulo

ID da Operação:: updateModuleQuizQuestion

Fornecer campos que correspondam ao tipo armazenado; áreas não relacionadas são ignoradas.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do Módulo	moduleId	True	uuid	ID do Módulo
ID da pergunta	questionId	True	uuid	ID da pergunta
enviar SMS	text		string
enviar SMS	text	True	string
éCorreto	isCorrect		boolean
Resposta esperada	expectedAnswer		string

Devoluções

Body: QuestionDto

Carregar um documento

ID da Operação:: uploadDocument

Upload em múltiplas partes (ficheiro + descrição opcional). No máximo 50MB.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
File	file	True	file	File
Description	description		string	Description

Devoluções

Body: DocumentDetailDto

Carregar um item de media

ID da Operação:: uploadMedia

Upload em múltiplas partes (ficheiro + descrição opcional). Máximo 50MB para imagens, 500MB para vídeos.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
File	file	True	file	File
Description	description		string	Description

Devoluções

Body: MediaDetailDto

Chama um especialista

ID da Operação:: getExpert

Devolve metadados de especialistas, documentos ligados e funções/departamentos atribuídos

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id	id	True	uuid	Id

Devoluções

Body: ExpertDetailDto

Cria um departamento

ID da Operação:: createDepartment

Cria um novo departamento na empresa do chamador.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Nome	name	True	string
description	description		string

Devoluções

Body: DepartmentDto

Criar um cargo dentro de um departamento

ID da Operação:: createRoleInDepartment

Cria uma nova função com âmbito para o departamento em questão.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id	id	True	uuid	Id
Nome	name	True	string
Nome completo	fullName		string
description	description		string

Devoluções

Body: DepartmentDto

Criar um utilizador

ID da Operação:: createUser

Cria um utilizador e desencadeia o fluxo de convite magic-link

Parâmetros

Name	Chave	Obrigatório	Tipo
e-mail	email	True	email
firstName	firstName		string
lastName	lastName		string
isAdmin	isAdmin		boolean
departamentRoleIds	departmentRoleIds		array of uuid

Devoluções

Body: UserDto

Crie um campo vazio

ID da Operação:: createCourse

Cria uma nova estrutura de curso com o nome próprio

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Nome	name	True	string

Devoluções

Body: CourseDetailDto

Crie uma formação de demonstração

ID da Operação:: createDemoTraining

Cria um treino de demonstração a partir de um ficheiro de vídeo previamente carregado e começa o processamento

Parâmetros

Name	Chave	Obrigatório	Tipo
Nome	name	True	string
description	description		string
Tipo de treino	trainingType	True	string
videoFileId	videoFileId	True	uuid
departmentId	departmentId		uuid
ProcessamentoPrompt	processingPrompt		string

Devoluções

Body: DemoTrainingDto

Definir o número de questionários de tópicos para um tipo de pergunta

ID da Operação:: setTopicQuizSettings

Substitui a contagem para o Tipo de pergunta dado (MULTIPLE_CHOICE ou OPEN_ENDED). A contagem de outros tipos é preservada

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id do Tema	topicId	True	uuid	Id do Tema
perguntaTipo de pergunta	questionType	True	string
contagem	count		integer

Devoluções

Body: TopicDto

Definir o número de questionários do módulo para um tipo de pergunta

ID da Operação:: setModuleQuizSettings

Substitui a contagem para o Tipo de pergunta dado (MULTIPLE_CHOICE ou OPEN_ENDED). A contagem de outros tipos é preservada

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do Módulo	moduleId	True	uuid	ID do Módulo
perguntaTipo de pergunta	questionType	True	string
contagem	count		integer

Devoluções

Body: ModuleDetailDto

Definir ou substituir uma introdução de módulo

ID da Operação:: setModuleIntro

Upsert — cria se estiver em falta, substitui se estiver presente

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do Módulo	moduleId	True	uuid	ID do Módulo
Introdução	introduction		string

Devoluções

Body: IntroDto

Definir ou substituir uma introdução de tema

ID da Operação:: setTopicIntro

Upsert — cria se estiver em falta, substitui se estiver presente

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id do Tema	topicId	True	uuid	Id do Tema
Introdução	introduction		string

Devoluções

Body: IntroDto

Departamentos da lista

ID da Operação:: listDepartments

Todos os departamentos da companhia do chamador com funções aninhadas

Devoluções

Body: DepartmentListResponse

Desativar um utilizador

ID da Operação:: deactivateUser

Idempotente — devolve o utilizador mesmo que já esteja desativado

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id	id	True	uuid	Id

Devoluções

Body: UserDto

Desatribuir um documento a um perito

ID da Operação:: unassignDocumentFromExpert

Idempotente

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id	id	True	uuid	Id
ID do documento	documentId	True	uuid	ID do documento

Desatribuir um utilizador de um papel

ID da Operação:: unassignUserFromRole

Idempotente — 204 mesmo que não tenha sido atribuído

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id	id	True	uuid	Id
ID da função	roleId	True	uuid	ID da função
ID do Utilizador	userId	True	uuid	ID do Utilizador

Desvincular um documento de um tópico

ID da Operação:: unlinkDocumentFromTopic

Idempotente

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id do Tema	topicId	True	uuid	Id do Tema
ID do documento	documentId	True	uuid	ID do documento

Detalhe do certificado

ID da Operação:: getCertificate

Devolve um certificado com âmbito à empresa do chamador

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id	id	True	uuid	Id

Devoluções

Body: CertificateDto

Download do certificado PDF

ID da Operação:: downloadCertificatePdf

Transmite o PDF do certificado. Devolve o 404 se o certificado ainda não tiver PDF

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id	id	True	uuid	Id

Devoluções

response: StreamingResponseBody

Eliminar (desativar) um departamento

ID da Operação:: deleteDepartment

Idempotente — devolve o 204 mesmo que já esteja desativado. Cascatas para atribuições de funções.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id	id	True	uuid	Id

Eliminar (soft) um curso

ID da Operação:: deleteCourse

Idempotente — devolve 204 mesmo que o curso já tenha sido removido

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id	id	True	uuid	Id

Eliminar um byte de aprendizagem (soft)

ID da Operação:: deleteLearningByte

Idempotente — 204 mesmo que já removido

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Lb Id	lbId	True	uuid	Lb Id

Eliminar um módulo (soft)

ID da Operação:: deleteModule

Idempotente — devolve 204 mesmo que o módulo já tenha sido removido

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do Módulo	moduleId	True	uuid	ID do Módulo

Eliminar um treino de demonstração

ID da Operação:: deleteDemoTraining

Idempotente — devolve o 204 mesmo que o treino demo não exista ou já tenha desaparecido

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id	id	True	uuid	Id

Eliminar um tópico (soft)

ID da Operação:: deleteTopic

Idempotente — devolve 204 mesmo que o tema já tenha sido removido

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id do Tema	topicId	True	uuid	Id do Tema

Especialistas em listas

ID da Operação:: listExperts

Lista paginada de especialistas na empresa do interlocutor

Parâmetros

Name	Chave	Tipo	Descrição
Página	page	integer	Página
Tamanho	size	integer	Tamanho
Pesquisa	search	string	Pesquisa

Devoluções

Body: ExpertListResponse

Eventos de atividades por aluno

ID da Operação:: listStudentEvents

Fluxo de eventos apenas para adiante paginado

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do Utilizador	userId	True	uuid	ID do Utilizador
Página	page		integer	Página
Tamanho	size		integer	Tamanho

Devoluções

Body: EventListResponse

Faz exercício

ID da Operação:: getExercise

Devolve os detalhes do exercício para o ID indicado.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id	id	True	uuid	Id

Devoluções

Body: ExerciseDto

Faz uma formação de demonstração

ID da Operação:: getDemoTraining

Regressa ao treino demo completo com segmentos

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id	id	True	uuid	Id

Devoluções

Body: DemoTrainingDto

Faz uma pergunta de quiz num módulo

ID da Operação:: getModuleQuizQuestion

Devolve uma única pergunta de quiz anexada ao módulo indicado.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do Módulo	moduleId	True	uuid	ID do Módulo
ID da pergunta	questionId	True	uuid	ID da pergunta

Devoluções

Body: QuestionDto

Faz uma pergunta de quiz sobre um tema

ID da Operação:: getTopicQuizQuestion

Devolve uma única pergunta de quiz associada ao tópico indicado.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id do Tema	topicId	True	uuid	Id do Tema
ID da pergunta	questionId	True	uuid	ID da pergunta

Devoluções

Body: QuestionDto

Faz uma pergunta durante a aula

ID da Operação:: getLessonQuestion

Devolve uma única pergunta da lição junto ao seu ID.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Identificação da Lição	lessonId	True	uuid	Identificação da Lição
ID da pergunta	questionId	True	uuid	ID da pergunta

Devoluções

Body: QuestionDto

Faça uma pergunta a um especialista

ID da Operação:: askExpert

Wrapper síncrono à volta do chat de IA em streaming. Devolve a resposta reunida.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id	id	True	uuid	Id
pergunta	question	True	string

Devoluções

Body: AskResponse

Gera um curso completo com conteúdo de IA

ID da Operação:: generateCourse

Cria a estrutura do curso, todos os módulos, todos os tópicos e coloca a geração de conteúdos por IA para cada tópico

Parâmetros

Name	Chave	Obrigatório	Tipo
Nome	name	True	string
description	description		string
Nome	name	True	string
description	description		string
Nome	name	True	string
description	description		string

Devoluções

Body: GenerateCourseResponse

Geração de conteúdos com IA de gatilho para tópicos

ID da Operação:: generateCourseContent

Enfileia geração de conteúdos por IA para os tópicos especificados dentro do curso

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id	id	True	uuid	Id
topicIds	topicIds	True	array of uuid

Devoluções

Body: GenerationRequestResponse

Ligar documentos a um tema

ID da Operação:: linkDocumentsToTopic

Aditivo — documentos já ligados são ignorados

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id do Tema	topicId	True	uuid	Id do Tema
documentIds	documentIds	True	array of uuid

Lista de documentos ligados a um tema

ID da Operação:: listTopicLinkedDocuments

Paginado; Pesquisa opcional por nome do documento

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id do Tema	topicId	True	uuid	Id do Tema
Página	page		integer	Página
Tamanho	size		integer	Tamanho
Pesquisa	search		string	Pesquisa

Devoluções

Body: TopicLinkedDocumentListResponse

Lista de perguntas durante a aula

ID da Operação:: listLessonQuestions

Devolve perguntas de verificação de conhecimento associadas à lição dada.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Identificação da Lição	lessonId	True	uuid	Identificação da Lição

Devoluções

Body: QuestionListResponse

Lista de treinos de demonstração

ID da Operação:: listDemoTrainings

Lista paginada atribuída à empresa do interlocutor

Parâmetros

Name	Chave	Tipo	Descrição
Página	page	integer	Página
Tamanho	size	integer	Tamanho
Pesquisa	search	string	Pesquisa
Tipos de Treino	trainingTypes	string	Tipos de Treino
Estados	statuses	string	Estados
Identificações de Departamento	departmentIds	string	Identificações de Departamento
Está disponível	isAvailable	boolean	Está disponível

Devoluções

Body: DemoTrainingListResponse

Lista de utilizadores

ID da Operação:: listUsers

Lista paginada de utilizadores na empresa do interlocutor

Parâmetros

Name	Chave	Tipo	Descrição
Página	page	integer	Página
Tamanho	size	integer	Tamanho
Pesquisa	search	string	Pesquisa
Status	status	string	Status
Identificações de Departamento	departmentIds	string	Identificações de Departamento
Identificações de Papéis	roleIds	string	Identificações de Papéis
Variante	kind	string	Variante

Devoluções

Body: UserListResponse

Lista perguntas de quiz num módulo

ID da Operação:: listModuleQuizQuestions

Devolve perguntas de quiz anexadas ao módulo indicado.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do Módulo	moduleId	True	uuid	ID do Módulo

Devoluções

Body: QuestionListResponse

Listar bytes de aprendizagem num tópico

ID da Operação:: listLearningBytesInTopic

Devolve bytes de aprendizagem que pertencem ao tópico dado.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id do Tema	topicId	True	uuid	Id do Tema

Devoluções

Body: LearningByteListResponse

Listar documentos

ID da Operação:: listDocuments

Lista paginada de documentos na companhia do interlocutor

Parâmetros

Name	Chave	Tipo	Descrição
Página	page	integer	Página
Tamanho	size	integer	Tamanho
Pesquisa	search	string	Pesquisa
Tipos de Mímica	mimeTypes	string	Tipos de Mímica
Status	status	string	Status

Devoluções

Body: DocumentListResponse

Listar exercícios num tema

ID da Operação:: listExercisesInTopic

Tipos mistos (ILE_TEXT / RPE_VOICE / RPE_VIDEO) ordenados por ordinalNumber

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id do Tema	topicId	True	uuid	Id do Tema

Devoluções

Body: ExerciseListResponse

Listar módulos num curso

ID da Operação:: listModulesInCourse

Devolve módulos ativos ordenados por ordinalNumber

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do Curso	courseId	True	uuid	ID do Curso

Devoluções

Body: ModuleListResponse

Listar os certificados de um estudante

ID da Operação:: listStudentCertificates

Certificados de devolução obtidos pelo estudante em questão dentro da empresa do chamador

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do Utilizador	userId	True	uuid	ID do Utilizador

Devoluções

Body: CertificateListResponse

Listar tópicos num módulo

ID da Operação:: listTopicsInModule

Devolve tópicos ativos ordenados por ordinalNumber

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do Módulo	moduleId	True	uuid	ID do Módulo

Devoluções

Body: TopicListResponse

Listas de cursos

ID da Operação:: listCourses

Lista paginada de cursos na companhia do ouvinte

Parâmetros

Name	Chave	Tipo	Descrição
Página	page	integer	Página
Tamanho	size	integer	Tamanho
Pesquisa	search	string	Pesquisa
Status	status	string	Status
IDs de Funções de Departamento	departmentRoleIds	string	IDs de Funções de Departamento

Devoluções

Body: CourseListResponse

Listas de versões dos cursos

ID da Operação:: listCourseVersions

Devolve metadados da versão publicada (contagens + informação de publicação) ordenados por número de versão

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do Curso	courseId	True	uuid	ID do Curso

Devoluções

Body: CourseVersionListResponse

Liste as lições num byte de aprendizagem

ID da Operação:: listLessonsInLearningByte

Devolve as lições que pertencem ao byte de aprendizagem dado.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Lb Id	lbId	True	uuid	Lb Id

Devoluções

Body: LessonListResponse

Liste perguntas de quiz sobre um tema

ID da Operação:: listTopicQuizQuestions

Devolve perguntas de quiz associadas ao tema indicado.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id do Tema	topicId	True	uuid	Id do Tema

Devoluções

Body: QuestionListResponse

Media de lista

ID da Operação:: listMedia

Lista paginada de conteúdos mediáticos na companhia do interlocutor

Parâmetros

Name	Chave	Tipo	Descrição
Página	page	integer	Página
Tamanho	size	integer	Tamanho
Pesquisa	search	string	Pesquisa
Variante	kind	string	Variante
Status	status	string	Status

Devoluções

Body: MediaListResponse

Mude um tema para outro módulo

ID da Operação:: moveTopic

TargetOrdinalNumber é opcional; se omitido, o tema é acrescentado ao módulo alvo

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id do Tema	topicId	True	uuid	Id do Tema
targetModuleId	targetModuleId	True	uuid
Número OrdinalAlvoDestino	targetOrdinalNumber		integer

Devoluções

Body: TopicDto

Obtenha o estado de geração de IA para um curso

ID da Operação:: getCourseGenerationStatus

Devolve a lista de pedidos ativos de geração de IA para o curso com informação de progresso e alvo

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id	id	True	uuid	Id

Devoluções

Body: GenerationStatusResponse

Obtenha um byte de aprendizagem

ID da Operação:: getLearningByte

Devolve metadados e lições aninhadas

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Lb Id	lbId	True	uuid	Lb Id

Devoluções

Body: LearningByteDetailDto

Obtenha um snapshot da versão do curso

ID da Operação:: getCourseVersion

Devolve a árvore de conteúdos completa (módulos, tópicos, lições, exercícios, perguntas) para a versão dada

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do Curso	courseId	True	uuid	ID do Curso
Número da versão	versionNumber	True	integer	Número da versão

Devoluções

Body: CourseVersionSnapshotDto

Obter um curso

ID da Operação:: getCourse

Devolve metadados dos cursos com resumos dos módulos e funções/departamentos atribuídos

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id	id	True	uuid	Id

Devoluções

Body: CourseDetailDto

Obter um documento

ID da Operação:: getDocument

Devolve metadados do documento e um URL de download assinado de curta duração

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id	id	True	uuid	Id

Devoluções

Body: DocumentDetailDto

Obter um utilizador

ID da Operação:: getUser

Devolve metadados de utilizador e atribuições de departamentos/funções

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id	id	True	uuid	Id

Devoluções

Body: UserDto

Obtém uma introdução ao módulo

ID da Operação:: getModuleIntro

Devolve o conjunto de texto introdutório no módulo indicado.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do Módulo	moduleId	True	uuid	ID do Módulo

Devoluções

Body: IntroDto

Obtém uma introdução ao tema

ID da Operação:: getTopicIntro

Devolve o conjunto de texto introdutório sobre o tema dado.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id do Tema	topicId	True	uuid	Id do Tema

Devoluções

Body: IntroDto

Perceções por aluno

ID da Operação:: getStudentInsights

Resumo agregado e divisão por curso para a janela dada

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do Utilizador	userId	True	uuid	ID do Utilizador
Janela	window		string	Janela

Devoluções

Body: StudentInsightsDto

Perspetivas ao nível da empresa

ID da Operação:: getCompanyInsights

KPIs principais para a empresa do interlocutor

Devoluções

Body: CompanyInsightsDto

Publicar um curso

ID da Operação:: publishCourse

Publica o curso; falha com 400 se não tiver conteúdo publicável

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id	id	True	uuid	Id

Devoluções

Body: CourseDetailDto

Reativar um utilizador

ID da Operação:: reactivateUser

Idempotente — devolve o utilizador mesmo que já esteja ativo

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id	id	True	uuid	Id

Devoluções

Body: UserDto

Recebe um artigo de comunicação

ID da Operação:: getMediaItem

Devolve metadados de media e uma URL de download assinada de curta duração

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id	id	True	uuid	Id

Devoluções

Body: MediaDetailDto

Reexecute processamento de vídeo

ID da Operação:: reprocessDemoTraining

Reenvia o vídeo para segmentação por IA. Opcionalmente, sobrepor o prompt de processamento.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id	id	True	uuid	Id
ProcessamentoPrompt	processingPrompt		string

Devoluções

Body: DemoTrainingDto

Regenerar um item específico através da IA

ID da Operação:: regenerateCourseItem

Regenera uma única lição, perguntas de aula, questionário, introdução ou exercício

Parâmetros

Name	Chave	Obrigatório	Tipo
destino	target	True	string
targetId	targetId	True	uuid
tipo pai	parentType		string

Devoluções

Body: GenerationRequestResponse

Remover todas as atribuições de funções a um especialista

ID da Operação:: removeAllRolesFromExpert

Idempotente

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id	id	True	uuid	Id

Remover todas as atribuições de funções de um curso

ID da Operação:: removeAllRolesFromCourse

Idempotente

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id	id	True	uuid	Id

Remover uma atribuição de função a um especialista

ID da Operação:: removeRoleFromExpert

Idempotente

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id	id	True	uuid	Id
ID da função	roleId	True	uuid	ID da função

Remover uma atribuição de função de um curso

ID da Operação:: removeRoleFromCourse

Idempotente

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id	id	True	uuid	Id
ID da função	roleId	True	uuid	ID da função

Remover uma introdução de módulo

ID da Operação:: removeModuleIntro

Idempotente — 204 mesmo que não haja introdução definida

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do Módulo	moduleId	True	uuid	ID do Módulo

Remover uma introdução de tópico

ID da Operação:: removeTopicIntro

Idempotente — 204 mesmo que não haja introdução definida

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id do Tema	topicId	True	uuid	Id do Tema

Reordenar as perguntas do quiz num módulo

ID da Operação:: reorderModuleQuizQuestions

Os questionIds devem incluir todas as perguntas ativas do quiz para o módulo, na nova ordem.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do Módulo	moduleId	True	uuid	ID do Módulo
questionIds	questionIds	True	array of uuid

Devoluções

Body: QuestionListResponse

Reordenar as perguntas do quiz sobre um tema

ID da Operação:: reorderTopicQuizQuestions

Os questionIds devem incluir todas as perguntas ativas do questionário para o tema, na nova ordem.

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id do Tema	topicId	True	uuid	Id do Tema
questionIds	questionIds	True	array of uuid

Devoluções

Body: QuestionListResponse

Reordenar as perguntas durante a aula

ID da Operação:: reorderLessonQuestions

o questionIds deve incluir todas as perguntas ativas da lição, na nova ordem

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Identificação da Lição	lessonId	True	uuid	Identificação da Lição
questionIds	questionIds	True	array of uuid

Devoluções

Body: QuestionListResponse

Reordenar módulos num curso

ID da Operação:: reorderModulesInCourse

Os moduleIds devem incluir cada módulo ativo exatamente uma vez, na nova ordem

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do Curso	courseId	True	uuid	ID do Curso
moduleIds	moduleIds	True	array of uuid

Devoluções

Body: ModuleListResponse

Reordenar os tópicos dentro de um módulo

ID da Operação:: reorderTopicsInModule

topicIds deve incluir todos os tópicos ativos exatamente uma vez, na nova ordem

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
ID do Módulo	moduleId	True	uuid	ID do Módulo
topicIds	topicIds	True	array of uuid

Devoluções

Body: TopicListResponse

Substituir binário de media

ID da Operação:: replaceMediaFile

Substitui o binário do ficheiro de um elemento multimédia existente no lugar; os metadados são preservados

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id	id	True	uuid	Id
File	file	True	file	File

Devoluções

Body: MediaDetailDto

Substituir binário do documento

ID da Operação:: replaceDocumentFile

Substitui o binário do ficheiro de um documento existente; os metadados são preservados

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Id	id	True	uuid	Id
File	file	True	file	File

Devoluções

Body: DocumentDetailDto

Tem uma lição

ID da Operação:: getLesson

Devolve o conteúdo das aulas, os conteúdos mediáticos e as perguntas durante a aula

Parâmetros

Name	Chave	Obrigatório	Tipo	Descrição
Identificação da Lição	lessonId	True	uuid	Identificação da Lição

Devoluções

Body: LessonDetailDto

Definições

QuizSettingDto

Name	Caminho	Tipo	Descrição
perguntaTipo de pergunta	questionType	string
contagem	count	integer

TopicDto

Name	Caminho	Tipo
id	id	uuid
moduleId	moduleId	uuid
Nome	name	string
description	description	string
ordinalNumber	ordinalNumber	integer
hasContent	hasContent	boolean
Cenários do quiz	quizSettings	array of QuizSettingDto

Introdução

Name	Caminho	Tipo
id	id	uuid
componentId	componentId	uuid
componentType	componentType	string
Introdução	introduction	string
origem	source	string
createdAt	createdAt	date-time
atualizado em	updatedAt	date-time

ModuleDetailDto

Name	Caminho	Tipo
id	id	uuid
Id do curso	courseId	uuid
Nome	name	string
description	description	string
productId	productId	uuid
ordinalNumber	ordinalNumber	integer
lockedForGeneration	lockedForGeneration	boolean
Cenários do quiz	quizSettings	array of QuizSettingDto
topics	topics	array of TopicDto

MediaDetailDto

Name	Caminho	Tipo
id	id	uuid
Nome	name	string
description	description	string
kind	kind	string
mimeType	mimeType	string
sizeBytes	sizeBytes	integer
estado	status	string
Estado do processamento	processingStatus	string
createdAt	createdAt	date-time
carregadoPor	uploadedBy	UploadedByDto
baixarUrl	downloadUrl	string

CarregadoPorDto

Name	Caminho	Tipo
id	id	uuid
kind	kind	string
Nome	name	string

DocumentDetailDto

Name	Caminho	Tipo
id	id	uuid
Nome	name	string
description	description	string
mimeType	mimeType	string
sizeBytes	sizeBytes	integer
estado	status	string
createdAt	createdAt	date-time
carregadoPor	uploadedBy	UploadedByDto
baixarUrl	downloadUrl	string

FunçõesDepartamentoDto

Name	Caminho	Tipo
departmentId	departmentId	uuid
departmentName	departmentName	string
roleId	roleId	uuid
nome_da-função	roleName	string

UserDto

Name	Caminho	Tipo
id	id	uuid
e-mail	email	string
firstName	firstName	string
lastName	lastName	string
estado	status	string
kind	kind	string
isAdmin	isAdmin	boolean
createdAt	createdAt	date-time
Departamento Funções	departmentRoles	array of DepartmentRoleDto

PerguntaDto

Name	Caminho	Tipo
id	id	uuid
tipo	type	string
parentId	parentId	uuid
tipo pai	parentType	string
enviar SMS	text	string
ordinalNumber	ordinalNumber	integer
origem	source	string
Resposta esperada	expectedAnswer	string
options	options	array of QuestionOptionDto
createdAt	createdAt	date-time
atualizado em	updatedAt	date-time

PerguntaOptionDto

Name	Caminho	Tipo
enviar SMS	text	string
éCorreto	isCorrect	boolean
ordinalNumber	ordinalNumber	integer

PerguntaListaResposta

Name	Caminho	Tipo	Descrição
items	items	array of QuestionDto

LearningByteDetailDto

Name	Caminho	Tipo
id	id	uuid
tópicoId	topicId	uuid
Nome	name	string
description	description	string
ordinalNumber	ordinalNumber	integer
origem	source	string
createdAt	createdAt	date-time
atualizado em	updatedAt	date-time
Lições	lessons	array of LessonDto

LiçãoDto

Name	Caminho	Tipo
id	id	uuid
learningByteId	learningByteId	uuid
conteúdo	content	string
ordinalNumber	ordinalNumber	integer
origem	source	string
perguntaContagem	questionCount	integer
mediaCount	mediaCount	integer
createdAt	createdAt	date-time
atualizado em	updatedAt	date-time

ExerciseDto

Name	Caminho	Tipo
id	id	uuid
tópicoId	topicId	uuid
tipo	type	string
avisar	prompt	string
ordinalNumber	ordinalNumber	integer
origem	source	string
isGenerated	isGenerated	boolean
avatarPictureId	avatarPictureId	uuid
avatarCaracterísticas	avatarCharacteristics	string
reverseRolePlayEnabled	reverseRolePlayEnabled	boolean
reversoRolePlayObrigatório	reverseRolePlayMandatory	boolean
Conteúdo gerado	generatedContent	ExerciseGeneratedContentDto
createdAt	createdAt	date-time
atualizado em	updatedAt	date-time

ExerciseGenerationedContentDto

Name	Caminho	Tipo
id	id	uuid
regenerationId	regenerationId	uuid
cenário	scenario	string
estagiárioPapel	traineeRole	string
avatarName	avatarName	string
avatarDescription	avatarDescription	string
Desafio operacional	operationalChallenge	string
Métrica de sucesso	successMetric	string
Instruções	instruction	string
instrução Reversa	instructionReverse	string
exerciseKnowledgeBase	exerciseKnowledgeBase	string
Base de Conhecimento do AssuntoTópico	topicKnowledgeBase	string

TopicListResponse

Name	Caminho	Tipo	Descrição
items	items	array of TopicDto

Detalhe da LiçãoDto

Name	Caminho	Tipo
id	id	uuid
learningByteId	learningByteId	uuid
conteúdo	content	string
ordinalNumber	ordinalNumber	integer
origem	source	string
createdAt	createdAt	date-time
atualizado em	updatedAt	date-time
suporte de dados	media	array of MediaLinkDto
perguntas	questions	array of QuestionDto

MediaLinkDto

Name	Caminho	Tipo
id	id	uuid
fileId	fileId	uuid
ordinalNumber	ordinalNumber	integer
origem	source	string

ExpertDetailDto

Name	Caminho	Tipo
id	id	uuid
Nome	name	string
description	description	string
estado	status	string
linkedDocumentCount	linkedDocumentCount	integer
createdAt	createdAt	date-time
atualizado em	updatedAt	date-time
assignedRoleIds	assignedRoleIds	array of uuid
assignedDepartmentIds	assignedDepartmentIds	array of uuid
Documentos ligados	linkedDocuments	array of LinkedDocumentDto

LinkedDocumentDto

Name	Caminho	Tipo
id	id	uuid
Nome	name	string
extensão	extension	string
sizeBytes	sizeBytes	integer
description	description	string
linkedAt	linkedAt	date-time

AskResponse

Name	Caminho	Tipo	Descrição
resposta	answer	string
durationMs	durationMs	integer

DepartamentoDto

Name	Caminho	Tipo
id	id	uuid
Nome	name	string
description	description	string
estado	status	string
createdAt	createdAt	date-time
roles	roles	array of DepartmentRoleDto

DemoTrainingDto

Name	Caminho	Tipo
id	id	uuid
companyId	companyId	uuid
departmentId	departmentId	uuid
Nome	name	string
description	description	string
Tipo de treino	trainingType	string
estado	status	string
está disponível	isAvailable	boolean
videoFileId	videoFileId	uuid
ProcessamentoPrompt	processingPrompt	string
errorMessage	errorMessage	string
assignedRoleIds	assignedRoleIds	array of uuid
segments	segments	array of DemoTrainingSegmentDto
createdAt	createdAt	date-time
atualizado em	updatedAt	date-time

DemoTrainingSegmentDto

Name	Caminho	Tipo
id	id	uuid
ordinalNumber	ordinalNumber	integer
Nome	name	string
transcrição	transcript	string
duraçãoSegundos	durationSeconds	integer

CourseDetailDto

Name	Caminho	Tipo
id	id	uuid
Nome	name	string
estado	status	string
ModuleCount	moduleCount	integer
Contagem de tópicos	topicCount	integer
hasUnpublishedChanges	hasUnpublishedChanges	boolean
currentVersionNumber	currentVersionNumber	integer
createdAt	createdAt	date-time
atualizado em	updatedAt	date-time
assignedRoleIds	assignedRoleIds	array of uuid
assignedDepartmentIds	assignedDepartmentIds	array of uuid
modules	modules	array of ModuleSummaryDto

ResumoMóduloDto

Name	Caminho	Tipo
id	id	uuid
Nome	name	string
ordinalNumber	ordinalNumber	integer
Contagem de tópicos	topicCount	integer

GeraçãoSolicitaçãoResposta

Name	Caminho	Tipo	Descrição
id	id	uuid
estado	status	string

ModuleDto

Name	Caminho	Tipo
id	id	uuid
Id do curso	courseId	uuid
Nome	name	string
description	description	string
productId	productId	uuid
ordinalNumber	ordinalNumber	integer
lockedForGeneration	lockedForGeneration	boolean
Contagem de tópicos	topicCount	integer
Cenários do quiz	quizSettings	array of QuizSettingDto

ModuleListResponse

Name	Caminho	Tipo	Descrição
items	items	array of ModuleDto

GenerateCourseResponse

Name	Caminho	Tipo	Descrição
Id do curso	courseId	uuid
generationRequestId	generationRequestId	uuid

PageInfo

Name	Caminho	Tipo
size	size	integer
número	number	integer
totalElements	totalElements	integer
total de páginas	totalPages	integer

UserListResponse

Name	Caminho	Tipo	Descrição
items	items	array of UserDto
página	page	PageInfo

TopicLinkedDocumentDto

Name	Caminho	Tipo
id	id	uuid
Nome	name	string
extensão	extension	string
size	size	integer
Estado do processamento	processingStatus	string
description	description	string
origem	source	string
linkType	linkType	string
linkedAt	linkedAt	date-time

TópicoLigadoDocumentoListaResposta

Name	Caminho	Tipo	Descrição
items	items	array of TopicLinkedDocumentDto
página	page	PageInfo

LearningByteDto

Name	Caminho	Tipo
id	id	uuid
tópicoId	topicId	uuid
Nome	name	string
description	description	string
ordinalNumber	ordinalNumber	integer
origem	source	string
Contagem de lições	lessonCount	integer
createdAt	createdAt	date-time
atualizado em	updatedAt	date-time

LearningByteListResponse

Name	Caminho	Tipo	Descrição
items	items	array of LearningByteDto

ExerciseListResponse

Name	Caminho	Tipo	Descrição
items	items	array of ExerciseDto

CertificateDto

Name	Caminho	Tipo
id	id	uuid
enrollmentId	enrollmentId	uuid
studentId	studentId	uuid
companyId	companyId	uuid
Id do curso	courseId	uuid
courseVersionId	courseVersionId	uuid
Nomedo do estudante	studentName	string
companyName	companyName	string
courseName [en]	courseName	string
serialNumber	serialNumber	string
concluídoAt	completedAt	date-time
emitidoem	issuedAt	date-time
pdfFileId	pdfFileId	uuid
pdfDisponível	pdfAvailable	boolean

CertificateListResponse

Name	Caminho	Tipo	Descrição
items	items	array of CertificateDto

MediaDto

Name	Caminho	Tipo
id	id	uuid
Nome	name	string
description	description	string
kind	kind	string
mimeType	mimeType	string
sizeBytes	sizeBytes	integer
estado	status	string
Estado do processamento	processingStatus	string
createdAt	createdAt	date-time
carregadoPor	uploadedBy	UploadedByDto

MediaListResponse

Name	Caminho	Tipo	Descrição
items	items	array of MediaDto
página	page	PageInfo

LiçãoListaResposta

Name	Caminho	Tipo	Descrição
items	items	array of LessonDto

CourseBreakdownDto

Name	Caminho	Tipo
Id do curso	courseId	uuid
courseName [en]	courseName	string
progressoPercentagem	progressPercent	integer
Horas Passadas	hoursSpent	double
começouEm	startedAt	date-time
concluídoAt	completedAt	date-time

EstudantesInsightsDto

Name	Caminho	Tipo
userId	userId	uuid
janela	window	WindowDto
resumo	summary	StudentSummaryDto
byCourse	byCourse	array of CourseBreakdownDto

ResumoEstudanteDto

Name	Caminho	Tipo
activeDays	activeDays	integer
lições concluídas	lessonsCompleted	integer
ExercíciosConcluídos	exercisesCompleted	integer
quizzesAprovado	quizzesPassed	integer
Horas Passadas	hoursSpent	double

WindowDto

Name	Caminho	Tipo
kind	kind	string
de	from	date-time
Para	to	date-time

EventItemDto

Name	Caminho	Tipo
id	id	uuid
kind	kind	string
ação	action	string
Id do curso	courseId	uuid
courseName [en]	courseName	string
ocorreuEm	occurredAt	date-time

EventListResponse

Name	Caminho	Tipo	Descrição
items	items	array of EventItemDto
página	page	PageInfo

CompanyInsightsDto

Name	Caminho	Tipo	Descrição
companyId	companyId	uuid
resumo	summary	CompanySummaryDto

Resumo da EmpresaDto

Name	Caminho	Tipo
totalAlunos	totalStudents	integer
médiaProgressoPercentagem	averageProgressPercent	integer
ativaEstaSemanaContagem	activeThisWeekCount	integer
completadoContagem	completedCount	integer
ConclusãoTaxa Percentual	completionRatePercent	integer

ExpertDto

Name	Caminho	Tipo
id	id	uuid
Nome	name	string
description	description	string
estado	status	string
linkedDocumentCount	linkedDocumentCount	integer
createdAt	createdAt	date-time
atualizado em	updatedAt	date-time

ExpertListResponse

Name	Caminho	Tipo	Descrição
items	items	array of ExpertDto
página	page	PageInfo

DocumentDto

Name	Caminho	Tipo
id	id	uuid
Nome	name	string
description	description	string
mimeType	mimeType	string
sizeBytes	sizeBytes	integer
estado	status	string
createdAt	createdAt	date-time
carregadoPor	uploadedBy	UploadedByDto

DocumentListResponse

Name	Caminho	Tipo	Descrição
items	items	array of DocumentDto
página	page	PageInfo

DepartamentoListaResposta

Name	Caminho	Tipo	Descrição
items	items	array of DepartmentDto

DemoTrainingListItemDto

Name	Caminho	Tipo
id	id	uuid
departmentId	departmentId	uuid
videoFileId	videoFileId	uuid
Nome	name	string
description	description	string
Tipo de treino	trainingType	string
estado	status	string
está disponível	isAvailable	boolean
assignedRoleIds	assignedRoleIds	array of uuid
segmentContagem	segmentCount	integer
duraçãoSegundos	durationSeconds	integer
createdAt	createdAt	date-time

DemoTrainingListResponse

Name	Caminho	Tipo	Descrição
items	items	array of DemoTrainingListItemDto
página	page	PageInfo

CourseDto

Name	Caminho	Tipo
id	id	uuid
Nome	name	string
estado	status	string
ModuleCount	moduleCount	integer
Contagem de tópicos	topicCount	integer
hasUnpublishedChanges	hasUnpublishedChanges	boolean
currentVersionNumber	currentVersionNumber	integer
mais recentePublicado em	latestPublishedAt	date-time
createdAt	createdAt	date-time

CourseListResponse

Name	Caminho	Tipo	Descrição
items	items	array of CourseDto
página	page	PageInfo

GenerationProgressDto

Name	Caminho	Tipo
totalTasks	totalTasks	integer
completedTarefas	completedTasks	integer
failedTasks	failedTasks	integer

GenerationRequestInfoDto

Name	Caminho	Tipo
id	id	uuid
estado	status	string
createdAt	createdAt	string
concluídoAt	completedAt	string
erro	error	string
progress	progress	GenerationProgressDto
destino	target	string
targetId	targetId	uuid
tipo pai	parentType	string
topicIds	topicIds	array of uuid
moduleIds	moduleIds	array of uuid

GenerationStatusResponse

Name	Caminho	Tipo	Descrição
activeRequests	activeRequests	array of GenerationRequestInfoDto

CourseVersionDto

Name	Caminho	Tipo
id	id	uuid
Id do curso	courseId	uuid
versionNumber	versionNumber	integer
publicado em	publishedAt	date-time
publicado por	publishedBy	uuid
ModuleCount	moduleCount	integer
Contagem de tópicos	topicCount	integer
Contagem de lições	lessonCount	integer
Contagem de exercícios	exerciseCount	integer
perguntaContagem	questionCount	integer
estimadoTimeSeconds	estimatedTimeSeconds	integer

ClasseVersãoListaResposta

Name	Caminho	Tipo	Descrição
items	items	array of CourseVersionDto

AuditSnapshot

Name	Caminho	Tipo
createdAt	createdAt	date-time
criado por	createdBy	uuid
atualizado em	updatedAt	date-time
atualizadoPor	updatedBy	uuid

CourseSnapshot

Name	Caminho	Tipo
Nome	name	string
coverImageId	coverImageId	uuid
PrerequisiteCourseId	prerequisiteCourseId	uuid
Orientação do cursoGuia	courseGuideline	string
liçõesOrientação	lessonsGuideline	string
perguntasOrientação	questionsGuideline	string
exercíciosDiretrizes	exercisesGuideline	string
modules	modules	array of ModuleSnapshot

CourseVersionSnapshotDto

Name	Caminho	Tipo
id	id	uuid
Id do curso	courseId	uuid
versionNumber	versionNumber	integer
instantâneo	snapshot	CourseSnapshot

ExercícioSnapshot

Name	Caminho	Tipo
id	id	uuid
tópicoId	topicId	uuid
exercícioTipo	exerciseType	string
avisar	prompt	string
ordinalNumber	ordinalNumber	integer
isGenerated	isGenerated	boolean
origem	source	string
auditoria	audit	AuditSnapshot
avatarCaracterísticas	avatarCharacteristics	string
avatarPictureId	avatarPictureId	uuid
reverseRolePlayEnabled	reverseRolePlayEnabled	boolean
reversoRolePlayObrigatório	reverseRolePlayMandatory	boolean
cenário	scenario	string
estagiárioPapel	traineeRole	string
avatarName	avatarName	string
avatarDescription	avatarDescription	string
Desafio operacional	operationalChallenge	string
Métrica de sucesso	successMetric	string
Instruções	instruction	string
instrução Reversa	instructionReverse	string
exerciseKnowledgeBase	exerciseKnowledgeBase	string

LearningByteSnapshot

Name	Caminho	Tipo
id	id	uuid
tópicoId	topicId	uuid
Nome	name	string
description	description	string
ordinalNumber	ordinalNumber	integer
origem	source	string
auditoria	audit	AuditSnapshot
Lições	lessons	array of LessonSnapshot

LiçãoSnapshot

Name	Caminho	Tipo
id	id	uuid
learningByteId	learningByteId	uuid
conteúdo	content	string
ordinalNumber	ordinalNumber	integer
origem	source	string
auditoria	audit	AuditSnapshot
suporte de dados	media	array of MediaSnapshot
perguntas	questions	array of QuestionSnapshot

LinkedDocumentSnapshot

Name	Caminho	Tipo
id	id	uuid
fileId	fileId	uuid
linkType	linkType	string
isSupplement	isSupplement	boolean
Nome	name	string
extensão	extension	string
size	size	integer
description	description	string

MediaSnapshot

Name	Caminho	Tipo
id	id	uuid
fileId	fileId	uuid
ordinalNumber	ordinalNumber	integer
mediaType	mediaType	string
origem	source	string

ModuleSnapshot

Name	Caminho	Tipo
id	id	uuid
Id do curso	courseId	uuid
productId	productId	uuid
Nome	name	string
description	description	string
Introdução	intro	string
ordinalNumber	ordinalNumber	integer
Cenários do quiz	quizSettings	array of QuizSettingSnapshot
PerguntasQuiz	quizQuestions	array of QuestionSnapshot
topics	topics	array of TopicSnapshot

OptionSnapshot

Name	Caminho	Tipo
id	id	uuid
optionTexto	optionText	string
éCorreto	isCorrect	boolean
ordinalNumber	ordinalNumber	integer

PerguntaInstantâneo

Name	Caminho	Tipo
id	id	uuid
perguntaTipo de pergunta	questionType	string
perguntaTexto	questionText	string
Resposta esperada	expectedAnswer	string
ordinalNumber	ordinalNumber	integer
origem	source	string
auditoria	audit	AuditSnapshot
options	options	array of OptionSnapshot

QuizSettingSnapshot

Name	Caminho	Tipo	Descrição
perguntaTipo de pergunta	questionType	string
contagem	count	integer

TópicoSnapshot

Name	Caminho	Tipo
id	id	uuid
moduleId	moduleId	uuid
Nome	name	string
description	description	string
Introdução	intro	string
ordinalNumber	ordinalNumber	integer
Cenários do quiz	quizSettings	array of QuizSettingSnapshot
PerguntasQuiz	quizQuestions	array of QuestionSnapshot
learningBytes	learningBytes	array of LearningByteSnapshot
Exercícios	exercises	array of ExerciseSnapshot
Documentos ligados	linkedDocuments	array of LinkedDocumentSnapshot
Base de Conhecimento do AssuntoTópico	topicKnowledgeBase	string

StreamingResponseBody