Машин времени (предварительная версия)

Time Machine — это платформа корпоративного обучения, на основе ИИ. Это превращает корпоративные документы, видео и знания экспертов в структурированные курсы с модулями, разделами, тестами и упражнениями для воспроизведения ролей и отслеживает ход обучения. Создано для команд hr и L&D, которые на борту, обучении и сертификации сотрудников в большом масштабе. Соединитель автоматизирует полный жизненный цикл обучения: управление курсами, пользователями, отделами и ролями; создайте тесты из документов; и чтение аналитики завершения.

Этот соединитель доступен в следующих продуктах и регионах:

Service	Class	Регионы
Copilot Studio	Премия	Все регионы Power Automate за исключением следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD)
Логические приложения	Стандарт	Все регионы Logic Apps , кроме следующих: - Azure для государственных организаций регионы - Azure регионы Китая - Министерство обороны США (DoD)
Power Apps	Премия	Все регионы Power Apps кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD)
Power Automate	Премия	Все регионы Power Automate за исключением следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD)

Контакт
Имя	Поддержка машин времени
URL	https://timeml.ai

Метаданные соединителя
Publisher	ИИ машинного времени
Веб-сайт	https://timeml.ai
Политика конфиденциальности	https://timeml.ai/privacy-policy
Categories	Производительность; ИИ

Time Machine — соединитель Power Automate

Что такое Time Machine

Time Machine — это платформа обучения на основе ИИ, которая помогает компаниям создавать, работать и постоянно улучшать адаптивные системы обучения для современных команд. Организации используют time Machine для преобразования существующих знаний, документов, записей и рабочих процессов в масштабируемые учебные процессы, которые ускоряют подключение, повышают готовность сотрудников и реплицируют опыт топ-исполнителей в организации.

Администраторы клиентов управляют пользователями, контентом обучения, ресурсами организации и конфигурацией платформы с помощью REST API time Machine. Этот соединитель предоставляет общедоступный REST API как Power Automate действия, что позволяет автоматизировать подготовку пользователей, прием содержимого, синхронизацию знаний и управление жизненным циклом без написания кода.

Необходимые условия

Активный клиент Time Machine с доступом администратора
Ключ API time Machine, выданный из параметров → ключи API на панели администрирования (https://web.timeml.ai). Ключ — это значение, начиная с tm_live_.

Аутентификация

Каждое действие проходит проверку подлинности с помощью ключа API в заголовке Authorization . При создании подключения в Power Automate:

Поле: API key
Значение: вставка Bearer tm_live_<your-token> (полная строка, включая Bearer префикс и пробел перед маркером)

Доступные действия

Соединитель зеркально отражает общедоступный REST API time Machine (116 конечных точек). Действия группируются по ресурсу:

Курсы — список, создание, обновление, удаление и публикация курсов, назначение ролей, создание содержимого с помощью ИИ
Пользователи — список, создание, обновление, деактивация и повторная активация пользователей
Документы — список, отправка, обновление и удаление документов
Носитель — список, отправка, обновление и удаление элементов мультимедиа
Отделы — список, создание и обновление и удаление отделов, управление ролями, назначение пользователей ролям
Эксперты — список и создание профилей экспертов, задавать вопросы экспертам, назначать документы и роли
Демонстрационные учебные курсы — список, создание, обновление и удаление демонстрационных учебных занятий
Содержимое курса — модули, темы, уроки, упражнения, тестовые вопросы
Аналитика — на учащихся, на курс и аналитику уровня компании
Сертификаты — список сертификатов учащихся, скачивание PDF-файлов сертификатов

Полный справочник по конечной точке доступен по адресу https://api.timeml.ai/api/v1/docs.

Примеры рабочих процессов

Выпуск Confluence → Time Machine: когда страница выпуска публикуется в Confluence, отправьте его в виде документа в time Machine, чтобы он перетекал в библиотеку байтов обучения.
Подключение кадров: когда в вашей HRIS появится новая строка сотрудника, создайте пользователя Time Machine со своим отделом и назначениями ролей, активируя приглашение на магическую ссылку.
Уведомления о завершении курса: когда учащийся завершает курс, отправьте PDF-файл сертификата в Slack и запишите завершение в Google Sheet.

Известные ограничения

Смена ключа API: подключения необходимо обновлять вручную при смене ключа API. Нет механизма автоматического обновления.
Многопартийные отправки: действия отправки файлов (отправка документа, передача мультимедиа) принимают файлы до 50 МБ. Для больших носителей разбиение на несколько отправлений или обратитесь в службу поддержки Time Machine.
Пакетные операции: API работает с одной записью за раз. Для массовых действий используйте встроенный элемент управления Power Automate apply-to-each.

Support

Чтобы получить вопросы или проблемы с соединителем, обратитесь в службу поддержки support@timeml.aiучетной записи time Machine или по электронной почте.

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:


По умолчанию	Параметры для создания подключения.	Все регионы	Недоступен для совместного использования

По умолчанию

Применимо: все регионы

Параметры для создания подключения.

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Имя	Тип	Description	Обязательный
Ключ API time Machine (формат: носитель tm_live_...)	securestring	Ключ API машинного компьютера времени (формат: носитель tm_live_...) для этого API	True

Действия

Активация создания контента ИИ для тем	Создание содержимого ИИ для указанных тем в рамках курса
Аналитика на уровне компании	Ключевые показатели эффективности для компании вызывающего абонента
Аналитические сведения для каждого учащегося	Агрегированная сводка и разбивка по курсу для заданного окна
Вопросы о переупорядочении теста по теме	идентификаторы вопросов должны включать каждый активный вопрос теста для темы в новом порядке.
Вопросы о переупорядочении тестов в модуле	идентификаторы вопросов должны включать каждый активный вопрос теста для модуля в новом порядке.
Вывод вопросов о тесте в модуле	Возвращает вопросы теста, подключенные к указанному модулю.
Вывод списка документов, связанных с разделом	Разбиение на страницы; необязательный поиск по имени документа
Вывод списка модулей в курсе	Возвращает активные модули, упорядоченные порядковый номер
Вывод списка носителей	Список элементов мультимедиа с разбивкой на страницы в компании вызывающего абонента
Вывод списка сертификатов учащегося	Возвращает сертификаты, заработанные заданным студентом в компании вызывающего абонента
Добавление байта обучения в раздел	Создает новый байт обучения внутри заданного раздела.
Добавление вопроса на занятии	тип должен быть MULTIPLE_CHOICE (требуется параметры) или OPEN_ENDED
Добавление вопроса теста в модуль	Создает новый вопрос теста внутри заданного модуля.
Добавление вопроса теста в раздел	Создает новый вопрос теста внутри заданного раздела.
Добавление модуля в курс	Создает новый модуль внутри заданного курса.
Добавление раздела в модуль	Создает новый раздел внутри заданного модуля.
Добавление упражнения ILE_TEXT в раздел	Создает новое ILE_TEXT упражнение внутри заданного раздела.
Добавление упражнения RPE_VIDEO в раздел	Создает новое RPE_VIDEO упражнение для воспроизведения ролей в данном разделе.
Добавление упражнения RPE_VOICE в раздел	Создает новое RPE_VOICE упражнение для воспроизведения ролей внутри заданного раздела.
Добавление урока в байт обучения	Создает новый урок внутри заданного байта обучения.
Задать эксперту вопрос	Синхронная оболочка вокруг чата ИИ потоковой передачи. Возвращает собранный ответ.
Замена двоичного файла документа	Заменяет двоичный файл существующего документа; Метаданные сохраняются
Замена двоичного файла мультимедиа	Заменяет двоичный файл существующего элемента мультимедиа; Метаданные сохраняются
Изменение порядка модулей в курсе	ModuleIds должен включать каждый активный модуль ровно один раз в новом порядке.
Изменение порядка разделов в модуле	TopicIds должен включать каждый активный раздел ровно один раз в новом порядке.
Назначение документов эксперту	Массовое связывание документов с экспертом. Идемпотент.
Назначение пользователю роли	Идемпотентный
Назначение ролей курсу	Аддитивная — роли, уже назначенные, пропускаются. Возвращает обновленные сведения о курсе
Назначение ролей эксперту	Аддитивные — уже назначенные роли хранятся; добавлены новые. Возвращает обновленный эксперт
Обновление вопроса на занятии	Укажите поля, соответствующие сохраненного типа; несвязанные поля игнорируются
Обновление демонстрационного обучения	Частичное обновление. Передайте только поля, которые нужно изменить. assignedRoleIds заменяет текущий набор.
Обновление метаданных байтов обучения	Опущенные поля сохраняют текущие значения
Обновление метаданных документа	Обновление имени и /или описания
Обновление метаданных курса	Обновление имени курса
Обновление метаданных модуля	Обновляет имя и/или описание. Опущенные поля сохраняют текущие значения
Обновление метаданных мультимедиа	Обновление имени и /или описания
Обновление метаданных раздела	Обновляет имя и/или описание. Опущенные поля сохраняют текущие значения
Обновление одного вопроса теста в модуле	Укажите поля, соответствующие сохраненного типа; несвязанные поля игнорируются.
Обновление одного вопроса теста по теме	Укажите поля, соответствующие сохраненного типа; несвязанные поля игнорируются.
Обновление отдела	Обновление имени и /или описания
Обновление пользователя	Обновление firstName, lastName, isAdmin и назначений ролей. Электронная почта не редактируется в версии 1.
Обновление содержимого урока	Опущенное содержимое сохраняет текущее значение
Обновление упражнения	С учетом типов: ILE_TEXT использует только запрос + createedContent.scenario; RPE_* использует все поля RPE. Опущенные поля сохраняют текущие значения.
Отключение пользователя	Idempotent — возвращает пользователя, даже если он уже деактивирован
Отмена назначения документа экспертом	Идемпотентный
Отмена назначения пользователя из роли	Идемпотент — 204 даже если не назначено
Отмена связывания одного документа из раздела	Идемпотентный
Отправка документа	Многопартийная отправка (файл + необязательное описание). Максимальное значение 50 МБ.
Отправка элемента мультимедиа	Многопартийная отправка (файл + необязательное описание). Максимум 50 МБ для изображений, 500 МБ для видео.
Переключение доступности для учащихся	Задайте, публикуется ли демонстрационная подготовка учащимся. Идемпотент.
Перемещение раздела в другой модуль	targetOrdinalNumber является необязательным; Значение , если этот раздел не указан в целевом модуле
Переупорядочение вопросов на занятии	идентификаторы вопросов должны включать каждый активный вопрос для урока в новом порядке
Перечисление байтов обучения в разделе	Возвращает байты обучения, принадлежащие заданному разделу.
Перечисление версий курса	Возвращает опубликованные метаданные версии (счетчики и сведения о публикации), упорядоченные по номеру версии
Перечисление вопросов на занятии	Возвращает вопросы проверки знаний, присоединенные к заданному занятию.
Перечисление вопросов теста по теме	Возвращает вопросы теста, присоединенные к данной теме.
Перечисление демонстрационных учебных занятий	Список с разбивкой на страницы, ограниченный компанией вызывающего абонента
Перечисление курсов	Список курсов с разбивкой на страницы в компании вызывающего абонента
Перечисление отделов	Все отделы в компании вызывающего абонента с вложенными ролями
Перечисление тем в модуле	Возвращает активные разделы, упорядоченные порядковый номер
Перечисление упражнений в разделе	Смешанные типы (ILE_TEXT/ RPE_VOICE / RPE_VIDEO), упорядоченные по порядковой номеру
Перечисление уроков в байтах обучения	Возвращает уроки, принадлежащие заданному байту обучения.
Повторная активация пользователя	Idempotent — возвращает пользователя, даже если он уже активен
Повторная обработка видео	Повторно отправляет видео для сегментации искусственного интеллекта. При необходимости переопределите запрос обработки.
Повторное создание определенного элемента с помощью искусственного интеллекта	Повторно создает один урок, вопросы урока, тест, интро или упражнение
Получение байта обучения	Возвращает метаданные и вложенные уроки
Получение встроенных сведений о модуле	Возвращает встроенный текстовый набор в заданном модуле.
Получение демонстрационного обучения	Возвращает полный демонстрационный учебный курс с сегментами
Получение документа	Возвращает метаданные документа и URL-адрес для скачивания со знаком с коротким сроком действия
Получение курса	Возвращает метаданные курса с сводкой модуля и назначенными ролями и отделами
Получение модуля	Возвращает сведения о модуле для заданного идентификатора.
Получение моментального снимка версии курса	Возвращает полное дерево содержимого (модули, разделы, уроки, упражнения, вопросы) для данной версии
Получение одного вопроса теста в модуле	Возвращает один вопрос теста, подключенный к заданному модулю.
Получение одного вопроса теста по теме	Возвращает один вопрос теста, прикрепленный к заданному разделу.
Получение одного из вопросов на занятии	Возвращает один вопрос в уроке по его идентификатору.
Получение подробного раздела	Возвращает набор текста интро для заданного раздела.
Получение пользователя	Возвращает метаданные пользователя и назначения ролей или отделов
Получение раздела	Возвращает сведения о разделе для заданного идентификатора.
Получение состояния создания ИИ для курса	Возвращает список активных запросов на создание ИИ для курса с информацией о ходе выполнения и целевой информации.
Получение упражнения	Возвращает сведения о упражнении для заданного идентификатора.
Получение урока	Возвращает содержимое урока, мультимедиа и вопросы на уроке
Получение эксперта	Возвращает метаданные эксперта, связанные документы и назначенные роли и отделы
Получение элемента мультимедиа	Возвращает метаданные мультимедиа и URL-адрес для скачивания со знаком с коротким сроком действия.
Публикация курса	Публикует курс; завершается ошибкой 400, если у него нет публикуемого содержимого
Сведения о сертификате	Возвращает один сертификат, ограниченный компанией вызывающего абонента.
Связывание документов с разделом	Аддитивные — уже связанные документы пропускаются
Скачивание PDF-файла сертификата	Потоковая передача PDF-файла сертификата. Возвращает значение 404, если сертификат еще не имеет PDF-файла
События активности для каждого учащегося	Поток событий с разбивкой на страницы только для пересылки
Создание демонстрационного обучения	Создает демонстрационное обучение из ранее отправленного видеофайла и запускает обработку
Создание отдела	Создает новый отдел в компании вызывающего абонента.
Создание полного курса с содержимым ИИ	Создает оболочку курса, все модули, все разделы и создание содержимого ИИ для каждого раздела
Создание пользователя	Создает пользователя и активирует поток приглашения по магии
Создание пустого курса	Создает новую оболочку курса с заданным именем
Создание роли в отделе	Создает новую роль, ограниченную заданным отделом.
Список документов	Список документов с разбивкой на страницы в компании вызывающего абонента
Список пользователей	Список пользователей с разбивкой на страницы в компании вызывающего абонента
Список экспертов	Список экспертов по разбивке на страницы в компании вызывающего абонента
Удаление (деактивация) документа	Идемпотент — возвращает 204, даже если документ уже удален или отсутствует
Удаление (деактивация) отдела	Идемпотент — возвращает 204, даже если он уже деактивирован. Каскады для назначений ролей.
Удаление (деактивация) элемента мультимедиа	Idempotent — возвращает значение 204, даже если элемент уже удален или отсутствует
Удаление (обратимое) курса	Идемпотент — возвращает 204, даже если курс уже удален
Удаление байта обучения (обратимое)	Идемпотент — 204, даже если он уже удален
Удаление вопроса на занятии	Идемпотент — 204, даже если он уже удален
Удаление всех назначений ролей из курса	Идемпотентный
Удаление всех назначений ролей от эксперта	Идемпотентный
Удаление встроенного модуля	Идемпотент — 204, даже если ни в коем случае не задано
Удаление демонстрационного обучения	Идемпотент — возвращает 204, даже если демонстрационная подготовка не существует или уже исчезла
Удаление модуля (обратимое)	Idempotent — возвращает 204, даже если модуль уже удален.
Удаление одного вопроса теста в модуле	Идемпотент — 204, даже если он уже удален
Удаление одного вопроса теста по теме	Идемпотент — 204, даже если он уже удален
Удаление одного назначения роли из курса	Идемпотентный
Удаление одного назначения роли от эксперта	Идемпотентный
Удаление раздела	Идемпотент — 204, даже если ни в коем случае не задано
Удаление раздела (обратимое)	Идемпотент — возвращает 204, даже если раздел уже удален
Удаление упражнения	Идемпотент — 204, даже если он уже удален
Удаление урока (обратимое)	Идемпотент — 204, даже если он уже удален
Установка или замена встроенного модуля	Upsert — создает, если отсутствует, заменяет при наличии
Установка или замена раздела	Upsert — создает, если отсутствует, заменяет при наличии
Установка количества тестов модуля для одного типа вопроса	Заменяет количество заданных вопросов (MULTIPLE_CHOICE или OPEN_ENDED). Число других типов сохраняется
Установка счетчика вопросов для одного типа вопроса	Заменяет количество заданных вопросов (MULTIPLE_CHOICE или OPEN_ENDED). Число других типов сохраняется

Активация создания контента ИИ для тем

Идентификатор операции:: generateCourseContent

Создание содержимого ИИ для указанных тем в рамках курса

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Id	id	True	uuid	Id
topicIds	topicIds	True	array of uuid

Возвращаемое значение

Тело: GenerationRequestResponse

Аналитика на уровне компании

Идентификатор операции:: getCompanyInsights

Ключевые показатели эффективности для компании вызывающего абонента

Возвращаемое значение

Тело: CompanyInsightsDto

Аналитические сведения для каждого учащегося

Идентификатор операции:: getStudentInsights

Агрегированная сводка и разбивка по курсу для заданного окна

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор пользователя	userId	True	uuid	Идентификатор пользователя
Окно	window		string	Окно

Возвращаемое значение

Тело: StudentInsightsDto

Вопросы о переупорядочении теста по теме

Идентификатор операции:: reorderTopicQuizQuestions

идентификаторы вопросов должны включать каждый активный вопрос теста для темы в новом порядке.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор раздела	topicId	True	uuid	Идентификатор раздела
questionIds	questionIds	True	array of uuid

Возвращаемое значение

Тело: QuestionListResponse

Вопросы о переупорядочении тестов в модуле

Идентификатор операции:: reorderModuleQuizQuestions

идентификаторы вопросов должны включать каждый активный вопрос теста для модуля в новом порядке.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор модуля	moduleId	True	uuid	Идентификатор модуля
questionIds	questionIds	True	array of uuid

Возвращаемое значение

Тело: QuestionListResponse

Вывод вопросов о тесте в модуле

Идентификатор операции:: listModuleQuizQuestions

Возвращает вопросы теста, подключенные к указанному модулю.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор модуля	moduleId	True	uuid	Идентификатор модуля

Возвращаемое значение

Тело: QuestionListResponse

Вывод списка документов, связанных с разделом

Идентификатор операции:: listTopicLinkedDocuments

Разбиение на страницы; необязательный поиск по имени документа

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор раздела	topicId	True	uuid	Идентификатор раздела
Страница	page		integer	Страница
Size	size		integer	Size
Search	search		string	Search

Возвращаемое значение

Тело: TopicLinkedDocumentListResponse

Вывод списка модулей в курсе

Идентификатор операции:: listModulesInCourse

Возвращает активные модули, упорядоченные порядковый номер

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор курса	courseId	True	uuid	Идентификатор курса

Возвращаемое значение

Тело: ModuleListResponse

Вывод списка носителей

Идентификатор операции:: listMedia

Список элементов мультимедиа с разбивкой на страницы в компании вызывающего абонента

Параметры

Имя	Ключ	Тип	Описание
Страница	page	integer	Страница
Size	size	integer	Size
Search	search	string	Search
Kind	kind	string	Kind
Status	status	string	Status

Возвращаемое значение

Тело: MediaListResponse

Вывод списка сертификатов учащегося

Идентификатор операции:: listStudentCertificates

Возвращает сертификаты, заработанные заданным студентом в компании вызывающего абонента

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор пользователя	userId	True	uuid	Идентификатор пользователя

Возвращаемое значение

Тело: CertificateListResponse

Добавление байта обучения в раздел

Идентификатор операции:: addLearningByteToTopic

Создает новый байт обучения внутри заданного раздела.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор раздела	topicId	True	uuid	Идентификатор раздела
имя	name	True	string
description	description		string

Возвращаемое значение

Тело: LearningByteDetailDto

Добавление вопроса на занятии

Идентификатор операции:: addLessonQuestion

тип должен быть MULTIPLE_CHOICE (требуется параметры) или OPEN_ENDED

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор урока	lessonId	True	uuid	Идентификатор урока
type	type	True	string
text	text	True	string
порядковый номер	ordinalNumber		integer
text	text	True	string
isCorrect	isCorrect		boolean
expectedAnswer	expectedAnswer		string

Возвращаемое значение

Тело: QuestionDto

Добавление вопроса теста в модуль

Идентификатор операции:: addModuleQuizQuestion

Создает новый вопрос теста внутри заданного модуля.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор модуля	moduleId	True	uuid	Идентификатор модуля
type	type	True	string
text	text	True	string
порядковый номер	ordinalNumber		integer
text	text	True	string
isCorrect	isCorrect		boolean
expectedAnswer	expectedAnswer		string

Возвращаемое значение

Тело: QuestionDto

Добавление вопроса теста в раздел

Идентификатор операции:: addTopicQuizQuestion

Создает новый вопрос теста внутри заданного раздела.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор раздела	topicId	True	uuid	Идентификатор раздела
type	type	True	string
text	text	True	string
порядковый номер	ordinalNumber		integer
text	text	True	string
isCorrect	isCorrect		boolean
expectedAnswer	expectedAnswer		string

Возвращаемое значение

Тело: QuestionDto

Добавление модуля в курс

Идентификатор операции:: addModuleToCourse

Создает новый модуль внутри заданного курса.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор курса	courseId	True	uuid	Идентификатор курса
имя	name	True	string
description	description		string

Возвращаемое значение

Тело: ModuleDetailDto

Добавление раздела в модуль

Идентификатор операции:: addTopicToModule

Создает новый раздел внутри заданного модуля.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор модуля	moduleId	True	uuid	Идентификатор модуля
имя	name	True	string
description	description		string

Возвращаемое значение

Тело: TopicDto

Добавление упражнения ILE_TEXT в раздел

Идентификатор операции:: addIleTextExercise

Создает новое ILE_TEXT упражнение внутри заданного раздела.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор раздела	topicId	True	uuid	Идентификатор раздела
prompt	prompt		string

Возвращаемое значение

Тело: ExerciseDto

Добавление упражнения RPE_VIDEO в раздел

Идентификатор операции:: addRpeVideoExercise

Создает новое RPE_VIDEO упражнение для воспроизведения ролей в данном разделе.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор раздела	topicId	True	uuid	Идентификатор раздела
prompt	prompt		string
avatarPictureId	avatarPictureId		uuid
аватарCharacteristics	avatarCharacteristics		string
reverseRolePlayEnabled	reverseRolePlayEnabled		boolean
reverseRolePlayMandatory	reverseRolePlayMandatory		boolean

Возвращаемое значение

Тело: ExerciseDto

Добавление упражнения RPE_VOICE в раздел

Идентификатор операции:: addRpeVoiceExercise

Создает новое RPE_VOICE упражнение для воспроизведения ролей внутри заданного раздела.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор раздела	topicId	True	uuid	Идентификатор раздела
prompt	prompt		string
avatarPictureId	avatarPictureId		uuid
аватарCharacteristics	avatarCharacteristics		string
reverseRolePlayEnabled	reverseRolePlayEnabled		boolean
reverseRolePlayMandatory	reverseRolePlayMandatory		boolean

Возвращаемое значение

Тело: ExerciseDto

Добавление урока в байт обучения

Идентификатор операции:: addLessonToLearningByte

Создает новый урок внутри заданного байта обучения.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор lb	lbId	True	uuid	Идентификатор lb
содержимое	content	True	string

Возвращаемое значение

Тело: LessonDetailDto

Задать эксперту вопрос

Идентификатор операции:: askExpert

Синхронная оболочка вокруг чата ИИ потоковой передачи. Возвращает собранный ответ.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Id	id	True	uuid	Id
вопрос	question	True	string

Возвращаемое значение

Тело: AskResponse

Замена двоичного файла документа

Идентификатор операции:: replaceDocumentFile

Заменяет двоичный файл существующего документа; Метаданные сохраняются

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Id	id	True	uuid	Id
File	file	True	file	File

Возвращаемое значение

Тело: DocumentDetailDto

Замена двоичного файла мультимедиа

Идентификатор операции:: replaceMediaFile

Заменяет двоичный файл существующего элемента мультимедиа; Метаданные сохраняются

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Id	id	True	uuid	Id
File	file	True	file	File

Возвращаемое значение

Тело: MediaDetailDto

Изменение порядка модулей в курсе

Идентификатор операции:: reorderModulesInCourse

ModuleIds должен включать каждый активный модуль ровно один раз в новом порядке.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор курса	courseId	True	uuid	Идентификатор курса
moduleIds	moduleIds	True	array of uuid

Возвращаемое значение

Тело: ModuleListResponse

Изменение порядка разделов в модуле

Идентификатор операции:: reorderTopicsInModule

TopicIds должен включать каждый активный раздел ровно один раз в новом порядке.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор модуля	moduleId	True	uuid	Идентификатор модуля
topicIds	topicIds	True	array of uuid

Возвращаемое значение

Тело: TopicListResponse

Назначение документов эксперту

Идентификатор операции:: assignDocumentsToExpert

Массовое связывание документов с экспертом. Идемпотент.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Id	id	True	uuid	Id
documentIds	documentIds	True	array of uuid

Возвращаемое значение

Тело: ExpertDetailDto

Назначение пользователю роли

Идентификатор операции:: assignUserToRole

Идемпотентный

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Id	id	True	uuid	Id
Идентификатор роли	roleId	True	uuid	Идентификатор роли
userId	userId	True	uuid

Возвращаемое значение

Тело: DepartmentDto

Назначение ролей курсу

Идентификатор операции:: assignRolesToCourse

Аддитивная — роли, уже назначенные, пропускаются. Возвращает обновленные сведения о курсе

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Id	id	True	uuid	Id
roleIds	roleIds	True	array of uuid

Возвращаемое значение

Тело: CourseDetailDto

Назначение ролей эксперту

Идентификатор операции:: assignRolesToExpert

Аддитивные — уже назначенные роли хранятся; добавлены новые. Возвращает обновленный эксперт

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Id	id	True	uuid	Id
roleIds	roleIds	True	array of uuid

Возвращаемое значение

Тело: ExpertDetailDto

Обновление вопроса на занятии

Идентификатор операции:: updateLessonQuestion

Укажите поля, соответствующие сохраненного типа; несвязанные поля игнорируются

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор урока	lessonId	True	uuid	Идентификатор урока
Идентификатор вопроса	questionId	True	uuid	Идентификатор вопроса
text	text		string
text	text	True	string
isCorrect	isCorrect		boolean
expectedAnswer	expectedAnswer		string

Возвращаемое значение

Тело: QuestionDto

Обновление демонстрационного обучения

Идентификатор операции:: updateDemoTraining

Частичное обновление. Передайте только поля, которые нужно изменить. assignedRoleIds заменяет текущий набор.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Id	id	True	uuid	Id
имя	name		string
description	description		string
trainingType	trainingType		string
departmentId	departmentId		uuid
assignedRoleIds	assignedRoleIds		array of uuid

Возвращаемое значение

Тело: DemoTrainingDto

Обновление метаданных байтов обучения

Идентификатор операции:: updateLearningByte

Опущенные поля сохраняют текущие значения

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор lb	lbId	True	uuid	Идентификатор lb
имя	name		string
description	description		string

Возвращаемое значение

Тело: LearningByteDetailDto

Обновление метаданных документа

Идентификатор операции:: updateDocumentMetadata

Обновление имени и /или описания

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Id	id	True	uuid	Id
имя	name		string
description	description		string

Возвращаемое значение

Тело: DocumentDetailDto

Обновление метаданных курса

Идентификатор операции:: updateCourse

Обновление имени курса

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Id	id	True	uuid	Id
имя	name		string

Возвращаемое значение

Тело: CourseDetailDto

Обновление метаданных модуля

Идентификатор операции:: updateModule

Обновляет имя и/или описание. Опущенные поля сохраняют текущие значения

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор модуля	moduleId	True	uuid	Идентификатор модуля
имя	name		string
description	description		string

Возвращаемое значение

Тело: ModuleDetailDto

Обновление метаданных мультимедиа

Идентификатор операции:: updateMediaMetadata

Обновление имени и /или описания

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Id	id	True	uuid	Id
имя	name		string
description	description		string

Возвращаемое значение

Тело: MediaDetailDto

Обновление метаданных раздела

Идентификатор операции:: updateTopic

Обновляет имя и/или описание. Опущенные поля сохраняют текущие значения

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор раздела	topicId	True	uuid	Идентификатор раздела
имя	name		string
description	description		string

Возвращаемое значение

Тело: TopicDto

Обновление одного вопроса теста в модуле

Идентификатор операции:: updateModuleQuizQuestion

Укажите поля, соответствующие сохраненного типа; несвязанные поля игнорируются.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор модуля	moduleId	True	uuid	Идентификатор модуля
Идентификатор вопроса	questionId	True	uuid	Идентификатор вопроса
text	text		string
text	text	True	string
isCorrect	isCorrect		boolean
expectedAnswer	expectedAnswer		string

Возвращаемое значение

Тело: QuestionDto

Обновление одного вопроса теста по теме

Идентификатор операции:: updateTopicQuizQuestion

Укажите поля, соответствующие сохраненного типа; несвязанные поля игнорируются.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор раздела	topicId	True	uuid	Идентификатор раздела
Идентификатор вопроса	questionId	True	uuid	Идентификатор вопроса
text	text		string
text	text	True	string
isCorrect	isCorrect		boolean
expectedAnswer	expectedAnswer		string

Возвращаемое значение

Тело: QuestionDto

Обновление отдела

Идентификатор операции:: updateDepartment

Обновление имени и /или описания

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Id	id	True	uuid	Id
имя	name		string
description	description		string

Возвращаемое значение

Тело: DepartmentDto

Обновление пользователя

Идентификатор операции:: updateUser

Обновление firstName, lastName, isAdmin и назначений ролей. Электронная почта не редактируется в версии 1.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Id	id	True	uuid	Id
firstName	firstName		string
lastName	lastName		string
isAdmin	isAdmin		boolean
departmentRoleIds	departmentRoleIds		array of uuid

Возвращаемое значение

Тело: UserDto

Обновление содержимого урока

Идентификатор операции:: updateLesson

Опущенное содержимое сохраняет текущее значение

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор урока	lessonId	True	uuid	Идентификатор урока
содержимое	content		string

Возвращаемое значение

Тело: LessonDetailDto

Обновление упражнения

Идентификатор операции:: updateExercise

С учетом типов: ILE_TEXT использует только запрос + createedContent.scenario; RPE_* использует все поля RPE. Опущенные поля сохраняют текущие значения.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Id	id	True	uuid	Id
prompt	prompt		string
avatarPictureId	avatarPictureId		uuid
аватарCharacteristics	avatarCharacteristics		string
reverseRolePlayEnabled	reverseRolePlayEnabled		boolean
reverseRolePlayMandatory	reverseRolePlayMandatory		boolean
сценарий	scenario		string
traineeRole	traineeRole		string
аватарName	avatarName		string
аватарDescription	avatarDescription		string
operationsChallenge	operationalChallenge		string
successMetric	successMetric		string

Возвращаемое значение

Тело: ExerciseDto

Отключение пользователя

Идентификатор операции:: deactivateUser

Idempotent — возвращает пользователя, даже если он уже деактивирован

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Id	id	True	uuid	Id

Возвращаемое значение

Тело: UserDto

Отмена назначения документа экспертом

Идентификатор операции:: unassignDocumentFromExpert

Идемпотентный

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Id	id	True	uuid	Id
Идентификатор документа	documentId	True	uuid	Идентификатор документа

Отмена назначения пользователя из роли

Идентификатор операции:: unassignUserFromRole

Идемпотент — 204 даже если не назначено

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Id	id	True	uuid	Id
Идентификатор роли	roleId	True	uuid	Идентификатор роли
Идентификатор пользователя	userId	True	uuid	Идентификатор пользователя

Отмена связывания одного документа из раздела

Идентификатор операции:: unlinkDocumentFromTopic

Идемпотентный

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор раздела	topicId	True	uuid	Идентификатор раздела
Идентификатор документа	documentId	True	uuid	Идентификатор документа

Отправка документа

Идентификатор операции:: uploadDocument

Многопартийная отправка (файл + необязательное описание). Максимальное значение 50 МБ.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
File	file	True	file	File
Description	description		string	Description

Возвращаемое значение

Тело: DocumentDetailDto

Отправка элемента мультимедиа

Идентификатор операции:: uploadMedia

Многопартийная отправка (файл + необязательное описание). Максимум 50 МБ для изображений, 500 МБ для видео.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
File	file	True	file	File
Description	description		string	Description

Возвращаемое значение

Тело: MediaDetailDto

Переключение доступности для учащихся

Идентификатор операции:: updateDemoTrainingAvailability

Задайте, публикуется ли демонстрационная подготовка учащимся. Идемпотент.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Id	id	True	uuid	Id
доступен	available	True	boolean

Возвращаемое значение

Тело: DemoTrainingDto

Перемещение раздела в другой модуль

Идентификатор операции:: moveTopic

targetOrdinalNumber является необязательным; Значение , если этот раздел не указан в целевом модуле

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор раздела	topicId	True	uuid	Идентификатор раздела
targetModuleId	targetModuleId	True	uuid
targetOrdinalNumber	targetOrdinalNumber		integer

Возвращаемое значение

Тело: TopicDto

Переупорядочение вопросов на занятии

Идентификатор операции:: reorderLessonQuestions

идентификаторы вопросов должны включать каждый активный вопрос для урока в новом порядке

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор урока	lessonId	True	uuid	Идентификатор урока
questionIds	questionIds	True	array of uuid

Возвращаемое значение

Тело: QuestionListResponse

Перечисление байтов обучения в разделе

Идентификатор операции:: listLearningBytesInTopic

Возвращает байты обучения, принадлежащие заданному разделу.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор раздела	topicId	True	uuid	Идентификатор раздела

Возвращаемое значение

Тело: LearningByteListResponse

Перечисление версий курса

Идентификатор операции:: listCourseVersions

Возвращает опубликованные метаданные версии (счетчики и сведения о публикации), упорядоченные по номеру версии

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор курса	courseId	True	uuid	Идентификатор курса

Возвращаемое значение

Тело: CourseVersionListResponse

Перечисление вопросов на занятии

Идентификатор операции:: listLessonQuestions

Возвращает вопросы проверки знаний, присоединенные к заданному занятию.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор урока	lessonId	True	uuid	Идентификатор урока

Возвращаемое значение

Тело: QuestionListResponse

Перечисление вопросов теста по теме

Идентификатор операции:: listTopicQuizQuestions

Возвращает вопросы теста, присоединенные к данной теме.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор раздела	topicId	True	uuid	Идентификатор раздела

Возвращаемое значение

Тело: QuestionListResponse

Перечисление демонстрационных учебных занятий

Идентификатор операции:: listDemoTrainings

Список с разбивкой на страницы, ограниченный компанией вызывающего абонента

Параметры

Имя	Ключ	Тип	Описание
Страница	page	integer	Страница
Size	size	integer	Size
Search	search	string	Search
Типы обучения	trainingTypes	string	Типы обучения
Статусы	statuses	string	Статусы
Идентификаторы отдела	departmentIds	string	Идентификаторы отдела
Доступно	isAvailable	boolean	Доступно

Возвращаемое значение

Тело: DemoTrainingListResponse

Перечисление курсов

Идентификатор операции:: listCourses

Список курсов с разбивкой на страницы в компании вызывающего абонента

Параметры

Имя	Ключ	Тип	Описание
Страница	page	integer	Страница
Size	size	integer	Size
Search	search	string	Search
Status	status	string	Status
Идентификаторы роли отдела	departmentRoleIds	string	Идентификаторы роли отдела

Возвращаемое значение

Тело: CourseListResponse

Перечисление отделов

Идентификатор операции:: listDepartments

Все отделы в компании вызывающего абонента с вложенными ролями

Возвращаемое значение

Тело: DepartmentListResponse

Перечисление тем в модуле

Идентификатор операции:: listTopicsInModule

Возвращает активные разделы, упорядоченные порядковый номер

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор модуля	moduleId	True	uuid	Идентификатор модуля

Возвращаемое значение

Тело: TopicListResponse

Перечисление упражнений в разделе

Идентификатор операции:: listExercisesInTopic

Смешанные типы (ILE_TEXT/ RPE_VOICE / RPE_VIDEO), упорядоченные по порядковой номеру

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор раздела	topicId	True	uuid	Идентификатор раздела

Возвращаемое значение

Тело: ExerciseListResponse

Перечисление уроков в байтах обучения

Идентификатор операции:: listLessonsInLearningByte

Возвращает уроки, принадлежащие заданному байту обучения.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор lb	lbId	True	uuid	Идентификатор lb

Возвращаемое значение

Тело: LessonListResponse

Повторная активация пользователя

Идентификатор операции:: reactivateUser

Idempotent — возвращает пользователя, даже если он уже активен

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Id	id	True	uuid	Id

Возвращаемое значение

Тело: UserDto

Повторная обработка видео

Идентификатор операции:: reprocessDemoTraining

Повторно отправляет видео для сегментации искусственного интеллекта. При необходимости переопределите запрос обработки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Id	id	True	uuid	Id
processingPrompt	processingPrompt		string

Возвращаемое значение

Тело: DemoTrainingDto

Повторное создание определенного элемента с помощью искусственного интеллекта

Идентификатор операции:: regenerateCourseItem

Повторно создает один урок, вопросы урока, тест, интро или упражнение

Параметры

Имя	Ключ	Обязательно	Тип
target	target	True	string
targetId	targetId	True	uuid
parentType	parentType		string

Возвращаемое значение

Тело: GenerationRequestResponse

Получение байта обучения

Идентификатор операции:: getLearningByte

Возвращает метаданные и вложенные уроки

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор lb	lbId	True	uuid	Идентификатор lb

Возвращаемое значение

Тело: LearningByteDetailDto

Получение встроенных сведений о модуле

Идентификатор операции:: getModuleIntro

Возвращает встроенный текстовый набор в заданном модуле.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор модуля	moduleId	True	uuid	Идентификатор модуля

Возвращаемое значение

Тело: IntroDto

Получение демонстрационного обучения

Идентификатор операции:: getDemoTraining

Возвращает полный демонстрационный учебный курс с сегментами

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Id	id	True	uuid	Id

Возвращаемое значение

Тело: DemoTrainingDto

Получение документа

Идентификатор операции:: getDocument

Возвращает метаданные документа и URL-адрес для скачивания со знаком с коротким сроком действия

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Id	id	True	uuid	Id

Возвращаемое значение

Тело: DocumentDetailDto

Получение курса

Идентификатор операции:: getCourse

Возвращает метаданные курса с сводкой модуля и назначенными ролями и отделами

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Id	id	True	uuid	Id

Возвращаемое значение

Тело: CourseDetailDto

Получение модуля

Идентификатор операции:: getModule

Возвращает сведения о модуле для заданного идентификатора.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор модуля	moduleId	True	uuid	Идентификатор модуля

Возвращаемое значение

Тело: ModuleDetailDto

Получение моментального снимка версии курса

Идентификатор операции:: getCourseVersion

Возвращает полное дерево содержимого (модули, разделы, уроки, упражнения, вопросы) для данной версии

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор курса	courseId	True	uuid	Идентификатор курса
Номер версии	versionNumber	True	integer	Номер версии

Возвращаемое значение

Тело: CourseVersionSnapshotDto

Получение одного вопроса теста в модуле

Идентификатор операции:: getModuleQuizQuestion

Возвращает один вопрос теста, подключенный к заданному модулю.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор модуля	moduleId	True	uuid	Идентификатор модуля
Идентификатор вопроса	questionId	True	uuid	Идентификатор вопроса

Возвращаемое значение

Тело: QuestionDto

Получение одного вопроса теста по теме

Идентификатор операции:: getTopicQuizQuestion

Возвращает один вопрос теста, прикрепленный к заданному разделу.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор раздела	topicId	True	uuid	Идентификатор раздела
Идентификатор вопроса	questionId	True	uuid	Идентификатор вопроса

Возвращаемое значение

Тело: QuestionDto

Получение одного из вопросов на занятии

Идентификатор операции:: getLessonQuestion

Возвращает один вопрос в уроке по его идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор урока	lessonId	True	uuid	Идентификатор урока
Идентификатор вопроса	questionId	True	uuid	Идентификатор вопроса

Возвращаемое значение

Тело: QuestionDto

Получение подробного раздела

Идентификатор операции:: getTopicIntro

Возвращает набор текста интро для заданного раздела.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор раздела	topicId	True	uuid	Идентификатор раздела

Возвращаемое значение

Тело: IntroDto

Получение пользователя

Идентификатор операции:: getUser

Возвращает метаданные пользователя и назначения ролей или отделов

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Id	id	True	uuid	Id

Возвращаемое значение

Тело: UserDto

Получение раздела

Идентификатор операции:: getTopic

Возвращает сведения о разделе для заданного идентификатора.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор раздела	topicId	True	uuid	Идентификатор раздела

Возвращаемое значение

Тело: TopicDto

Получение состояния создания ИИ для курса

Идентификатор операции:: getCourseGenerationStatus

Возвращает список активных запросов на создание ИИ для курса с информацией о ходе выполнения и целевой информации.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Id	id	True	uuid	Id

Возвращаемое значение

Тело: GenerationStatusResponse

Получение упражнения

Идентификатор операции:: getExercise

Возвращает сведения о упражнении для заданного идентификатора.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Id	id	True	uuid	Id

Возвращаемое значение

Тело: ExerciseDto

Получение урока

Идентификатор операции:: getLesson

Возвращает содержимое урока, мультимедиа и вопросы на уроке

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор урока	lessonId	True	uuid	Идентификатор урока

Возвращаемое значение

Тело: LessonDetailDto

Получение эксперта

Идентификатор операции:: getExpert

Возвращает метаданные эксперта, связанные документы и назначенные роли и отделы

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Id	id	True	uuid	Id

Возвращаемое значение

Тело: ExpertDetailDto

Получение элемента мультимедиа

Идентификатор операции:: getMediaItem

Возвращает метаданные мультимедиа и URL-адрес для скачивания со знаком с коротким сроком действия.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Id	id	True	uuid	Id

Возвращаемое значение

Тело: MediaDetailDto

Публикация курса

Идентификатор операции:: publishCourse

Публикует курс; завершается ошибкой 400, если у него нет публикуемого содержимого

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Id	id	True	uuid	Id

Возвращаемое значение

Тело: CourseDetailDto

Сведения о сертификате

Идентификатор операции:: getCertificate

Возвращает один сертификат, ограниченный компанией вызывающего абонента.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Id	id	True	uuid	Id

Возвращаемое значение

Тело: CertificateDto

Связывание документов с разделом

Идентификатор операции:: linkDocumentsToTopic

Аддитивные — уже связанные документы пропускаются

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор раздела	topicId	True	uuid	Идентификатор раздела
documentIds	documentIds	True	array of uuid

Скачивание PDF-файла сертификата

Идентификатор операции:: downloadCertificatePdf

Потоковая передача PDF-файла сертификата. Возвращает значение 404, если сертификат еще не имеет PDF-файла

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Id	id	True	uuid	Id

Возвращаемое значение

response: StreamingResponseBody

События активности для каждого учащегося

Идентификатор операции:: listStudentEvents

Поток событий с разбивкой на страницы только для пересылки

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор пользователя	userId	True	uuid	Идентификатор пользователя
Страница	page		integer	Страница
Size	size		integer	Size

Возвращаемое значение

Тело: EventListResponse

Создание демонстрационного обучения

Идентификатор операции:: createDemoTraining

Создает демонстрационное обучение из ранее отправленного видеофайла и запускает обработку

Параметры

Имя	Ключ	Обязательно	Тип
имя	name	True	string
description	description		string
trainingType	trainingType	True	string
videoFileId	videoFileId	True	uuid
departmentId	departmentId		uuid
processingPrompt	processingPrompt		string

Возвращаемое значение

Тело: DemoTrainingDto

Создание отдела

Идентификатор операции:: createDepartment

Создает новый отдел в компании вызывающего абонента.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
имя	name	True	string
description	description		string

Возвращаемое значение

Тело: DepartmentDto

Создание полного курса с содержимым ИИ

Идентификатор операции:: generateCourse

Создает оболочку курса, все модули, все разделы и создание содержимого ИИ для каждого раздела

Параметры

Имя	Ключ	Обязательно	Тип
имя	name	True	string
description	description		string
имя	name	True	string
description	description		string
имя	name	True	string
description	description		string

Возвращаемое значение

Тело: GenerateCourseResponse

Создание пользователя

Идентификатор операции:: createUser

Создает пользователя и активирует поток приглашения по магии

Параметры

Имя	Ключ	Обязательно	Тип
email	email	True	email
firstName	firstName		string
lastName	lastName		string
isAdmin	isAdmin		boolean
departmentRoleIds	departmentRoleIds		array of uuid

Возвращаемое значение

Тело: UserDto

Создание пустого курса

Идентификатор операции:: createCourse

Создает новую оболочку курса с заданным именем

Параметры

Имя	Ключ	Обязательно	Тип	Описание
имя	name	True	string

Возвращаемое значение

Тело: CourseDetailDto

Создание роли в отделе

Идентификатор операции:: createRoleInDepartment

Создает новую роль, ограниченную заданным отделом.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Id	id	True	uuid	Id
имя	name	True	string
ПолноеИмя	fullName		string
description	description		string

Возвращаемое значение

Тело: DepartmentDto

Список документов

Идентификатор операции:: listDocuments

Список документов с разбивкой на страницы в компании вызывающего абонента

Параметры

Имя	Ключ	Тип	Описание
Страница	page	integer	Страница
Size	size	integer	Size
Search	search	string	Search
Типы Mime	mimeTypes	string	Типы Mime
Status	status	string	Status

Возвращаемое значение

Тело: DocumentListResponse

Список пользователей

Идентификатор операции:: listUsers

Список пользователей с разбивкой на страницы в компании вызывающего абонента

Параметры

Имя	Ключ	Тип	Описание
Страница	page	integer	Страница
Size	size	integer	Size
Search	search	string	Search
Status	status	string	Status
Идентификаторы отдела	departmentIds	string	Идентификаторы отдела
Идентификаторы ролей	roleIds	string	Идентификаторы ролей
Kind	kind	string	Kind

Возвращаемое значение

Тело: UserListResponse

Список экспертов

Идентификатор операции:: listExperts

Список экспертов по разбивке на страницы в компании вызывающего абонента

Параметры

Имя	Ключ	Тип	Описание
Страница	page	integer	Страница
Size	size	integer	Size
Search	search	string	Search

Возвращаемое значение

Тело: ExpertListResponse

Удаление (деактивация) документа

Идентификатор операции:: deleteDocument

Идемпотент — возвращает 204, даже если документ уже удален или отсутствует

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Id	id	True	uuid	Id

Удаление (деактивация) отдела

Идентификатор операции:: deleteDepartment

Идемпотент — возвращает 204, даже если он уже деактивирован. Каскады для назначений ролей.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Id	id	True	uuid	Id

Удаление (деактивация) элемента мультимедиа

Идентификатор операции:: deleteMedia

Idempotent — возвращает значение 204, даже если элемент уже удален или отсутствует

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Id	id	True	uuid	Id

Удаление (обратимое) курса

Идентификатор операции:: deleteCourse

Идемпотент — возвращает 204, даже если курс уже удален

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Id	id	True	uuid	Id

Удаление байта обучения (обратимое)

Идентификатор операции:: deleteLearningByte

Идемпотент — 204, даже если он уже удален

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор lb	lbId	True	uuid	Идентификатор lb

Удаление вопроса на занятии

Идентификатор операции:: deleteLessonQuestion

Идемпотент — 204, даже если он уже удален

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор урока	lessonId	True	uuid	Идентификатор урока
Идентификатор вопроса	questionId	True	uuid	Идентификатор вопроса

Удаление всех назначений ролей из курса

Идентификатор операции:: removeAllRolesFromCourse

Идемпотентный

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Id	id	True	uuid	Id

Удаление всех назначений ролей от эксперта

Идентификатор операции:: removeAllRolesFromExpert

Идемпотентный

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Id	id	True	uuid	Id

Удаление встроенного модуля

Идентификатор операции:: removeModuleIntro

Идемпотент — 204, даже если ни в коем случае не задано

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор модуля	moduleId	True	uuid	Идентификатор модуля

Удаление демонстрационного обучения

Идентификатор операции:: deleteDemoTraining

Идемпотент — возвращает 204, даже если демонстрационная подготовка не существует или уже исчезла

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Id	id	True	uuid	Id

Удаление модуля (обратимое)

Идентификатор операции:: deleteModule

Idempotent — возвращает 204, даже если модуль уже удален.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор модуля	moduleId	True	uuid	Идентификатор модуля

Удаление одного вопроса теста в модуле

Идентификатор операции:: deleteModuleQuizQuestion

Идемпотент — 204, даже если он уже удален

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор модуля	moduleId	True	uuid	Идентификатор модуля
Идентификатор вопроса	questionId	True	uuid	Идентификатор вопроса

Удаление одного вопроса теста по теме

Идентификатор операции:: deleteTopicQuizQuestion

Идемпотент — 204, даже если он уже удален

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор раздела	topicId	True	uuid	Идентификатор раздела
Идентификатор вопроса	questionId	True	uuid	Идентификатор вопроса

Удаление одного назначения роли из курса

Идентификатор операции:: removeRoleFromCourse

Идемпотентный

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Id	id	True	uuid	Id
Идентификатор роли	roleId	True	uuid	Идентификатор роли

Удаление одного назначения роли от эксперта

Идентификатор операции:: removeRoleFromExpert

Идемпотентный

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Id	id	True	uuid	Id
Идентификатор роли	roleId	True	uuid	Идентификатор роли

Удаление раздела

Идентификатор операции:: removeTopicIntro

Идемпотент — 204, даже если ни в коем случае не задано

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор раздела	topicId	True	uuid	Идентификатор раздела

Удаление раздела (обратимое)

Идентификатор операции:: deleteTopic

Идемпотент — возвращает 204, даже если раздел уже удален

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор раздела	topicId	True	uuid	Идентификатор раздела

Удаление упражнения

Идентификатор операции:: deleteExercise

Идемпотент — 204, даже если он уже удален

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Id	id	True	uuid	Id

Удаление урока (обратимое)

Идентификатор операции:: deleteLesson

Идемпотент — 204, даже если он уже удален

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор урока	lessonId	True	uuid	Идентификатор урока

Установка или замена встроенного модуля

Идентификатор операции:: setModuleIntro

Upsert — создает, если отсутствует, заменяет при наличии

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор модуля	moduleId	True	uuid	Идентификатор модуля
Знакомство	introduction		string

Возвращаемое значение

Тело: IntroDto

Установка или замена раздела

Идентификатор операции:: setTopicIntro

Upsert — создает, если отсутствует, заменяет при наличии

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор раздела	topicId	True	uuid	Идентификатор раздела
Знакомство	introduction		string

Возвращаемое значение

Тело: IntroDto

Установка количества тестов модуля для одного типа вопроса

Идентификатор операции:: setModuleQuizSettings

Заменяет количество заданных вопросов (MULTIPLE_CHOICE или OPEN_ENDED). Число других типов сохраняется

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор модуля	moduleId	True	uuid	Идентификатор модуля
questionType	questionType	True	string
количество	count		integer

Возвращаемое значение

Тело: ModuleDetailDto

Установка счетчика вопросов для одного типа вопроса

Идентификатор операции:: setTopicQuizSettings

Заменяет количество заданных вопросов (MULTIPLE_CHOICE или OPEN_ENDED). Число других типов сохраняется

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор раздела	topicId	True	uuid	Идентификатор раздела
questionType	questionType	True	string
количество	count		integer

Возвращаемое значение

Тело: TopicDto

Определения

QuizSettingDto

Имя	Путь	Тип	Описание
questionType	questionType	string
количество	count	integer

TopicDto

Имя	Путь	Тип
id	id	uuid
moduleId	moduleId	uuid
имя	name	string
description	description	string
порядковый номер	ordinalNumber	integer
hasContent	hasContent	boolean
quizSettings	quizSettings	array of QuizSettingDto

IntroDto

Имя	Путь	Тип
id	id	uuid
Идентификатор компонента	componentId	uuid
componentType	componentType	string
Знакомство	introduction	string
source	source	string
createdAt	createdAt	date-time
обновлено в	updatedAt	date-time

ModuleDetailDto

Имя	Путь	Тип
id	id	uuid
courseId	courseId	uuid
имя	name	string
description	description	string
productId	productId	uuid
порядковый номер	ordinalNumber	integer
ЗаблокированнаяForGeneration	lockedForGeneration	boolean
quizSettings	quizSettings	array of QuizSettingDto
topics	topics	array of TopicDto

MediaDetailDto

Имя	Путь	Тип
id	id	uuid
имя	name	string
description	description	string
kind	kind	string
тип MIME	mimeType	string
sizeBytes	sizeBytes	integer
статус	status	string
processingStatus	processingStatus	string
createdAt	createdAt	date-time
uploadedBy	uploadedBy	UploadedByDto
скачатьUrl	downloadUrl	string

UploadedByDto

Имя	Путь	Тип
id	id	uuid
kind	kind	string
имя	name	string

DocumentDetailDto

Имя	Путь	Тип
id	id	uuid
имя	name	string
description	description	string
тип MIME	mimeType	string
sizeBytes	sizeBytes	integer
статус	status	string
createdAt	createdAt	date-time
uploadedBy	uploadedBy	UploadedByDto
скачатьUrl	downloadUrl	string

DepartmentRoleDto

Имя	Путь	Тип
departmentId	departmentId	uuid
название отдела	departmentName	string
roleId	roleId	uuid
roleName	roleName	string

UserDto

Имя	Путь	Тип
id	id	uuid
email	email	string
firstName	firstName	string
lastName	lastName	string
статус	status	string
kind	kind	string
isAdmin	isAdmin	boolean
createdAt	createdAt	date-time
departmentRoles	departmentRoles	array of DepartmentRoleDto

ВопросDto

Имя	Путь	Тип
id	id	uuid
type	type	string
parentId	parentId	uuid
parentType	parentType	string
text	text	string
порядковый номер	ordinalNumber	integer
source	source	string
expectedAnswer	expectedAnswer	string
options	options	array of QuestionOptionDto
createdAt	createdAt	date-time
обновлено в	updatedAt	date-time

ВопросOptionDto

Имя	Путь	Тип
text	text	string
isCorrect	isCorrect	boolean
порядковый номер	ordinalNumber	integer

ВопросListResponse

Имя	Путь	Тип	Описание
items	items	array of QuestionDto

LearningByteDetailDto

Имя	Путь	Тип
id	id	uuid
topicId	topicId	uuid
имя	name	string
description	description	string
порядковый номер	ordinalNumber	integer
source	source	string
createdAt	createdAt	date-time
обновлено в	updatedAt	date-time
уроки	lessons	array of LessonDto

ЗанятиеDto

Имя	Путь	Тип
id	id	uuid
learningByteId	learningByteId	uuid
содержимое	content	string
порядковый номер	ordinalNumber	integer
source	source	string
вопросCount	questionCount	integer
MediaCount	mediaCount	integer
createdAt	createdAt	date-time
обновлено в	updatedAt	date-time

УпражнениеDto

Имя	Путь	Тип
id	id	uuid
topicId	topicId	uuid
type	type	string
prompt	prompt	string
порядковый номер	ordinalNumber	integer
source	source	string
isGenerated	isGenerated	boolean
avatarPictureId	avatarPictureId	uuid
аватарCharacteristics	avatarCharacteristics	string
reverseRolePlayEnabled	reverseRolePlayEnabled	boolean
reverseRolePlayMandatory	reverseRolePlayMandatory	boolean
generatedContent	generatedContent	ExerciseGeneratedContentDto
createdAt	createdAt	date-time
обновлено в	updatedAt	date-time

УпражнениеGeneratedContentDto

Имя	Путь	Тип
id	id	uuid
regenerationId	regenerationId	uuid
сценарий	scenario	string
traineeRole	traineeRole	string
аватарName	avatarName	string
аватарDescription	avatarDescription	string
operationsChallenge	operationalChallenge	string
successMetric	successMetric	string
инструкция	instruction	string
инструкцияReverse	instructionReverse	string
exerciseKnowledgeBase	exerciseKnowledgeBase	string
topicKnowledgeBase	topicKnowledgeBase	string

TopicListResponse

Имя	Путь	Тип	Описание
items	items	array of TopicDto

ЗанятиеDetailDto

Имя	Путь	Тип
id	id	uuid
learningByteId	learningByteId	uuid
содержимое	content	string
порядковый номер	ordinalNumber	integer
source	source	string
createdAt	createdAt	date-time
обновлено в	updatedAt	date-time
мультимедиа	media	array of MediaLinkDto
Вопросы	questions	array of QuestionDto

MediaLinkDto

Имя	Путь	Тип
id	id	uuid
fileId	fileId	uuid
порядковый номер	ordinalNumber	integer
source	source	string

ExpertDetailDto

Имя	Путь	Тип
id	id	uuid
имя	name	string
description	description	string
статус	status	string
linkedDocumentCount	linkedDocumentCount	integer
createdAt	createdAt	date-time
обновлено в	updatedAt	date-time
assignedRoleIds	assignedRoleIds	array of uuid
assignedDepartmentIds	assignedDepartmentIds	array of uuid
linkedDocuments	linkedDocuments	array of LinkedDocumentDto

LinkedDocumentDto

Имя	Путь	Тип
id	id	uuid
имя	name	string
Расширение	extension	string
sizeBytes	sizeBytes	integer
description	description	string
linkedAt	linkedAt	date-time

AskResponse

Имя	Путь	Тип	Описание
ответ	answer	string
durationMs	durationMs	integer

DepartmentDto

Имя	Путь	Тип
id	id	uuid
имя	name	string
description	description	string
статус	status	string
createdAt	createdAt	date-time
roles	roles	array of DepartmentRoleDto

DemoTrainingDto

Имя	Путь	Тип
id	id	uuid
companyId	companyId	uuid
departmentId	departmentId	uuid
имя	name	string
description	description	string
trainingType	trainingType	string
статус	status	string
доступен	isAvailable	boolean
videoFileId	videoFileId	uuid
processingPrompt	processingPrompt	string
errorMessage	errorMessage	string
assignedRoleIds	assignedRoleIds	array of uuid
Сегментов	segments	array of DemoTrainingSegmentDto
createdAt	createdAt	date-time
обновлено в	updatedAt	date-time

DemoTrainingSegmentDto

Имя	Путь	Тип
id	id	uuid
порядковый номер	ordinalNumber	integer
имя	name	string
Стенограмма	transcript	string
durationSeconds	durationSeconds	integer

CourseDetailDto

Имя	Путь	Тип
id	id	uuid
имя	name	string
статус	status	string
moduleCount	moduleCount	integer
topicCount	topicCount	integer
hasUnpublishedChanges	hasUnpublishedChanges	boolean
currentVersionNumber	currentVersionNumber	integer
createdAt	createdAt	date-time
обновлено в	updatedAt	date-time
assignedRoleIds	assignedRoleIds	array of uuid
assignedDepartmentIds	assignedDepartmentIds	array of uuid
modules	modules	array of ModuleSummaryDto

ModuleSummaryDto

Имя	Путь	Тип
id	id	uuid
имя	name	string
порядковый номер	ordinalNumber	integer
topicCount	topicCount	integer

GenerationRequestResponse

Имя	Путь	Тип	Описание
id	id	uuid
статус	status	string

ModuleDto

Имя	Путь	Тип
id	id	uuid
courseId	courseId	uuid
имя	name	string
description	description	string
productId	productId	uuid
порядковый номер	ordinalNumber	integer
ЗаблокированнаяForGeneration	lockedForGeneration	boolean
topicCount	topicCount	integer
quizSettings	quizSettings	array of QuizSettingDto

ModuleListResponse

Имя	Путь	Тип	Описание
items	items	array of ModuleDto

GenerateCourseResponse

Имя	Путь	Тип	Описание
courseId	courseId	uuid
generationRequestId	generationRequestId	uuid

PageInfo

Имя	Путь	Тип
size	size	integer
Номер	number	integer
totalElements	totalElements	integer
общее количество страниц	totalPages	integer

UserListResponse

Имя	Путь	Тип	Описание
items	items	array of UserDto
страница	page	PageInfo

TopicLinkedDocumentDto

Имя	Путь	Тип
id	id	uuid
имя	name	string
Расширение	extension	string
size	size	integer
processingStatus	processingStatus	string
description	description	string
source	source	string
linkType	linkType	string
linkedAt	linkedAt	date-time

TopicLinkedDocumentListResponse

Имя	Путь	Тип	Описание
items	items	array of TopicLinkedDocumentDto
страница	page	PageInfo

LearningByteDto

Имя	Путь	Тип
id	id	uuid
topicId	topicId	uuid
имя	name	string
description	description	string
порядковый номер	ordinalNumber	integer
source	source	string
lessonCount	lessonCount	integer
createdAt	createdAt	date-time
обновлено в	updatedAt	date-time

LearningByteListResponse

Имя	Путь	Тип	Описание
items	items	array of LearningByteDto

ExerciseListResponse

Имя	Путь	Тип	Описание
items	items	array of ExerciseDto

CertificateDto

Имя	Путь	Тип
id	id	uuid
enrollmentId	enrollmentId	uuid
studentId	studentId	uuid
companyId	companyId	uuid
courseId	courseId	uuid
courseVersionId	courseVersionId	uuid
studentName	studentName	string
companyName	companyName	string
courseName	courseName	string
serialNumber	serialNumber	string
completedAt	completedAt	date-time
выдан в	issuedAt	date-time
pdfFileId	pdfFileId	uuid
pdfAvailable	pdfAvailable	boolean

CertificateListResponse

Имя	Путь	Тип	Описание
items	items	array of CertificateDto

MediaDto

Имя	Путь	Тип
id	id	uuid
имя	name	string
description	description	string
kind	kind	string
тип MIME	mimeType	string
sizeBytes	sizeBytes	integer
статус	status	string
processingStatus	processingStatus	string
createdAt	createdAt	date-time
uploadedBy	uploadedBy	UploadedByDto

MediaListResponse

Имя	Путь	Тип	Описание
items	items	array of MediaDto
страница	page	PageInfo

LessonListResponse

Имя	Путь	Тип	Описание
items	items	array of LessonDto

CourseBreakdownDto

Имя	Путь	Тип
courseId	courseId	uuid
courseName	courseName	string
progressPercent	progressPercent	integer
hoursSpent	hoursSpent	double
startedAt	startedAt	date-time
completedAt	completedAt	date-time

StudentInsightsDto

Имя	Путь	Тип
userId	userId	uuid
окно	window	WindowDto
summary	summary	StudentSummaryDto
ByCourse	byCourse	array of CourseBreakdownDto

StudentSummaryDto

Имя	Путь	Тип
activeDays	activeDays	integer
уроков	lessonsCompleted	integer
упражненийCompleted	exercisesCompleted	integer
quizzesPassed	quizzesPassed	integer
hoursSpent	hoursSpent	double

WindowDto

Имя	Путь	Тип
kind	kind	string
от	from	date-time
до	to	date-time

EventItemDto

Имя	Путь	Тип
id	id	uuid
kind	kind	string
action	action	string
courseId	courseId	uuid
courseName	courseName	string
произошло	occurredAt	date-time

EventListResponse

Имя	Путь	Тип	Описание
items	items	array of EventItemDto
страница	page	PageInfo

CompanyInsightsDto

Имя	Путь	Тип	Описание
companyId	companyId	uuid
summary	summary	CompanySummaryDto

CompanySummaryDto

Имя	Путь	Тип
totalStudents	totalStudents	integer
averageProgressPercent	averageProgressPercent	integer
activeThisWeekCount	activeThisWeekCount	integer
completedCount	completedCount	integer
completionRatePercent	completionRatePercent	integer

ExpertDto

Имя	Путь	Тип
id	id	uuid
имя	name	string
description	description	string
статус	status	string
linkedDocumentCount	linkedDocumentCount	integer
createdAt	createdAt	date-time
обновлено в	updatedAt	date-time

ExpertListResponse

Имя	Путь	Тип	Описание
items	items	array of ExpertDto
страница	page	PageInfo

DocumentDto

Имя	Путь	Тип
id	id	uuid
имя	name	string
description	description	string
тип MIME	mimeType	string
sizeBytes	sizeBytes	integer
статус	status	string
createdAt	createdAt	date-time
uploadedBy	uploadedBy	UploadedByDto

DocumentListResponse

Имя	Путь	Тип	Описание
items	items	array of DocumentDto
страница	page	PageInfo

DepartmentListResponse

Имя	Путь	Тип	Описание
items	items	array of DepartmentDto

DemoTrainingListItemDto

Имя	Путь	Тип
id	id	uuid
departmentId	departmentId	uuid
videoFileId	videoFileId	uuid
имя	name	string
description	description	string
trainingType	trainingType	string
статус	status	string
доступен	isAvailable	boolean
assignedRoleIds	assignedRoleIds	array of uuid
segmentCount	segmentCount	integer
durationSeconds	durationSeconds	integer
createdAt	createdAt	date-time

DemoTrainingListResponse

Имя	Путь	Тип	Описание
items	items	array of DemoTrainingListItemDto
страница	page	PageInfo

CourseDto

Имя	Путь	Тип
id	id	uuid
имя	name	string
статус	status	string
moduleCount	moduleCount	integer
topicCount	topicCount	integer
hasUnpublishedChanges	hasUnpublishedChanges	boolean
currentVersionNumber	currentVersionNumber	integer
latestPublishedAt	latestPublishedAt	date-time
createdAt	createdAt	date-time

CourseListResponse

Имя	Путь	Тип	Описание
items	items	array of CourseDto
страница	page	PageInfo

GenerationProgressDto

Имя	Путь	Тип
totalTasks	totalTasks	integer
completedTasks	completedTasks	integer
failedTasks	failedTasks	integer

GenerationRequestInfoDto

Имя	Путь	Тип
id	id	uuid
статус	status	string
createdAt	createdAt	string
completedAt	completedAt	string
error	error	string
progress	progress	GenerationProgressDto
target	target	string
targetId	targetId	uuid
parentType	parentType	string
topicIds	topicIds	array of uuid
moduleIds	moduleIds	array of uuid

GenerationStatusResponse

Имя	Путь	Тип	Описание
activeRequests	activeRequests	array of GenerationRequestInfoDto

CourseVersionDto

Имя	Путь	Тип
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
вопросCount	questionCount	integer
estimatedTimeSeconds	estimatedTimeSeconds	integer

CourseVersionListResponse

Имя	Путь	Тип	Описание
items	items	array of CourseVersionDto

AuditSnapshot

Имя	Путь	Тип
createdAt	createdAt	date-time
создано кем	createdBy	uuid
обновлено в	updatedAt	date-time
обновленоBy	updatedBy	uuid

CourseSnapshot

Имя	Путь	Тип
имя	name	string
coverImageId	coverImageId	uuid
предварительный код ресурса	prerequisiteCourseId	uuid
courseGuideline	courseGuideline	string
lessonsGuideline	lessonsGuideline	string
questionsGuideline	questionsGuideline	string
упражненияGuideline	exercisesGuideline	string
modules	modules	array of ModuleSnapshot

CourseVersionSnapshotDto

Имя	Путь	Тип
id	id	uuid
courseId	courseId	uuid
versionNumber	versionNumber	integer
snapshot	snapshot	CourseSnapshot

УпражнениеSnapshot

Имя	Путь	Тип
id	id	uuid
topicId	topicId	uuid
exerciseType	exerciseType	string
prompt	prompt	string
порядковый номер	ordinalNumber	integer
isGenerated	isGenerated	boolean
source	source	string
audit	audit	AuditSnapshot
аватарCharacteristics	avatarCharacteristics	string
avatarPictureId	avatarPictureId	uuid
reverseRolePlayEnabled	reverseRolePlayEnabled	boolean
reverseRolePlayMandatory	reverseRolePlayMandatory	boolean
сценарий	scenario	string
traineeRole	traineeRole	string
аватарName	avatarName	string
аватарDescription	avatarDescription	string
operationsChallenge	operationalChallenge	string
successMetric	successMetric	string
инструкция	instruction	string
инструкцияReverse	instructionReverse	string
exerciseKnowledgeBase	exerciseKnowledgeBase	string

LearningByteSnapshot

Имя	Путь	Тип
id	id	uuid
topicId	topicId	uuid
имя	name	string
description	description	string
порядковый номер	ordinalNumber	integer
source	source	string
audit	audit	AuditSnapshot
уроки	lessons	array of LessonSnapshot

ЗанятиеSnapshot

Имя	Путь	Тип
id	id	uuid
learningByteId	learningByteId	uuid
содержимое	content	string
порядковый номер	ordinalNumber	integer
source	source	string
audit	audit	AuditSnapshot
мультимедиа	media	array of MediaSnapshot
Вопросы	questions	array of QuestionSnapshot

LinkedDocumentSnapshot

Имя	Путь	Тип
id	id	uuid
fileId	fileId	uuid
linkType	linkType	string
isSupplement	isSupplement	boolean
имя	name	string
Расширение	extension	string
size	size	integer
description	description	string

MediaSnapshot

Имя	Путь	Тип
id	id	uuid
fileId	fileId	uuid
порядковый номер	ordinalNumber	integer
mediaType	mediaType	string
source	source	string

ModuleSnapshot

Имя	Путь	Тип
id	id	uuid
courseId	courseId	uuid
productId	productId	uuid
имя	name	string
description	description	string
Введение	intro	string
порядковый номер	ordinalNumber	integer
quizSettings	quizSettings	array of QuizSettingSnapshot
quizQuestions	quizQuestions	array of QuestionSnapshot
topics	topics	array of TopicSnapshot

OptionSnapshot

Имя	Путь	Тип
id	id	uuid
optionText	optionText	string
isCorrect	isCorrect	boolean
порядковый номер	ordinalNumber	integer

ВопросSnapshot

Имя	Путь	Тип
id	id	uuid
questionType	questionType	string
questionText	questionText	string
expectedAnswer	expectedAnswer	string
порядковый номер	ordinalNumber	integer
source	source	string
audit	audit	AuditSnapshot
options	options	array of OptionSnapshot

QuizSettingSnapshot

Имя	Путь	Тип	Описание
questionType	questionType	string
количество	count	integer

TopicSnapshot

Имя	Путь	Тип
id	id	uuid
moduleId	moduleId	uuid
имя	name	string
description	description	string
Введение	intro	string
порядковый номер	ordinalNumber	integer
quizSettings	quizSettings	array of QuizSettingSnapshot
quizQuestions	quizQuestions	array of QuestionSnapshot
learningBytes	learningBytes	array of LearningByteSnapshot
упражнения	exercises	array of ExerciseSnapshot
linkedDocuments	linkedDocuments	array of LinkedDocumentSnapshot
topicKnowledgeBase	topicKnowledgeBase	string

StreamingResponseBody