タイム マシン (プレビュー)
Time Machine は、AI を活用した企業学習プラットフォームです。 会社のドキュメント、ビデオ、専門知識を、モジュール、トピック、クイズ、ロールプレイ演習を含む構造化されたコースに変換し、学習者の進捗状況を追跡します。 大規模な従業員のオンボード、トレーニング、認定を行う人事および L&D チーム向けに構築されています。 このコネクタは、コース、ユーザー、部門、ロールの管理という完全な学習ライフサイクルを自動化します。ドキュメントからクイズを生成する。と読み取り完了分析。
このコネクタは、次の製品とリージョンで使用できます。
| Service | クラス | リージョン |
|---|---|---|
| コピロット スタジオ | Premium | 次を除くすべてのPower Automateリージョン: - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| ロジック アプリ | Standard | 次を除くすべての Logic Apps リージョン : - Azure Government リージョン - 中国リージョンAzure - 米国国防総省 (DoD) |
| Power Apps | Premium | 次を除くすべてのPower Appsリージョン: - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| Power Automate(パワーオートメート) | Premium | 次を除くすべてのPower Automateリージョン: - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| Contact | |
|---|---|
| 名前 | タイム マシンのサポート |
| URL | https://timeml.ai |
| コネクタ メタデータ | |
|---|---|
| 発行者 | Time Machine AI |
| ウェブサイト | https://timeml.ai |
| プライバシー ポリシー | https://timeml.ai/privacy-policy |
| カテゴリ | 生産性;AI |
タイム マシン - Power Automate コネクタ
タイム マシンとは
Time Machine は、AI を利用した組織学習プラットフォームであり、企業が最新のチーム向けの適応型学習システムを構築、運用、継続的に改善するのに役立ちます。 組織は Time Machine を使用して、既存の知識、ドキュメント、記録、ワークフローを、オンボーディングを高速化し、従業員の準備を改善し、組織全体でトップパフォーマーの専門知識をレプリケートするスケーラブルなトレーニング エクスペリエンスに変換します。
テナント管理者は、Time Machine REST API を使用して、ユーザー、学習コンテンツ、組織のリソース、プラットフォームの構成を管理します。 このコネクタは、パブリック REST API をPower Automateアクションとして公開します。これにより、コードを記述することなく、ユーザー プロビジョニング、コンテンツ インジェスト、ナレッジ同期、ライフサイクル管理を自動化できます。
前提条件
- 管理者アクセス権を持つアクティブなタイム マシン テナント
- 管理パネル (
https://web.timeml.ai) の [設定] → API キーから発行された Time Machine API キー。 キーは、tm_live_で始まる値です。
Authentication
すべてのアクションは、 Authorization ヘッダーの API キーを使用して認証されます。 Power Automateで接続を作成する場合:
-
フィールド:
API key -
値:
Bearer tm_live_<your-token>貼り付けます (Bearerプレフィックスとトークンの前のスペースを含む完全な文字列)
使用可能なアクション
このコネクタは、Time Machine パブリック REST API (116 エンドポイント) をミラー化します。 アクションはリソースごとにグループ化されます。
- コース — コースの 一覧表示/作成/更新/削除/公開、ロールの割り当て、AI で作成されたコンテンツの生成
- ユーザー - ユーザーの一覧表示/作成/更新/非アクティブ化/再アクティブ化
- ドキュメント — ドキュメント の一覧/アップロード/更新/削除
- メディア — メディアアイテムのリスト/アップロード/更新/削除
- 部署 — 部署 の一覧表示/作成/更新/削除、ロールの管理、ロールへのユーザーの割り当て
- エキスパート — エキスパート プロファイルの一覧表示/作成、エキスパートの質問、ドキュメントとロールの割り当て
- デモ トレーニング — デモ トレーニングの一覧/作成/更新/削除
- コースコンテンツ — モジュール、トピック、レッスン、演習、クイズの質問
- 分析情報 — 学生ごと、コースごと、会社レベルの分析
- 証明書 — 学生証明書の一覧表示、証明書 PDF のダウンロード
完全なエンドポイント参照は、 https://api.timeml.ai/api/v1/docsで使用できます。
ワークフローの例
- Confluence release → Time Machine: Confluence でリリース ページが発行されたら、それをタイム マシンのドキュメントとしてアップロードして、学習バイト ライブラリに流れます。
- 人事オンボード: HRIS に新しい従業員の行が表示されたら、部署とロールの割り当てを持つタイム マシン ユーザーを作成し、マジック リンクの招待をトリガーします。
- コース完了通知: 学生がコースを完了したら、証明書 PDF を Slack に送信し、完了を Google シートに記録します。
既知の制限
- API キーのローテーション: API キーがローテーションされるときに、接続を手動で更新する必要があります。 自動更新メカニズムはありません。
- マルチパートアップロード:ファイルアップロードアクション(ドキュメントのアップロード、メディアのアップロード)は、最大50 MBのファイルを受け入れます。 より大きなメディアの場合は、複数のアップロードに分割するか、Time Machine サポートにお問い合わせください。
- バッチ操作: API は一度に 1 つのレコードに対して動作します。 一括アクションの場合は、Power Automateの組み込みの apply-to-each コントロールを使用します。
Support
コネクタに関する質問や問題については、Time Machine アカウント チームまたはメール サポート ( support@timeml.ai) にお問い合わせください。
接続を作成する
コネクタでは、次の認証の種類がサポートされています。
| デフォルト | 接続を作成するためのパラメーター。 | すべてのリージョン | 共有できません |
デフォルト
適用対象: すべてのリージョン
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 電源アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 名前 | タイプ | Description | Required |
|---|---|---|---|
| Time Machine API キー (形式: Bearer tm_live_...) | securestring | この API の Time Machine API キー (形式: Bearer tm_live_...) | True |
アクション
| 1 つの質問の種類にトピック クイズ数を設定する |
指定した questionType (MULTIPLE_CHOICE または OPEN_ENDED) の数を置き換えます。 その他の型の数は保持されます |
| 1 つの質問の種類に対してモジュール クイズ数を設定する |
指定した questionType (MULTIPLE_CHOICE または OPEN_ENDED) の数を置き換えます。 その他の型の数は保持されます |
| AI を使用して特定の項目を再生成する |
1 つのレッスン、レッスンの質問、クイズ、イントロ、または演習を再生成します |
| AI コンテンツを使用して完全なコースを生成する |
コース シェル、すべてのモジュール、すべてのトピックを作成し、すべてのトピックの AI コンテンツ生成をエンキューします |
| RPE_VIDEO演習をトピックに追加する |
指定したトピック内に新しいRPE_VIDEOロールプレイ 演習を作成します。 |
| エキスパートから 1 つのロールの割り当てを削除する |
冪等性 |
| エキスパートからすべてのロールの割り当てを削除する |
冪等性 |
| エキスパートからドキュメントの割り当てを解除する |
冪等性 |
| エキスパートにドキュメントを割り当てる |
エキスパートにドキュメントを一括リンクします。 べき等。 |
| エキスパートにロールを割り当てる |
加法 — 既に割り当てられているロールが保持されます。新しいものが追加されました。 更新されたエキスパートを返します |
| エキスパートを一覧表示する |
呼び出し元の会社の専門家のページ分割された一覧 |
| エキスパートを取得する |
エキスパート メタデータ、リンクされたドキュメント、割り当てられたロール/部門を返します |
| クイズの質問をトピックに追加する |
指定されたトピック内に新しいクイズの質問を作成します。 |
| コース バージョンのスナップショットを取得する |
特定のバージョンの完全なコンテンツ ツリー (モジュール、トピック、レッスン、演習、質問) を返します |
| コースから 1 つのロールの割り当てを削除する |
冪等性 |
| コースからすべてのロールの割り当てを削除する |
冪等性 |
| コースにモジュールを追加する |
指定されたコース内に新しいモジュールを作成します。 |
| コースにロールを割り当てる |
加法 - 既に割り当てられているロールはスキップされます。 更新されたコースの詳細を返します |
| コースの AI 生成状態を取得する |
進行状況とターゲット情報を含むコースのアクティブな AI 生成要求の一覧を返します |
| コースのバージョンを一覧表示する |
バージョン番号で並べ替えられた発行済みバージョン メタデータ (カウント + 発行情報) を返します |
| コースのモジュールを一覧表示する |
ordinalNumber で並べ替えられたアクティブなモジュールを返します。 |
| コースを一覧表示する |
呼び出し元の会社のコースのページ分割されたリスト |
| コースを公開する |
コースを公開します。発行可能なコンテンツがない場合、400 で失敗する |
| コースを削除 (ソフト) する |
べき等 - コースが既に削除されている場合でも 204 を返します |
| コースを取得する |
モジュールの概要と割り当てられたロール/部門を含むコース メタデータを返します |
| コースメタデータを更新する |
コース名を更新する |
| コース内のモジュールを並べ替える |
moduleId には、すべてのアクティブなモジュールを新しい順序で 1 回だけ含める必要があります |
| テストの質問をモジュールに追加する |
指定されたモジュール内に新しいクイズの質問を作成します。 |
| デモ トレーニングを一覧表示する |
呼び出し元の会社を対象とするページ分割されたリスト |
| デモ トレーニングを作成する |
以前にアップロードしたビデオ ファイルからデモ トレーニングを作成し、処理を開始します |
| デモ トレーニングを削除する |
べき等 - デモ トレーニングが存在しないか、既になくなった場合でも 204 を返します |
| デモ トレーニングを受ける |
セグメントを含む完全なデモ トレーニングを返します |
| デモ トレーニングを更新する |
部分的な更新。 変更するフィールドのみを渡します。 assignedRoleIds は現在のセットを置き換えます。 |
| トピックから 1 つのドキュメントのリンクを解除する |
冪等性 |
| トピックにILE_TEXT演習を追加する |
指定したトピック内に新しいILE_TEXT演習を作成します。 |
| トピックにRPE_VOICE演習を追加する |
特定のトピック内に新しいRPE_VOICEロールプレイ 演習を作成します。 |
| トピックにリンクされているドキュメントを一覧表示する |
ページ分割済み。ドキュメント名による省略可能な検索 |
| トピックに関する 1 つのクイズの質問を更新する |
格納されている型に一致するフィールドを指定します。関連のないフィールドは無視されます。 |
| トピックに関するクイズの質問を 1 つ削除する |
べき等 - 既に削除されている場合でも 204 |
| トピックに関するクイズの質問を 1 つ取得する |
特定のトピックに添付された 1 つのクイズの質問を返します。 |
| トピックに関するクイズの質問を一覧表示する |
特定のトピックに添付されているクイズの質問を返します。 |
| トピックに関するクイズの質問を並べ替える |
questionId には、トピックのすべてのアクティブなクイズの質問を新しい順序で含める必要があります。 |
| トピックの AI コンテンツ生成をトリガーする |
コース内の指定されたトピックの AI コンテンツ生成をエンキューする |
| トピックのメタデータを更新する |
名前や説明を更新します。 省略されたフィールドは現在の値を保持します |
| トピックの学習バイト数を一覧表示する |
指定されたトピックに属する学習バイトを返します。 |
| トピックの概要を削除する |
べき等 - イントロが設定されていない場合でも 204 |
| トピックの概要を取得する |
指定されたトピックの概要テキスト セットを返します。 |
| トピックの概要を設定または置換する |
Upsert — 不足している場合は作成され、存在する場合は置き換えられます |
| トピックの演習を一覧表示する |
ordinalNumber で並べ替えられた混合型 (ILE_TEXT/RPE_VOICE/RPE_VIDEO) |
| トピックを別のモジュールに移動する |
targetOrdinalNumber は省略可能です。省略した場合、トピックはターゲット モジュールに追加されます |
| トピックを削除する (ソフト) |
べき等 - トピックが既に削除されている場合でも 204 を返します |
| トピックを取得する |
指定された ID のトピックの詳細を返します。 |
| ドキュメント メタデータを更新する |
更新プログラムの名前または説明 |
| ドキュメントのアップロード |
マルチパート アップロード (ファイルと省略可能な説明)。 最大 50 MB。 |
| ドキュメントをトピックにリンクする |
加法 - 既にリンクされているドキュメントはスキップされます |
| ドキュメントを一覧表示する |
呼び出し元の会社のドキュメントのページ分割された一覧 |
| ドキュメントを削除 (非アクティブ化) する |
べき等 - ドキュメントが既に削除または欠落している場合でも 204 を返します。 |
| ドキュメントを取得する |
ドキュメント メタデータと有効期間の短い署名付きダウンロード URL を返します。 |
| ドキュメントバイナリを置き換える |
既存のドキュメントのファイル バイナリを置き換えます。メタデータは保持されます |
| ビデオ処理を再実行する |
AI セグメント化のビデオを再送信します。 必要に応じて、処理プロンプトをオーバーライドします。 |
| メディア アイテムを削除 (非アクティブ化) する |
べき等 - 項目が既に削除または不足している場合でも 204 を返します。 |
| メディア バイナリを置き換える |
既存のメディア項目のファイル バイナリを置き換えます。メタデータは保持されます |
| メディア メタデータを更新する |
更新プログラムの名前または説明 |
| メディアを一覧表示する |
呼び出し元の会社のメディア項目のページ分割されたリスト |
| メディアアイテムをアップロードする |
マルチパート アップロード (ファイルと省略可能な説明)。 画像の場合は最大 50 MB、ビデオの場合は 500 MB。 |
| メディア項目を取得する |
メディア メタデータと有効期間の短い署名付きダウンロード URL を返します |
| モジュールで 1 つのクイズの質問を更新する |
格納されている型に一致するフィールドを指定します。関連のないフィールドは無視されます。 |
| モジュールにトピックを追加する |
指定されたモジュール内に新しいトピックを作成します。 |
| モジュールに関するクイズの質問を 1 つ取得する |
特定のモジュールにアタッチされた 1 つのクイズの質問を返します。 |
| モジュールのイントロを削除する |
べき等 - イントロが設定されていない場合でも 204 |
| モジュールのクイズの質問を 1 つ削除する |
べき等 - 既に削除されている場合でも 204 |
| モジュールのクイズの質問を一覧表示する |
指定されたモジュールにアタッチされているクイズの質問を返します。 |
| モジュールのクイズの質問を並べ替える |
questionId には、モジュールのすべてのアクティブなクイズの質問を新しい順序で含める必要があります。 |
| モジュールのメタデータを更新する |
名前や説明を更新します。 省略されたフィールドは現在の値を保持します |
| モジュールの概要を取得する |
指定されたモジュールの開始テキスト セットを返します。 |
| モジュールの概要を設定または置き換える |
Upsert — 不足している場合は作成され、存在する場合は置き換えられます |
| モジュールを削除する (ソフト) |
べき等 — モジュールが既に削除されている場合でも 204 を返します |
| モジュールを取得する |
指定された ID のモジュールの詳細を返します。 |
| モジュール内のトピックを一覧表示する |
ordinalNumber で並べ替えられたアクティブなトピックを返します。 |
| モジュール内のトピックを並べ替える |
topicIds には、すべてのアクティブなトピックを新しい順序で 1 回だけ含める必要があります |
| ユーザーの作成 |
ユーザーを作成し、マジック リンク招待フローをトリガーします |
| ユーザーの取得 |
ユーザー メタデータと部門/ロールの割り当てを返します |
| ユーザーをロールに割り当てる |
冪等性 |
| ユーザーを一覧表示する |
呼び出し元の会社のユーザーのページ分割された一覧 |
| ユーザーを再アクティブ化する |
べき等 - 既にアクティブな場合でもユーザーを返します |
| ユーザーを更新する |
firstName、lastName、isAdmin、ロールの割り当てを更新します。 v1 では電子メールは編集できません。 |
| ユーザーを非アクティブ化する |
べき等 - 既に非アクティブ化されている場合でもユーザーを返します |
| レッスンの内容を更新する |
省略されたコンテンツは現在の値を保持します |
| レッスンを削除する (ソフト) |
べき等 - 既に削除されている場合でも 204 |
| レッスンを受ける |
レッスンの内容、メディア、およびレッスン内の質問を返します |
| レッスン内の質問を 1 つ取得する |
1 つのレッスン内の質問を ID で返します。 |
| レッスン内の質問を一覧表示する |
指定されたレッスンに添付されたナレッジ チェックの質問を返します。 |
| レッスン内の質問を並べ替える |
questionId には、レッスンのすべてのアクティブな質問を新しい順序で含める必要があります |
| レッスン内の質問を削除する |
べき等 - 既に削除されている場合でも 204 |
| レッスン内の質問を更新する |
格納されている型に一致するフィールドを指定します。関連付けられていないフィールドは無視されます |
| レッスン内の質問を追加する |
型はMULTIPLE_CHOICE (オプションが必要) またはOPEN_ENDEDする必要があります |
| ロールからユーザーの割り当てを解除する |
べき等 - 割り当てられなかった場合でも 204 |
| 会社レベルの分析情報 |
発信者の会社のトップライン KPI |
| 学生ごとのアクティビティ イベント |
ページ分割された前方専用イベント ストリーム |
| 学生ごとの分析情報 |
特定のウィンドウの集計された概要とコースごとの内訳 |
| 学生の空き時間を切り替える |
デモ トレーニングを学生に公開するかどうかを設定します。 べき等。 |
| 学生の証明書を一覧表示する |
呼び出し元の会社内の特定の学生が獲得した証明書を返します。 |
| 学習バイト メタデータを更新する |
省略されたフィールドは現在の値を保持します |
| 学習バイトでレッスンを一覧表示する |
指定された学習バイトに属するレッスンを返します。 |
| 学習バイトにレッスンを追加する |
指定された学習バイト内に新しいレッスンを作成します。 |
| 学習バイトをトピックに追加する |
指定されたトピック内に新しい学習バイトを作成します。 |
| 学習バイトを削除する (ソフト) |
べき等 - 既に削除されている場合でも 204 |
| 学習バイトを取得する |
メタデータと入れ子になったレッスンを返します |
| 専門家に質問する |
ストリーミング AI チャットの同期ラッパー。 アセンブリされた回答を返します。 |
| 演習を削除する |
べき等 - 既に削除されている場合でも 204 |
| 演習を取得する |
指定された ID の演習の詳細を返します。 |
| 演習を更新する |
型対応: ILE_TEXTはプロンプト + generatedContent.scenario のみを使用します。RPE_* では、すべての RPE フィールドが使用されます。 省略されたフィールドは、現在の値を保持します。 |
| 空のコースを作成する |
指定された名前の新しいコース シェルを作成します。 |
| 証明書 PDF をダウンロードする |
証明書 PDF をストリーム配信します。 証明書に PDF がまだない場合は 404 を返します |
| 証明書の詳細 |
呼び出し元の会社を対象にした 1 つの証明書を返します。 |
| 部署を一覧表示する |
入れ子になった役割を持つ呼び出し元の会社のすべての部門 |
| 部署を作成する |
呼び出し元の会社に新しい部門を作成します。 |
| 部署を削除 (非アクティブ化) する |
べき等 - 既に非アクティブ化されている場合でも 204 を返します。 ロールの割り当てへのカスケード。 |
| 部署を更新する |
更新プログラムの名前または説明 |
| 部門内でロールを作成する |
特定の部門を対象にした新しいロールを作成します。 |
1 つの質問の種類にトピック クイズ数を設定する
指定した questionType (MULTIPLE_CHOICE または OPEN_ENDED) の数を置き換えます。 その他の型の数は保持されます
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トピック ID
|
topicId | True | uuid |
トピック ID |
|
questionType
|
questionType | True | string | |
|
数える
|
count | integer |
返品
- 本文
- TopicDto
1 つの質問の種類に対してモジュール クイズ数を設定する
指定した questionType (MULTIPLE_CHOICE または OPEN_ENDED) の数を置き換えます。 その他の型の数は保持されます
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
モジュール ID
|
moduleId | True | uuid |
モジュール ID |
|
questionType
|
questionType | True | string | |
|
数える
|
count | integer |
返品
AI を使用して特定の項目を再生成する
1 つのレッスン、レッスンの質問、クイズ、イントロ、または演習を再生成します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ターゲット
|
target | True | string | |
|
Targetid
|
targetId | True | uuid | |
|
parentType
|
parentType | string |
返品
AI コンテンツを使用して完全なコースを生成する
コース シェル、すべてのモジュール、すべてのトピックを作成し、すべてのトピックの AI コンテンツ生成をエンキューします
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
名前
|
name | True | string | |
|
description
|
description | string | ||
|
名前
|
name | True | string | |
|
description
|
description | string | ||
|
名前
|
name | True | string | |
|
description
|
description | string |
返品
RPE_VIDEO演習をトピックに追加する
指定したトピック内に新しいRPE_VIDEOロールプレイ 演習を作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トピック ID
|
topicId | True | uuid |
トピック ID |
|
ダイアログを表示する
|
prompt | string | ||
|
avatarPictureId
|
avatarPictureId | uuid | ||
|
avatarCharacteristics
|
avatarCharacteristics | string | ||
|
reverseRolePlayEnabled
|
reverseRolePlayEnabled | boolean | ||
|
reverseRolePlayMandatory
|
reverseRolePlayMandatory | boolean |
返品
- 本文
- ExerciseDto
エキスパートから 1 つのロールの割り当てを削除する
冪等性
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
ロール ID
|
roleId | True | uuid |
ロール ID |
エキスパートからすべてのロールの割り当てを削除する
冪等性
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
エキスパートからドキュメントの割り当てを解除する
冪等性
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
ドキュメント ID
|
documentId | True | uuid |
ドキュメント ID |
エキスパートにドキュメントを割り当てる
エキスパートにドキュメントを一括リンクします。 べき等。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
documentIds
|
documentIds | True | array of uuid |
返品
エキスパートにロールを割り当てる
加法 — 既に割り当てられているロールが保持されます。新しいものが追加されました。 更新されたエキスパートを返します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
roleIds
|
roleIds | True | array of uuid |
返品
エキスパートを一覧表示する
呼び出し元の会社の専門家のページ分割された一覧
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ページ
|
page | integer |
ページ |
|
|
サイズ
|
size | integer |
サイズ |
|
|
Search
|
search | string |
Search |
返品
エキスパートを取得する
エキスパート メタデータ、リンクされたドキュメント、割り当てられたロール/部門を返します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
返品
クイズの質問をトピックに追加する
指定されたトピック内に新しいクイズの質問を作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トピック ID
|
topicId | True | uuid |
トピック ID |
|
型
|
type | True | string | |
|
SMS 送信
|
text | True | string | |
|
ordinalNumber
|
ordinalNumber | integer | ||
|
SMS 送信
|
text | True | string | |
|
isCorrect
|
isCorrect | boolean | ||
|
expectedAnswer
|
expectedAnswer | string |
返品
- 本文
- QuestionDto
コース バージョンのスナップショットを取得する
特定のバージョンの完全なコンテンツ ツリー (モジュール、トピック、レッスン、演習、質問) を返します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コース ID
|
courseId | True | uuid |
コース ID |
|
バージョン番号
|
versionNumber | True | integer |
バージョン番号 |
返品
コースから 1 つのロールの割り当てを削除する
冪等性
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
ロール ID
|
roleId | True | uuid |
ロール ID |
コースからすべてのロールの割り当てを削除する
冪等性
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
コースにモジュールを追加する
指定されたコース内に新しいモジュールを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コース ID
|
courseId | True | uuid |
コース ID |
|
名前
|
name | True | string | |
|
description
|
description | string |
返品
コースにロールを割り当てる
加法 - 既に割り当てられているロールはスキップされます。 更新されたコースの詳細を返します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
roleIds
|
roleIds | True | array of uuid |
返品
コースの AI 生成状態を取得する
進行状況とターゲット情報を含むコースのアクティブな AI 生成要求の一覧を返します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
返品
コースのバージョンを一覧表示する
バージョン番号で並べ替えられた発行済みバージョン メタデータ (カウント + 発行情報) を返します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コース ID
|
courseId | True | uuid |
コース ID |
返品
コースのモジュールを一覧表示する
ordinalNumber で並べ替えられたアクティブなモジュールを返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コース ID
|
courseId | True | uuid |
コース ID |
返品
コースを一覧表示する
呼び出し元の会社のコースのページ分割されたリスト
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ページ
|
page | integer |
ページ |
|
|
サイズ
|
size | integer |
サイズ |
|
|
Search
|
search | string |
Search |
|
|
Status
|
status | string |
Status |
|
|
部門ロール ID
|
departmentRoleIds | string |
部門ロール ID |
返品
コースを公開する
コースを削除 (ソフト) する
べき等 - コースが既に削除されている場合でも 204 を返します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
コースを取得する
モジュールの概要と割り当てられたロール/部門を含むコース メタデータを返します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
返品
コースメタデータを更新する
コース内のモジュールを並べ替える
moduleId には、すべてのアクティブなモジュールを新しい順序で 1 回だけ含める必要があります
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コース ID
|
courseId | True | uuid |
コース ID |
|
moduleIds
|
moduleIds | True | array of uuid |
返品
テストの質問をモジュールに追加する
指定されたモジュール内に新しいクイズの質問を作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
モジュール ID
|
moduleId | True | uuid |
モジュール ID |
|
型
|
type | True | string | |
|
SMS 送信
|
text | True | string | |
|
ordinalNumber
|
ordinalNumber | integer | ||
|
SMS 送信
|
text | True | string | |
|
isCorrect
|
isCorrect | boolean | ||
|
expectedAnswer
|
expectedAnswer | string |
返品
- 本文
- QuestionDto
デモ トレーニングを一覧表示する
呼び出し元の会社を対象とするページ分割されたリスト
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ページ
|
page | integer |
ページ |
|
|
サイズ
|
size | integer |
サイズ |
|
|
Search
|
search | string |
Search |
|
|
トレーニングの種類
|
trainingTypes | string |
トレーニングの種類 |
|
|
ステータス
|
statuses | string |
ステータス |
|
|
部署 ID
|
departmentIds | string |
部署 ID |
|
|
使用できる
|
isAvailable | boolean |
使用できる |
返品
デモ トレーニングを作成する
以前にアップロードしたビデオ ファイルからデモ トレーニングを作成し、処理を開始します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
名前
|
name | True | string | |
|
description
|
description | string | ||
|
trainingType
|
trainingType | True | string | |
|
videoFileId
|
videoFileId | True | uuid | |
|
departmentId
|
departmentId | uuid | ||
|
processingPrompt
|
processingPrompt | string |
返品
デモ トレーニングを削除する
べき等 - デモ トレーニングが存在しないか、既になくなった場合でも 204 を返します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
デモ トレーニングを受ける
デモ トレーニングを更新する
部分的な更新。 変更するフィールドのみを渡します。 assignedRoleIds は現在のセットを置き換えます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
名前
|
name | string | ||
|
description
|
description | string | ||
|
trainingType
|
trainingType | string | ||
|
departmentId
|
departmentId | uuid | ||
|
assignedRoleIds
|
assignedRoleIds | array of uuid |
返品
トピックから 1 つのドキュメントのリンクを解除する
冪等性
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トピック ID
|
topicId | True | uuid |
トピック ID |
|
ドキュメント ID
|
documentId | True | uuid |
ドキュメント ID |
トピックにILE_TEXT演習を追加する
指定したトピック内に新しいILE_TEXT演習を作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トピック ID
|
topicId | True | uuid |
トピック ID |
|
ダイアログを表示する
|
prompt | string |
返品
- 本文
- ExerciseDto
トピックにRPE_VOICE演習を追加する
特定のトピック内に新しいRPE_VOICEロールプレイ 演習を作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トピック ID
|
topicId | True | uuid |
トピック ID |
|
ダイアログを表示する
|
prompt | string | ||
|
avatarPictureId
|
avatarPictureId | uuid | ||
|
avatarCharacteristics
|
avatarCharacteristics | string | ||
|
reverseRolePlayEnabled
|
reverseRolePlayEnabled | boolean | ||
|
reverseRolePlayMandatory
|
reverseRolePlayMandatory | boolean |
返品
- 本文
- ExerciseDto
トピックにリンクされているドキュメントを一覧表示する
ページ分割済み。ドキュメント名による省略可能な検索
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トピック ID
|
topicId | True | uuid |
トピック ID |
|
ページ
|
page | integer |
ページ |
|
|
サイズ
|
size | integer |
サイズ |
|
|
Search
|
search | string |
Search |
返品
トピックに関する 1 つのクイズの質問を更新する
格納されている型に一致するフィールドを指定します。関連のないフィールドは無視されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トピック ID
|
topicId | True | uuid |
トピック ID |
|
質問 ID
|
questionId | True | uuid |
質問 ID |
|
SMS 送信
|
text | string | ||
|
SMS 送信
|
text | True | string | |
|
isCorrect
|
isCorrect | boolean | ||
|
expectedAnswer
|
expectedAnswer | string |
返品
- 本文
- QuestionDto
トピックに関するクイズの質問を 1 つ削除する
べき等 - 既に削除されている場合でも 204
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トピック ID
|
topicId | True | uuid |
トピック ID |
|
質問 ID
|
questionId | True | uuid |
質問 ID |
トピックに関するクイズの質問を 1 つ取得する
特定のトピックに添付された 1 つのクイズの質問を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トピック ID
|
topicId | True | uuid |
トピック ID |
|
質問 ID
|
questionId | True | uuid |
質問 ID |
返品
- 本文
- QuestionDto
トピックに関するクイズの質問を一覧表示する
特定のトピックに添付されているクイズの質問を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トピック ID
|
topicId | True | uuid |
トピック ID |
返品
トピックに関するクイズの質問を並べ替える
questionId には、トピックのすべてのアクティブなクイズの質問を新しい順序で含める必要があります。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トピック ID
|
topicId | True | uuid |
トピック ID |
|
questionIds
|
questionIds | True | array of uuid |
返品
トピックの AI コンテンツ生成をトリガーする
コース内の指定されたトピックの AI コンテンツ生成をエンキューする
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
topicIds
|
topicIds | True | array of uuid |
返品
トピックのメタデータを更新する
名前や説明を更新します。 省略されたフィールドは現在の値を保持します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トピック ID
|
topicId | True | uuid |
トピック ID |
|
名前
|
name | string | ||
|
description
|
description | string |
返品
- 本文
- TopicDto
トピックの学習バイト数を一覧表示する
指定されたトピックに属する学習バイトを返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トピック ID
|
topicId | True | uuid |
トピック ID |
返品
トピックの概要を削除する
べき等 - イントロが設定されていない場合でも 204
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トピック ID
|
topicId | True | uuid |
トピック ID |
トピックの概要を取得する
トピックの概要を設定または置換する
Upsert — 不足している場合は作成され、存在する場合は置き換えられます
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トピック ID
|
topicId | True | uuid |
トピック ID |
|
はじめに
|
introduction | string |
返品
- 本文
- IntroDto
トピックの演習を一覧表示する
ordinalNumber で並べ替えられた混合型 (ILE_TEXT/RPE_VOICE/RPE_VIDEO)
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トピック ID
|
topicId | True | uuid |
トピック ID |
返品
トピックを別のモジュールに移動する
targetOrdinalNumber は省略可能です。省略した場合、トピックはターゲット モジュールに追加されます
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トピック ID
|
topicId | True | uuid |
トピック ID |
|
targetModuleId
|
targetModuleId | True | uuid | |
|
targetOrdinalNumber
|
targetOrdinalNumber | integer |
返品
- 本文
- TopicDto
トピックを削除する (ソフト)
べき等 - トピックが既に削除されている場合でも 204 を返します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トピック ID
|
topicId | True | uuid |
トピック ID |
トピックを取得する
ドキュメント メタデータを更新する
更新プログラムの名前または説明
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
名前
|
name | string | ||
|
description
|
description | string |
返品
ドキュメントのアップロード
マルチパート アップロード (ファイルと省略可能な説明)。 最大 50 MB。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイル
|
file | True | file |
ファイル |
|
Description
|
description | string |
Description |
返品
ドキュメントをトピックにリンクする
加法 - 既にリンクされているドキュメントはスキップされます
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トピック ID
|
topicId | True | uuid |
トピック ID |
|
documentIds
|
documentIds | True | array of uuid |
ドキュメントを一覧表示する
呼び出し元の会社のドキュメントのページ分割された一覧
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ページ
|
page | integer |
ページ |
|
|
サイズ
|
size | integer |
サイズ |
|
|
Search
|
search | string |
Search |
|
|
Mime の種類
|
mimeTypes | string |
Mime の種類 |
|
|
Status
|
status | string |
Status |
返品
ドキュメントを削除 (非アクティブ化) する
べき等 - ドキュメントが既に削除または欠落している場合でも 204 を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
ドキュメントを取得する
ドキュメント メタデータと有効期間の短い署名付きダウンロード URL を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
返品
ドキュメントバイナリを置き換える
既存のドキュメントのファイル バイナリを置き換えます。メタデータは保持されます
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
ファイル
|
file | True | file |
ファイル |
返品
ビデオ処理を再実行する
AI セグメント化のビデオを再送信します。 必要に応じて、処理プロンプトをオーバーライドします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
processingPrompt
|
processingPrompt | string |
返品
メディア アイテムを削除 (非アクティブ化) する
べき等 - 項目が既に削除または不足している場合でも 204 を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
メディア バイナリを置き換える
既存のメディア項目のファイル バイナリを置き換えます。メタデータは保持されます
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
ファイル
|
file | True | file |
ファイル |
返品
メディア メタデータを更新する
更新プログラムの名前または説明
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
名前
|
name | string | ||
|
description
|
description | string |
返品
メディアを一覧表示する
呼び出し元の会社のメディア項目のページ分割されたリスト
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ページ
|
page | integer |
ページ |
|
|
サイズ
|
size | integer |
サイズ |
|
|
Search
|
search | string |
Search |
|
|
サブタイプ
|
kind | string |
サブタイプ |
|
|
Status
|
status | string |
Status |
返品
メディアアイテムをアップロードする
マルチパート アップロード (ファイルと省略可能な説明)。 画像の場合は最大 50 MB、ビデオの場合は 500 MB。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ファイル
|
file | True | file |
ファイル |
|
Description
|
description | string |
Description |
返品
メディア項目を取得する
モジュールで 1 つのクイズの質問を更新する
格納されている型に一致するフィールドを指定します。関連のないフィールドは無視されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
モジュール ID
|
moduleId | True | uuid |
モジュール ID |
|
質問 ID
|
questionId | True | uuid |
質問 ID |
|
SMS 送信
|
text | string | ||
|
SMS 送信
|
text | True | string | |
|
isCorrect
|
isCorrect | boolean | ||
|
expectedAnswer
|
expectedAnswer | string |
返品
- 本文
- QuestionDto
モジュールにトピックを追加する
指定されたモジュール内に新しいトピックを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
モジュール ID
|
moduleId | True | uuid |
モジュール ID |
|
名前
|
name | True | string | |
|
description
|
description | string |
返品
- 本文
- TopicDto
モジュールに関するクイズの質問を 1 つ取得する
特定のモジュールにアタッチされた 1 つのクイズの質問を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
モジュール ID
|
moduleId | True | uuid |
モジュール ID |
|
質問 ID
|
questionId | True | uuid |
質問 ID |
返品
- 本文
- QuestionDto
モジュールのイントロを削除する
べき等 - イントロが設定されていない場合でも 204
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
モジュール ID
|
moduleId | True | uuid |
モジュール ID |
モジュールのクイズの質問を 1 つ削除する
べき等 - 既に削除されている場合でも 204
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
モジュール ID
|
moduleId | True | uuid |
モジュール ID |
|
質問 ID
|
questionId | True | uuid |
質問 ID |
モジュールのクイズの質問を一覧表示する
指定されたモジュールにアタッチされているクイズの質問を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
モジュール ID
|
moduleId | True | uuid |
モジュール ID |
返品
モジュールのクイズの質問を並べ替える
questionId には、モジュールのすべてのアクティブなクイズの質問を新しい順序で含める必要があります。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
モジュール ID
|
moduleId | True | uuid |
モジュール ID |
|
questionIds
|
questionIds | True | array of uuid |
返品
モジュールのメタデータを更新する
名前や説明を更新します。 省略されたフィールドは現在の値を保持します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
モジュール ID
|
moduleId | True | uuid |
モジュール ID |
|
名前
|
name | string | ||
|
description
|
description | string |
返品
モジュールの概要を取得する
指定されたモジュールの開始テキスト セットを返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
モジュール ID
|
moduleId | True | uuid |
モジュール ID |
返品
- 本文
- IntroDto
モジュールの概要を設定または置き換える
Upsert — 不足している場合は作成され、存在する場合は置き換えられます
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
モジュール ID
|
moduleId | True | uuid |
モジュール ID |
|
はじめに
|
introduction | string |
返品
- 本文
- IntroDto
モジュールを削除する (ソフト)
べき等 — モジュールが既に削除されている場合でも 204 を返します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
モジュール ID
|
moduleId | True | uuid |
モジュール ID |
モジュールを取得する
指定された ID のモジュールの詳細を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
モジュール ID
|
moduleId | True | uuid |
モジュール ID |
返品
モジュール内のトピックを一覧表示する
ordinalNumber で並べ替えられたアクティブなトピックを返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
モジュール ID
|
moduleId | True | uuid |
モジュール ID |
返品
モジュール内のトピックを並べ替える
topicIds には、すべてのアクティブなトピックを新しい順序で 1 回だけ含める必要があります
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
モジュール ID
|
moduleId | True | uuid |
モジュール ID |
|
topicIds
|
topicIds | True | array of uuid |
返品
ユーザーの作成
ユーザーを作成し、マジック リンク招待フローをトリガーします
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
メール
|
True | |||
|
firstName
|
firstName | string | ||
|
lastName
|
lastName | string | ||
|
isAdmin
|
isAdmin | boolean | ||
|
departmentRoleIds
|
departmentRoleIds | array of uuid |
返品
- 本文
- UserDto
ユーザーの取得
ユーザーをロールに割り当てる
冪等性
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
ロール ID
|
roleId | True | uuid |
ロール ID |
|
userId
|
userId | True | uuid |
返品
ユーザーを一覧表示する
呼び出し元の会社のユーザーのページ分割された一覧
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ページ
|
page | integer |
ページ |
|
|
サイズ
|
size | integer |
サイズ |
|
|
Search
|
search | string |
Search |
|
|
Status
|
status | string |
Status |
|
|
部署 ID
|
departmentIds | string |
部署 ID |
|
|
ロール ID
|
roleIds | string |
ロール ID |
|
|
サブタイプ
|
kind | string |
サブタイプ |
返品
ユーザーを再アクティブ化する
ユーザーを更新する
firstName、lastName、isAdmin、ロールの割り当てを更新します。 v1 では電子メールは編集できません。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
firstName
|
firstName | string | ||
|
lastName
|
lastName | string | ||
|
isAdmin
|
isAdmin | boolean | ||
|
departmentRoleIds
|
departmentRoleIds | array of uuid |
返品
- 本文
- UserDto
ユーザーを非アクティブ化する
レッスンの内容を更新する
省略されたコンテンツは現在の値を保持します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
レッスン ID
|
lessonId | True | uuid |
レッスン ID |
|
コンテンツ
|
content | string |
返品
レッスンを削除する (ソフト)
べき等 - 既に削除されている場合でも 204
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
レッスン ID
|
lessonId | True | uuid |
レッスン ID |
レッスンを受ける
レッスンの内容、メディア、およびレッスン内の質問を返します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
レッスン ID
|
lessonId | True | uuid |
レッスン ID |
返品
レッスン内の質問を 1 つ取得する
1 つのレッスン内の質問を ID で返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
レッスン ID
|
lessonId | True | uuid |
レッスン ID |
|
質問 ID
|
questionId | True | uuid |
質問 ID |
返品
- 本文
- QuestionDto
レッスン内の質問を一覧表示する
指定されたレッスンに添付されたナレッジ チェックの質問を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
レッスン ID
|
lessonId | True | uuid |
レッスン ID |
返品
レッスン内の質問を並べ替える
questionId には、レッスンのすべてのアクティブな質問を新しい順序で含める必要があります
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
レッスン ID
|
lessonId | True | uuid |
レッスン ID |
|
questionIds
|
questionIds | True | array of uuid |
返品
レッスン内の質問を削除する
べき等 - 既に削除されている場合でも 204
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
レッスン ID
|
lessonId | True | uuid |
レッスン ID |
|
質問 ID
|
questionId | True | uuid |
質問 ID |
レッスン内の質問を更新する
格納されている型に一致するフィールドを指定します。関連付けられていないフィールドは無視されます
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
レッスン ID
|
lessonId | True | uuid |
レッスン ID |
|
質問 ID
|
questionId | True | uuid |
質問 ID |
|
SMS 送信
|
text | string | ||
|
SMS 送信
|
text | True | string | |
|
isCorrect
|
isCorrect | boolean | ||
|
expectedAnswer
|
expectedAnswer | string |
返品
- 本文
- QuestionDto
レッスン内の質問を追加する
型はMULTIPLE_CHOICE (オプションが必要) またはOPEN_ENDEDする必要があります
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
レッスン ID
|
lessonId | True | uuid |
レッスン ID |
|
型
|
type | True | string | |
|
SMS 送信
|
text | True | string | |
|
ordinalNumber
|
ordinalNumber | integer | ||
|
SMS 送信
|
text | True | string | |
|
isCorrect
|
isCorrect | boolean | ||
|
expectedAnswer
|
expectedAnswer | string |
返品
- 本文
- QuestionDto
ロールからユーザーの割り当てを解除する
べき等 - 割り当てられなかった場合でも 204
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
ロール ID
|
roleId | True | uuid |
ロール ID |
|
ユーザー ID
|
userId | True | uuid |
ユーザー ID |
会社レベルの分析情報
学生ごとのアクティビティ イベント
ページ分割された前方専用イベント ストリーム
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー ID
|
userId | True | uuid |
ユーザー ID |
|
ページ
|
page | integer |
ページ |
|
|
サイズ
|
size | integer |
サイズ |
返品
学生ごとの分析情報
特定のウィンドウの集計された概要とコースごとの内訳
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー ID
|
userId | True | uuid |
ユーザー ID |
|
ウィンドウ
|
window | string |
ウィンドウ |
返品
学生の空き時間を切り替える
デモ トレーニングを学生に公開するかどうかを設定します。 べき等。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
available
|
available | True | boolean |
返品
学生の証明書を一覧表示する
呼び出し元の会社内の特定の学生が獲得した証明書を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー ID
|
userId | True | uuid |
ユーザー ID |
返品
学習バイト メタデータを更新する
省略されたフィールドは現在の値を保持します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Lb Id
|
lbId | True | uuid |
Lb Id |
|
名前
|
name | string | ||
|
description
|
description | string |
返品
学習バイトでレッスンを一覧表示する
学習バイトにレッスンを追加する
指定された学習バイト内に新しいレッスンを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Lb Id
|
lbId | True | uuid |
Lb Id |
|
コンテンツ
|
content | True | string |
返品
学習バイトをトピックに追加する
指定されたトピック内に新しい学習バイトを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トピック ID
|
topicId | True | uuid |
トピック ID |
|
名前
|
name | True | string | |
|
description
|
description | string |
返品
学習バイトを削除する (ソフト)
べき等 - 既に削除されている場合でも 204
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Lb Id
|
lbId | True | uuid |
Lb Id |
学習バイトを取得する
専門家に質問する
ストリーミング AI チャットの同期ラッパー。 アセンブリされた回答を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
質問
|
question | True | string |
返品
- 本文
- AskResponse
演習を削除する
べき等 - 既に削除されている場合でも 204
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
演習を取得する
演習を更新する
型対応: ILE_TEXTはプロンプト + generatedContent.scenario のみを使用します。RPE_* では、すべての RPE フィールドが使用されます。 省略されたフィールドは、現在の値を保持します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
ダイアログを表示する
|
prompt | string | ||
|
avatarPictureId
|
avatarPictureId | uuid | ||
|
avatarCharacteristics
|
avatarCharacteristics | string | ||
|
reverseRolePlayEnabled
|
reverseRolePlayEnabled | boolean | ||
|
reverseRolePlayMandatory
|
reverseRolePlayMandatory | boolean | ||
|
シナリオ
|
scenario | string | ||
|
traineeRole
|
traineeRole | string | ||
|
avatarName
|
avatarName | string | ||
|
avatarDescription
|
avatarDescription | string | ||
|
operationalChallenge
|
operationalChallenge | string | ||
|
successMetric
|
successMetric | string |
返品
- 本文
- ExerciseDto
空のコースを作成する
証明書 PDF をダウンロードする
証明書 PDF をストリーム配信します。 証明書に PDF がまだない場合は 404 を返します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
返品
- response
- StreamingResponseBody
証明書の詳細
部署を一覧表示する
部署を作成する
呼び出し元の会社に新しい部門を作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
名前
|
name | True | string | |
|
description
|
description | string |
返品
部署を削除 (非アクティブ化) する
べき等 - 既に非アクティブ化されている場合でも 204 を返します。 ロールの割り当てへのカスケード。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
部署を更新する
更新プログラムの名前または説明
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
名前
|
name | string | ||
|
description
|
description | string |
返品
部門内でロールを作成する
特定の部門を対象にした新しいロールを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Id
|
id | True | uuid |
Id |
|
名前
|
name | True | string | |
|
フルネーム
|
fullName | string | ||
|
description
|
description | string |
返品
定義
QuizSettingDto
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
questionType
|
questionType | string | |
|
数える
|
count | integer |
TopicDto
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | uuid | |
|
moduleId
|
moduleId | uuid | |
|
名前
|
name | string | |
|
description
|
description | string | |
|
ordinalNumber
|
ordinalNumber | integer | |
|
hasContent
|
hasContent | boolean | |
|
quizSettings
|
quizSettings | array of QuizSettingDto |
IntroDto
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | uuid | |
|
コンポーネントID
|
componentId | uuid | |
|
componentType
|
componentType | string | |
|
はじめに
|
introduction | string | |
|
ソース
|
source | string | |
|
createdAt
|
createdAt | date-time | |
|
updatedAt
|
updatedAt | date-time |
ModuleDetailDto
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | uuid | |
|
courseId
|
courseId | uuid | |
|
名前
|
name | string | |
|
description
|
description | string | |
|
productId
|
productId | uuid | |
|
ordinalNumber
|
ordinalNumber | integer | |
|
lockedForGeneration
|
lockedForGeneration | boolean | |
|
quizSettings
|
quizSettings | array of QuizSettingDto | |
|
topics
|
topics | array of TopicDto |
MediaDetailDto
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | uuid | |
|
名前
|
name | string | |
|
description
|
description | string | |
|
kind
|
kind | string | |
|
mimeType(マイムタイプ)
|
mimeType | string | |
|
sizeBytes
|
sizeBytes | integer | |
|
状態
|
status | string | |
|
processingStatus
|
processingStatus | string | |
|
createdAt
|
createdAt | date-time | |
|
uploadedBy
|
uploadedBy | UploadedByDto | |
|
ダウンロードURL
|
downloadUrl | string |
UploadedByDto
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | uuid | |
|
kind
|
kind | string | |
|
名前
|
name | string |
DocumentDetailDto
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | uuid | |
|
名前
|
name | string | |
|
description
|
description | string | |
|
mimeType(マイムタイプ)
|
mimeType | string | |
|
sizeBytes
|
sizeBytes | integer | |
|
状態
|
status | string | |
|
createdAt
|
createdAt | date-time | |
|
uploadedBy
|
uploadedBy | UploadedByDto | |
|
ダウンロードURL
|
downloadUrl | string |
DepartmentRoleDto
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
departmentId
|
departmentId | uuid | |
|
部門名
|
departmentName | string | |
|
役割ID
|
roleId | uuid | |
|
ロール名
|
roleName | string |
UserDto
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | uuid | |
|
メール
|
string | ||
|
firstName
|
firstName | string | |
|
lastName
|
lastName | string | |
|
状態
|
status | string | |
|
kind
|
kind | string | |
|
isAdmin
|
isAdmin | boolean | |
|
createdAt
|
createdAt | date-time | |
|
departmentRoles
|
departmentRoles | array of DepartmentRoleDto |
QuestionDto
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | uuid | |
|
型
|
type | string | |
|
parentId
|
parentId | uuid | |
|
parentType
|
parentType | string | |
|
SMS 送信
|
text | string | |
|
ordinalNumber
|
ordinalNumber | integer | |
|
ソース
|
source | string | |
|
expectedAnswer
|
expectedAnswer | string | |
|
オプション
|
options | array of QuestionOptionDto | |
|
createdAt
|
createdAt | date-time | |
|
updatedAt
|
updatedAt | date-time |
QuestionOptionDto
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
SMS 送信
|
text | string | |
|
isCorrect
|
isCorrect | boolean | |
|
ordinalNumber
|
ordinalNumber | integer |
QuestionListResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
items | array of QuestionDto |
LearningByteDetailDto
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | uuid | |
|
topicId
|
topicId | uuid | |
|
名前
|
name | string | |
|
description
|
description | string | |
|
ordinalNumber
|
ordinalNumber | integer | |
|
ソース
|
source | string | |
|
createdAt
|
createdAt | date-time | |
|
updatedAt
|
updatedAt | date-time | |
|
レッスン
|
lessons | array of LessonDto |
LessonDto
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | uuid | |
|
learningByteId
|
learningByteId | uuid | |
|
コンテンツ
|
content | string | |
|
ordinalNumber
|
ordinalNumber | integer | |
|
ソース
|
source | string | |
|
questionCount
|
questionCount | integer | |
|
mediaCount
|
mediaCount | integer | |
|
createdAt
|
createdAt | date-time | |
|
updatedAt
|
updatedAt | date-time |
ExerciseDto
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | uuid | |
|
topicId
|
topicId | uuid | |
|
型
|
type | string | |
|
ダイアログを表示する
|
prompt | string | |
|
ordinalNumber
|
ordinalNumber | integer | |
|
ソース
|
source | string | |
|
isGenerated
|
isGenerated | boolean | |
|
avatarPictureId
|
avatarPictureId | uuid | |
|
avatarCharacteristics
|
avatarCharacteristics | string | |
|
reverseRolePlayEnabled
|
reverseRolePlayEnabled | boolean | |
|
reverseRolePlayMandatory
|
reverseRolePlayMandatory | boolean | |
|
generatedContent
|
generatedContent | ExerciseGeneratedContentDto | |
|
createdAt
|
createdAt | date-time | |
|
updatedAt
|
updatedAt | date-time |
ExerciseGeneratedContentDto
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | uuid | |
|
regenerationId
|
regenerationId | uuid | |
|
シナリオ
|
scenario | string | |
|
traineeRole
|
traineeRole | string | |
|
avatarName
|
avatarName | string | |
|
avatarDescription
|
avatarDescription | string | |
|
operationalChallenge
|
operationalChallenge | string | |
|
successMetric
|
successMetric | string | |
|
開始します。
|
instruction | string | |
|
instructionReverse
|
instructionReverse | string | |
|
exerciseKnowledgeBase
|
exerciseKnowledgeBase | string | |
|
topicKnowledgeBase
|
topicKnowledgeBase | string |
TopicListResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
items | array of TopicDto |
LessonDetailDto
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | uuid | |
|
learningByteId
|
learningByteId | uuid | |
|
コンテンツ
|
content | string | |
|
ordinalNumber
|
ordinalNumber | integer | |
|
ソース
|
source | string | |
|
createdAt
|
createdAt | date-time | |
|
updatedAt
|
updatedAt | date-time | |
|
メディア
|
media | array of MediaLinkDto | |
|
質問
|
questions | array of QuestionDto |
MediaLinkDto
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | uuid | |
|
fileId
|
fileId | uuid | |
|
ordinalNumber
|
ordinalNumber | integer | |
|
ソース
|
source | string |
ExpertDetailDto
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | uuid | |
|
名前
|
name | string | |
|
description
|
description | string | |
|
状態
|
status | string | |
|
linkedDocumentCount
|
linkedDocumentCount | integer | |
|
createdAt
|
createdAt | date-time | |
|
updatedAt
|
updatedAt | date-time | |
|
assignedRoleIds
|
assignedRoleIds | array of uuid | |
|
assignedDepartmentIds
|
assignedDepartmentIds | array of uuid | |
|
linkedDocuments
|
linkedDocuments | array of LinkedDocumentDto |
LinkedDocumentDto
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | uuid | |
|
名前
|
name | string | |
|
拡張子
|
extension | string | |
|
sizeBytes
|
sizeBytes | integer | |
|
description
|
description | string | |
|
linkedAt
|
linkedAt | date-time |
AskResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
回答
|
answer | string | |
|
durationMs
|
durationMs | integer |
DepartmentDto
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | uuid | |
|
名前
|
name | string | |
|
description
|
description | string | |
|
状態
|
status | string | |
|
createdAt
|
createdAt | date-time | |
|
roles
|
roles | array of DepartmentRoleDto |
DemoTrainingDto
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
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
|
updatedAt | date-time |
DemoTrainingSegmentDto
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | uuid | |
|
ordinalNumber
|
ordinalNumber | integer | |
|
名前
|
name | string | |
|
トランスクリプト
|
transcript | string | |
|
durationSeconds (デュレーション秒)
|
durationSeconds | integer |
CourseDetailDto
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | uuid | |
|
名前
|
name | string | |
|
状態
|
status | string | |
|
moduleCount
|
moduleCount | integer | |
|
topicCount
|
topicCount | integer | |
|
hasUnpublishedChanges
|
hasUnpublishedChanges | boolean | |
|
currentVersionNumber
|
currentVersionNumber | integer | |
|
createdAt
|
createdAt | date-time | |
|
updatedAt
|
updatedAt | date-time | |
|
assignedRoleIds
|
assignedRoleIds | array of uuid | |
|
assignedDepartmentIds
|
assignedDepartmentIds | array of uuid | |
|
modules
|
modules | array of ModuleSummaryDto |
ModuleSummaryDto
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | uuid | |
|
名前
|
name | string | |
|
ordinalNumber
|
ordinalNumber | integer | |
|
topicCount
|
topicCount | integer |
GenerationRequestResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | uuid | |
|
状態
|
status | string |
ModuleDto
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | uuid | |
|
courseId
|
courseId | uuid | |
|
名前
|
name | string | |
|
description
|
description | string | |
|
productId
|
productId | uuid | |
|
ordinalNumber
|
ordinalNumber | integer | |
|
lockedForGeneration
|
lockedForGeneration | boolean | |
|
topicCount
|
topicCount | integer | |
|
quizSettings
|
quizSettings | array of QuizSettingDto |
ModuleListResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
items | array of ModuleDto |
GenerateCourseResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
courseId
|
courseId | uuid | |
|
generationRequestId
|
generationRequestId | uuid |
PageInfo
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
size
|
size | integer | |
|
数値
|
number | integer | |
|
totalElements
|
totalElements | integer | |
|
総ページ数
|
totalPages | integer |
UserListResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
items | array of UserDto | |
|
ページ
|
page | PageInfo |
TopicLinkedDocumentDto
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | uuid | |
|
名前
|
name | string | |
|
拡張子
|
extension | string | |
|
size
|
size | integer | |
|
processingStatus
|
processingStatus | string | |
|
description
|
description | string | |
|
ソース
|
source | string | |
|
linkType
|
linkType | string | |
|
linkedAt
|
linkedAt | date-time |
TopicLinkedDocumentListResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
items | array of TopicLinkedDocumentDto | |
|
ページ
|
page | PageInfo |
LearningByteDto
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | uuid | |
|
topicId
|
topicId | uuid | |
|
名前
|
name | string | |
|
description
|
description | string | |
|
ordinalNumber
|
ordinalNumber | integer | |
|
ソース
|
source | string | |
|
lessonCount
|
lessonCount | integer | |
|
createdAt
|
createdAt | date-time | |
|
updatedAt
|
updatedAt | date-time |
LearningByteListResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
items | array of LearningByteDto |
ExerciseListResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
items | array of ExerciseDto |
CertificateDto
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | uuid | |
|
登録ID
|
enrollmentId | uuid | |
|
studentId
|
studentId | uuid | |
|
companyId
|
companyId | uuid | |
|
courseId
|
courseId | uuid | |
|
courseVersionId
|
courseVersionId | uuid | |
|
studentName
|
studentName | string | |
|
companyName
|
companyName | string | |
|
courseName
|
courseName | string | |
|
serialNumber
|
serialNumber | string | |
|
completedAt
|
completedAt | date-time | |
|
発行元
|
issuedAt | date-time | |
|
pdfFileId
|
pdfFileId | uuid | |
|
pdfAvailable
|
pdfAvailable | boolean |
CertificateListResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
items | array of CertificateDto |
MediaDto
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | uuid | |
|
名前
|
name | string | |
|
description
|
description | string | |
|
kind
|
kind | string | |
|
mimeType(マイムタイプ)
|
mimeType | string | |
|
sizeBytes
|
sizeBytes | integer | |
|
状態
|
status | string | |
|
processingStatus
|
processingStatus | string | |
|
createdAt
|
createdAt | date-time | |
|
uploadedBy
|
uploadedBy | UploadedByDto |
MediaListResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
items | array of MediaDto | |
|
ページ
|
page | PageInfo |
LessonListResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
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 | StudentSummaryDto | |
|
byCourse
|
byCourse | array of CourseBreakdownDto |
StudentSummaryDto
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
activeDays
|
activeDays | integer | |
|
lessonsCompleted
|
lessonsCompleted | integer | |
|
exercisesCompleted
|
exercisesCompleted | integer | |
|
quizzesPassed
|
quizzesPassed | integer | |
|
hoursSpent
|
hoursSpent | double |
WindowDto
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
kind
|
kind | string | |
|
from
|
from | date-time | |
|
to
|
to | date-time |
EventItemDto
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | uuid | |
|
kind
|
kind | string | |
|
アクション
|
action | string | |
|
courseId
|
courseId | uuid | |
|
courseName
|
courseName | string | |
|
occurredAt
|
occurredAt | date-time |
EventListResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
items | array of EventItemDto | |
|
ページ
|
page | PageInfo |
CompanyInsightsDto
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
companyId
|
companyId | uuid | |
|
概要
|
summary | CompanySummaryDto |
CompanySummaryDto
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
totalStudents
|
totalStudents | integer | |
|
averageProgressPercent
|
averageProgressPercent | integer | |
|
activeThisWeekCount
|
activeThisWeekCount | integer | |
|
completedCount
|
completedCount | integer | |
|
completionRatePercent
|
completionRatePercent | integer |
ExpertDto
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | uuid | |
|
名前
|
name | string | |
|
description
|
description | string | |
|
状態
|
status | string | |
|
linkedDocumentCount
|
linkedDocumentCount | integer | |
|
createdAt
|
createdAt | date-time | |
|
updatedAt
|
updatedAt | date-time |
ExpertListResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
items | array of ExpertDto | |
|
ページ
|
page | PageInfo |
DocumentDto
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | uuid | |
|
名前
|
name | string | |
|
description
|
description | string | |
|
mimeType(マイムタイプ)
|
mimeType | string | |
|
sizeBytes
|
sizeBytes | integer | |
|
状態
|
status | string | |
|
createdAt
|
createdAt | date-time | |
|
uploadedBy
|
uploadedBy | UploadedByDto |
DocumentListResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
items | array of DocumentDto | |
|
ページ
|
page | PageInfo |
DepartmentListResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
items | array of DepartmentDto |
DemoTrainingListItemDto
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
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 | array of DemoTrainingListItemDto | |
|
ページ
|
page | PageInfo |
CourseDto
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
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 | array of CourseDto | |
|
ページ
|
page | PageInfo |
GenerationProgressDto
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
totalTasks
|
totalTasks | integer | |
|
completedTasks
|
completedTasks | integer | |
|
failedTasks
|
failedTasks | integer |
GenerationRequestInfoDto
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | uuid | |
|
状態
|
status | string | |
|
createdAt
|
createdAt | string | |
|
completedAt
|
completedAt | string | |
|
エラー
|
error | string | |
|
progress
|
progress | GenerationProgressDto | |
|
ターゲット
|
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 | uuid | |
|
courseId
|
courseId | uuid | |
|
VersionNumber
|
versionNumber | integer | |
|
publishedAt
|
publishedAt | date-time | |
|
publishedBy
|
publishedBy | uuid | |
|
moduleCount
|
moduleCount | integer | |
|
topicCount
|
topicCount | integer | |
|
lessonCount
|
lessonCount | integer | |
|
exerciseCount
|
exerciseCount | integer | |
|
questionCount
|
questionCount | integer | |
|
estimatedTimeSeconds
|
estimatedTimeSeconds | integer |
CourseVersionListResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アイテム
|
items | array of CourseVersionDto |
AuditSnapshot
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
createdAt
|
createdAt | date-time | |
|
createdBy
|
createdBy | uuid | |
|
updatedAt
|
updatedAt | date-time | |
|
更新されました
|
updatedBy | uuid |
CourseSnapshot
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
名前
|
name | string | |
|
coverImageId
|
coverImageId | uuid | |
|
prerequisiteCourseId
|
prerequisiteCourseId | uuid | |
|
courseGuideline
|
courseGuideline | string | |
|
lessonsGuideline
|
lessonsGuideline | string | |
|
questionsGuideline
|
questionsGuideline | string | |
|
exercisesGuideline
|
exercisesGuideline | string | |
|
modules
|
modules | array of ModuleSnapshot |
CourseVersionSnapshotDto
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | uuid | |
|
courseId
|
courseId | uuid | |
|
VersionNumber
|
versionNumber | integer | |
|
スナップショット
|
snapshot | CourseSnapshot |
ExerciseSnapshot
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | uuid | |
|
topicId
|
topicId | uuid | |
|
exerciseType
|
exerciseType | string | |
|
ダイアログを表示する
|
prompt | string | |
|
ordinalNumber
|
ordinalNumber | integer | |
|
isGenerated
|
isGenerated | boolean | |
|
ソース
|
source | string | |
|
監査
|
audit | AuditSnapshot | |
|
avatarCharacteristics
|
avatarCharacteristics | string | |
|
avatarPictureId
|
avatarPictureId | uuid | |
|
reverseRolePlayEnabled
|
reverseRolePlayEnabled | boolean | |
|
reverseRolePlayMandatory
|
reverseRolePlayMandatory | boolean | |
|
シナリオ
|
scenario | string | |
|
traineeRole
|
traineeRole | string | |
|
avatarName
|
avatarName | string | |
|
avatarDescription
|
avatarDescription | string | |
|
operationalChallenge
|
operationalChallenge | string | |
|
successMetric
|
successMetric | string | |
|
開始します。
|
instruction | string | |
|
instructionReverse
|
instructionReverse | string | |
|
exerciseKnowledgeBase
|
exerciseKnowledgeBase | string |
LearningByteSnapshot
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | uuid | |
|
topicId
|
topicId | uuid | |
|
名前
|
name | string | |
|
description
|
description | string | |
|
ordinalNumber
|
ordinalNumber | integer | |
|
ソース
|
source | string | |
|
監査
|
audit | AuditSnapshot | |
|
レッスン
|
lessons | array of LessonSnapshot |
LessonSnapshot
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | uuid | |
|
learningByteId
|
learningByteId | uuid | |
|
コンテンツ
|
content | string | |
|
ordinalNumber
|
ordinalNumber | integer | |
|
ソース
|
source | string | |
|
監査
|
audit | AuditSnapshot | |
|
メディア
|
media | array of MediaSnapshot | |
|
質問
|
questions | array of QuestionSnapshot |
LinkedDocumentSnapshot
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | uuid | |
|
fileId
|
fileId | uuid | |
|
linkType
|
linkType | string | |
|
isSupplement
|
isSupplement | boolean | |
|
名前
|
name | string | |
|
拡張子
|
extension | string | |
|
size
|
size | integer | |
|
description
|
description | string |
MediaSnapshot
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | uuid | |
|
fileId
|
fileId | uuid | |
|
ordinalNumber
|
ordinalNumber | integer | |
|
mediaType
|
mediaType | string | |
|
ソース
|
source | string |
ModuleSnapshot
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | uuid | |
|
courseId
|
courseId | uuid | |
|
productId
|
productId | uuid | |
|
名前
|
name | string | |
|
description
|
description | string | |
|
イントロ
|
intro | string | |
|
ordinalNumber
|
ordinalNumber | integer | |
|
quizSettings
|
quizSettings | array of QuizSettingSnapshot | |
|
quizQuestions
|
quizQuestions | array of QuestionSnapshot | |
|
topics
|
topics | array of TopicSnapshot |
OptionSnapshot
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | uuid | |
|
optionText
|
optionText | string | |
|
isCorrect
|
isCorrect | boolean | |
|
ordinalNumber
|
ordinalNumber | integer |
QuestionSnapshot
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | uuid | |
|
questionType
|
questionType | string | |
|
questionText
|
questionText | string | |
|
expectedAnswer
|
expectedAnswer | string | |
|
ordinalNumber
|
ordinalNumber | integer | |
|
ソース
|
source | string | |
|
監査
|
audit | AuditSnapshot | |
|
オプション
|
options | array of OptionSnapshot |
QuizSettingSnapshot
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
questionType
|
questionType | string | |
|
数える
|
count | integer |
TopicSnapshot
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | uuid | |
|
moduleId
|
moduleId | uuid | |
|
名前
|
name | string | |
|
description
|
description | string | |
|
イントロ
|
intro | string | |
|
ordinalNumber
|
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 |