Secure Code Warrior (Independent Publisher) (プレビュー)
この Secure Code Warrior(https://securecodewarrior.com) コネクタは、ラーニング プラットフォームへのプログラムによるアクセスを提供します。 Secure Code Warrior は、ソフトウェア セキュリティ スキルを向上させる開発者にとって、安全なコーディングを前向きで魅力的なエクスペリエンスにします。 主要なラーニング プラットフォームを使用して、各コーダーをそれぞれの優先ラーニング パスに沿ってガイドし、セキュリティスキルのある開発者が接続された世界の日常のスーパーヒーローになるようにします。
このコネクタは、次の製品および地域で利用可能です。
| Service | クラス | 地域 |
|---|---|---|
| Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - Azure 政府の地域 - Azure 中国の地域 - 国防総省 (DoD) |
| Power Automate | プレミアム | 以下を除くすべての Power Automate 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 国防総省 (DoD) |
| Power Apps | プレミアム | 以下を除くすべての Power Apps 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
| お問い合わせ先 | |
|---|---|
| 件名 | Troy Taylor |
| [URL] | https://www.hitachisolutions.com |
| メール | ttaylor@hitachisolutions.com |
| Connector Metadata | |
|---|---|
| 発行者 | 日立ソリューションズ |
| Secure Code Warrior の詳細をご覧ください | https://docs.microsoft.com/connectors/securecodewarrior |
| Web サイト | https://www.securecodewarrior.com/ |
| プライバシー ポリシー | https://www.securecodewarrior.com/trust/privacy-policy |
| カテゴリ | IT 操作 |
接続の作成
コネクタは、次の認証タイプをサポートしています:
| 既定 | 接続を作成するためのパラメーター。 | すべての地域 | 共有不可 |
既定
適用できるもの: すべての領域
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 パワー アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 名称 | タイプ | 内容 | 必要 |
|---|---|---|---|
| API トークン | securestring | この API の API tokenfor | 真 |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| すべてのコースを取得する |
このエンドポイントは、コースに関連するデータポイントの範囲を含むコース オブジェクトの一覧を返します。 これには、他のコース API エンドポイントと組み合わせて使用できるコース ID が含まれます。 |
| コース URL の取得 |
コース URL を含む JSON |
| コースのすべての開発者の進行状況を取得する |
このエンドポイントは、指定されたコースのすべての開発者の進行状況を返します。 |
| チーム ランキングを取得する |
このエンドポイントは、組織内のすべてのチームの一覧と、現時点のの統計、およびレポート期間 (1、7、または 30 日) の統計の変化を返します。 |
| チームの詳細を取得する |
これは、チームの詳細を取得するために使用されます。 |
| チームの詳細を更新する |
これは、チームの詳細を更新するために使用されます。 |
| チームを作成する |
これは、チームを作成するために使用されます。 |
| チームを削除 |
これは、チームを削除するために使用されます。 |
| チームを取得 |
このエンドポイントは、チームに関連するデータポイントの範囲を含むチーム オブジェクトの一覧を返します。 これには、他のチーム API エンドポイントと組み合わせて使用できるチーム ID が含まれます。 |
| トーナメント ランキングを取得する |
このエンドポイントは、単一のトーナメントのランキングを返します。 これには、開発者が参加したすべてのレベル、課題、およびステージが含まれ、各詳細なメトリックが含まれます。 |
| トーナメント ランキングを検索する |
このエンドポイントは、単一のトーナメントのランキングを返します。 これには、開発者が参加したすべてのレベル、課題、およびステージが含まれ、各詳細なメトリックが含まれます。 このエンドポイントは、レポート期間 (1、7、または 30 日) または特定の日付範囲でランキングを返すこともできます。 結果は、開発者の電子メール、開発者のタグ、およびチーム名に基づいてフィルター処理できます。 |
| トーナメントを取得する |
このエンドポイントは、社内のトーナメントの一覧を返します。 |
| ユーザーの取得 |
これは、単一のユーザー レコードを取得するために使用されます。 応答は、返す属性名を一覧表示するフィールド クエリ パラメーターを渡すことによって形成できます。 |
| ユーザーの検索 |
これは、すべてのユーザー レコードを取得するために使用されます。 応答は、返す属性名を一覧表示するフィールド クエリ パラメーターを渡すことによって形成できます。 フィルターは、フィルター条件を本体に通すことによって実現されます。 |
| ユーザーを作成する |
ユーザーを作成します。 |
| ユーザーを削除 |
指定された ID で参照されているユーザーを削除します。 |
| ユーザーを取得 |
これは、すべてのユーザー レコードを取得するために使用されます。 応答は、返す属性名を一覧表示するフィールド クエリ パラメーターを渡すことによって形成できます。 |
| ユーザーを更新 |
指定されたデータでユーザーを更新します。 タグは置き換えられます。 |
| リソースを取得する |
学習リソースの一覧 |
| 学習進行状況を検索する |
学習の説明フィルター - ユーザー、チームおよびタグ |
| 完了、読み取り、または視聴した学習リソースを表示する |
学習の説明 |
| 所要時間を取得する |
評価、学習、トーナメント、トレーニング全体でプラットフォームに費やした時間。 |
| 最も関わりのあるチーム活動を取得する |
このエンドポイントは、最も関わりのある上位「N」チームを返します。 |
| 最も関わりのあるユーザー活動を取得する |
このエンドポイントは、最も関わりのある上位「N」ユーザーを返します。 |
| 検索コースの開発者の進行状況 |
このエンドポイントは、組織内のすべての開発者のコースス進行状況を返します。 |
| 検索評価 |
このエンドポイントは、評価に関連するデータポイントの範囲を含む評価オブジェクトの一覧を返します。 これには、他の評価 API エンドポイントと組み合わせて使用できる評価 ID が含まれます。 結果は、状態、名前、サポートされている言語、難易度に基づいてフィルター処理できます。 |
| 検索評価の試行 |
このエンドポイントは、指定された ID で評価を受けたすべての開発者の詳細なレポートを返します。 レポートの範囲は、さまざまな方法でフィルター処理できます。 クエリで電子メール アドレスを指定することにより、指定された開発者に結果をフィルター処理できます。 状態が提供されている場合、指定された状態の評価試行のみが含まれます。 チーム名が提供されている場合、それらのチーム内のユーザーの評価試行のみが含まれます。 タグが提供されている場合、それらのタグでのユーザーの評価試行のみが含まれます。 pass_status が提供されている場合、指定された pass_status での評価試行のみが含まれます。 これには、概要レポートのすべてのデータに加えて、評価の一部であるすべての課題の詳細が含まれます。 |
| 活動の上位担当者を取得する |
これは上位担当者ユーザーの一覧を取得するために使用されます。 |
| 活動の長所と短所を取得する |
このエンドポイントは、特定の言語またはすべての言語について、会社、チーム、またはユーザーの平均的な長所と短所 (クエリの粒度のレベルに応じて) を返す |
| 評価の試行を取得する |
このエンドポイントは、指定された ID で評価を受けたすべての開発者の詳細なレポートを返します。 レポートの範囲は、さまざまな方法でフィルター処理できます。 クエリで電子メール アドレスを指定することにより、指定された開発者に結果をフィルター処理できます。 開始日が提供されている場合、この日付以降 (および含む) に開始または完了した試行のみが含まれます。 終了日が提供されている場合、この日付より前に開始または完了した課題のみが含まれます。 両方を指定すると、フィルターを適用する日付範囲が示されます。 これには、概要レポートのすべてのデータに加えて、評価の一部であるすべての課題の詳細が含まれます。 |
| 評価を割り当てる |
このエンドポイントは、指定された評価を特定のユーザー/チームに割り当てます。 電子メール、inviteUrl、および招待電子メールが送信されたかどうかを示すステータスとともに、評価に割り当てられたユーザーのリストを返します。 |
| 評価を取得する |
このエンドポイントは、評価に関連するデータポイントの範囲を含む評価オブジェクトの一覧を返します。 これには、他の評価 API エンドポイントと組み合わせて使用できる評価 ID が含まれます。 |
| 開発者の進行状況を取得する |
このエンドポイントは、組織内のすべての開発者のトレーニングの進行状況と、現在の領域、レベル、およびクエストの進行状況を返します。 |
| 開発者ランキングを取得する |
このエンドポイントは、組織内のすべての開発者の一覧と、現時点のの統計、およびレポート期間 (1、7、または 30 日) の統計の変化を返します。 |
| 開発者ランキングを検索する |
このエンドポイントは、組織内のすべての開発者の一覧と、現時点のの統計を返します。これには、報告期間 (1、7、または 30 日) または特定の日付範囲での統計の変化も一覧表示されます。 結果は、開発者の電子メール、開発者のタグ、およびチーム名に基づいてフィルター処理できます。 |
| 開発者活動を取得する |
このエンドポイントは、組織内のすべての開発者の詳細な課題ログを、開発者の課題スコア、難易度、および課題結果とともに返します。 |
| 開発者活動を検索する |
このエンドポイントは、組織内のすべての開発者の詳細な課題ログを、開発者の課題スコア、難易度、および課題結果とともに返します。 これには、レポート期間 (1、7、または 30 日) または特定の日付範囲にわたる課題ログも一覧表示されます。 結果は、開発者の電子メール、開発者のタグ、およびチーム名に基づいてフィルター処理できます。 |
| 開発者進行状況を検索する |
このエンドポイントは、組織内のすべての開発者のトレーニングの進行状況と、現在の領域、レベル、およびクエストの進行状況を返します。 これには、レポート期間 (1、7、または 30 日) または特定の日付範囲にわたる開発者進行状況での課題も一覧表示されます。 結果は、開発者の電子メール、開発者のタグ、およびチーム名に基づいてフィルター処理できます。 |
すべてのコースを取得する
このエンドポイントは、コースに関連するデータポイントの範囲を含むコース オブジェクトの一覧を返します。 これには、他のコース API エンドポイントと組み合わせて使用できるコース ID が含まれます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ページ
|
page | integer |
結果のページ番号 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
コース
|
courses | array of Course | |
|
total_pages
|
links.total_pages | integer |
結果に含まれるページの合計数 |
|
results_per_page
|
links.results_per_page | integer |
各ページの結果の最大数 |
|
next_page
|
links.next_page | integer |
次のページのページ番号 (存在する場合) |
|
prev_page
|
links.prev_page | integer |
前のページのページ番号 (存在する場合) |
|
total_results
|
links.total_results | integer |
結果の合計数 |
コース URL の取得
コース URL を含む JSON
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
言語フレームワーク
|
language_framework | True | string |
「Java::Spring」の形式での言語とフレームワークの名前 |
|
コース
|
course | True | string |
コース名 |
|
モジュール
|
module | True | string |
コース モジュールの名前 |
|
リダイレクト
|
redirect | boolean |
ユーザーを返す URL にリダイレクトする |
戻り値
トレーニング コースへの URL
- コース URL
- CourseURL
コースのすべての開発者の進行状況を取得する
このエンドポイントは、指定されたコースのすべての開発者の進行状況を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コース ID
|
course_id | True | string |
コース ID |
|
ページ
|
page | integer |
結果のページ番号 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
data
|
data | array of CourseDeveloperProgressEntry | |
|
total_pages
|
links.total_pages | integer |
結果に含まれるページの合計数 |
|
results_per_page
|
links.results_per_page | integer |
各ページの結果の最大数 |
|
next_page
|
links.next_page | integer |
次のページのページ番号 (存在する場合) |
|
prev_page
|
links.prev_page | integer |
前のページのページ番号 (存在する場合) |
|
total_results
|
links.total_results | integer |
結果の合計数 |
チーム ランキングを取得する
このエンドポイントは、組織内のすべてのチームの一覧と、現時点のの統計、およびレポート期間 (1、7、または 30 日) の統計の変化を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
報告期間
|
report_period | integer |
統計の変化を表示する日数 |
|
|
非アクティブの省略
|
omitInactive | boolean |
True に設定すると、すべての非アクティブなアカウントが結果から省略される |
|
|
ページ
|
page | integer |
結果のページ番号 |
|
|
開始日
|
startdate | date-time |
指定された時間以降に完了したランキングからのポイントが含まれます。 形式: YYYY-MM-DDTHH:mm:ss.SSSZ |
|
|
終了日
|
enddate | date-time |
指定された時間以前に完了したランキングからのポイントが含まれます。 形式: YYYY-MM-DDTHH:mm:ss.SSSZ |
戻り値
チームの詳細を取得する
これは、チームの詳細を取得するために使用されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
チーム ID
|
team_id | True | string |
チーム ID |
戻り値
チームの詳細
- 本文
- TeamDetails
チームの詳細を更新する
これは、チームの詳細を更新するために使用されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
チーム ID
|
team_id | True | string |
チーム ID |
|
名称
|
name | string |
Team Name |
|
|
tags
|
tags | array of string |
チームに関する識別情報。 例: 本社、アジア太平洋、エンジニアリング |
|
|
ステータス
|
status | string |
チームの状態 |
|
|
onboardingmessage
|
onboardingmessage | string |
チーム オン ボーディング メッセージ |
|
|
言語
|
languages | array of string |
二重コロン (::) とコンマ (,) で区切られたチーム言語リスト、_id および _framework |
戻り値
チームの詳細
- Body
- TeamDetails
チームを作成する
これは、チームを作成するために使用されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
名称
|
name | string |
Team Name |
|
|
tags
|
tags | array of string |
チームに関する識別情報。 例: 本社、アジア太平洋、エンジニアリング |
|
|
activeFrom
|
activeFrom | string |
チーム アクティブから。 形式: YYYY-MM-DDTHH:mm:ss.SSSZ |
|
|
activeUntil
|
activeUntil | string |
チーム アクティブまで。 形式: YYYY-MM-DDTHH:mm:ss.SSSZ |
|
|
言語
|
languages | array of string |
二重コロン (::) とコンマ (,) で区切られたチーム言語リスト、_id および _framework |
|
|
onboardingmessage
|
onboardingmessage | string |
チーム オン ボーディング メッセージ |
|
|
タイプ
|
type | string |
ライセンスの種類 |
|
|
付与済み
|
granted | integer |
付与されたライセンス (ライセンスの種類が使用に設定されている場合にのみ有効) |
戻り値
チームの詳細
- 本文
- TeamDetails
チームを削除
これは、チームを削除するために使用されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
チーム ID
|
team_id | True | string |
チーム ID |
戻り値
チーム 削除応答
- 本文
- TeamDeleteResponse
チームを取得
このエンドポイントは、チームに関連するデータポイントの範囲を含むチーム オブジェクトの一覧を返します。 これには、他のチーム API エンドポイントと組み合わせて使用できるチーム ID が含まれます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ページ
|
page | integer |
結果のページ番号 |
|
|
チーム名
|
name | string |
チーム名 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
チーム
|
teams | array of TeamDetails | |
|
total_pages
|
links.total_pages | integer |
結果に含まれるページの合計数 |
|
results_per_page
|
links.results_per_page | integer |
各ページの結果の最大数 |
|
next_page
|
links.next_page | integer |
次のページのページ番号 (存在する場合) |
|
prev_page
|
links.prev_page | integer |
前のページのページ番号 (存在する場合) |
|
total_results
|
links.total_results | integer |
結果の合計数 |
トーナメント ランキングを取得する
このエンドポイントは、単一のトーナメントのランキングを返します。 これには、開発者が参加したすべてのレベル、課題、およびステージが含まれ、各詳細なメトリックが含まれます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トーナメント ID
|
tournament_id | True | string |
トーナメント ID |
|
ページ
|
page | integer |
結果のページ番号 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ランキング
|
leaderboard | array of TournamentParticipant | |
|
total_pages
|
links.total_pages | integer |
結果に含まれるページの合計数 |
|
results_per_page
|
links.results_per_page | integer |
各ページの結果の最大数 |
|
next_page
|
links.next_page | integer |
次のページのページ番号 (存在する場合) |
|
prev_page
|
links.prev_page | integer |
前のページのページ番号 (存在する場合) |
|
total_results
|
links.total_results | integer |
結果の合計数 |
トーナメント ランキングを検索する
このエンドポイントは、単一のトーナメントのランキングを返します。 これには、開発者が参加したすべてのレベル、課題、およびステージが含まれ、各詳細なメトリックが含まれます。 このエンドポイントは、レポート期間 (1、7、または 30 日) または特定の日付範囲でランキングを返すこともできます。 結果は、開発者の電子メール、開発者のタグ、およびチーム名に基づいてフィルター処理できます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トーナメント ID
|
tournament_id | True | string |
トーナメント ID |
|
report_period_in_days
|
report_period_in_days | integer |
レポートする過去の日数 (有効な値 - 1、7、および 30 日) |
|
|
startdate
|
startdate | string |
開発者ランキングは、指定された時間以降に完了しました。 形式: YYYY-MM-DDTHH:mm:ss.SSSZ |
|
|
enddate
|
enddate | string |
開発者ランキングは、指定された時間以前に完了しました。 形式: YYYY-MM-DDTHH:mm:ss.SSSZ |
|
|
ユーザー
|
users | string |
ランキングに含めるユーザー (コンマで区切られた 1 つ以上のユーザー電子メール) |
|
|
team_names
|
team_names | string |
チーム名 (コンマで区切られた 1 つ以上のチーム名) |
|
|
tags
|
tags | string |
ユーザー タグ (コンマで区切られた 1 つ以上のユーザー タグ) |
|
|
page
|
page | integer |
結果のページ番号 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ランキング
|
leaderboard | array of TournamentParticipant | |
|
total_pages
|
links.total_pages | integer |
結果に含まれるページの合計数 |
|
results_per_page
|
links.results_per_page | integer |
各ページの結果の最大数 |
|
next_page
|
links.next_page | integer |
次のページのページ番号 (存在する場合) |
|
prev_page
|
links.prev_page | integer |
前のページのページ番号 (存在する場合) |
|
total_results
|
links.total_results | integer |
結果の合計数 |
トーナメントを取得する
このエンドポイントは、社内のトーナメントの一覧を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ページ
|
page | integer |
結果のページ番号 |
|
|
トーナメント名
|
name | string |
トーナメント名 |
|
|
開始日
|
startdate | date-time |
指定された時間以降に開始するトーナメントのみを返します。 形式: YYYY-MM-DDTHH:mm:ss.SSSZ |
|
|
終了日
|
enddate | date-time |
指定された時間以前に終了するトーナメントのみを返します。 時刻: YYYY-MM-DDTHH:mm:ss.SSSZ |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
トーナメント
|
tournaments | array of Tournament | |
|
total_pages
|
links.total_pages | integer |
結果に含まれるページの合計数 |
|
results_per_page
|
links.results_per_page | integer |
各ページの結果の最大数 |
|
next_page
|
links.next_page | integer |
次のページのページ番号 (存在する場合) |
|
prev_page
|
links.prev_page | integer |
前のページのページ番号 (存在する場合) |
|
total_results
|
links.total_results | integer |
結果の合計数 |
ユーザーの取得
これは、単一のユーザー レコードを取得するために使用されます。 応答は、返す属性名を一覧表示するフィールド クエリ パラメーターを渡すことによって形成できます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ID
|
id | True | string |
ユーザー リソース ID。 |
|
ID タイプ
|
idtype | string |
URL 内のユーザー ID の種類を分類するために使用されます。 |
|
|
フィールド
|
fields | string |
フィールドの配列。 フィルターで指定された属性のみを返します。 各属性はコンマで区切る必要があります。 |
戻り値
- ユーザー データ
- UserData
ユーザーの検索
これは、すべてのユーザー レコードを取得するために使用されます。 応答は、返す属性名を一覧表示するフィールド クエリ パラメーターを渡すことによって形成できます。 フィルターは、フィルター条件を本体に通すことによって実現されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
フィールド
|
fields | string |
フィールドの配列。 提供された属性のみを返します。 各属性はコンマで区切る必要があります。 |
|
|
ページ
|
page | integer |
ページ分割された結果セットの指定されたページ番号を返します。 ページ サイズは 1000 レコードです。 |
|
|
id
|
id | string |
ユーザー リソース ID |
|
|
email
|
string |
ユーザーのメール |
||
|
役割
|
role | string |
開発者、チーム マネージャー、または会社管理者のいずれかであるユーザーに割り当てられたロール |
|
|
team
|
team | string |
ユーザーが関連付けられているチーム |
|
|
tags
|
tags | array of string |
ユーザーに関する識別情報。 例: 本社、アジア太平洋 |
戻り値
UserData の一覧
- ユーザーの一覧
- UsersList
ユーザーを作成する
ユーザーを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
招待状の送信
|
sendInvite | boolean |
ユーザーの招待と招待のリマインダーを無効にするフラグ。 |
|
|
enabled
|
enabled | boolean |
プラットフォームでのユーザー ステータス |
|
|
email
|
True | string |
ユーザーのメール |
|
|
isProfileComplete
|
isProfileComplete | boolean |
必要に応じて、プロファイルの完了に必要なプロパティを変換します。 必要に応じて true プロパティ「name.first」および「name.last」に設定されている場合、それ以外の場合、名前はオプションです |
|
|
first
|
first | string |
ユーザーの名。 「isProfileComplete」が true に設定されている場合は必須 |
|
|
ミドル
|
middle | string |
ユーザー ミドル ネーム |
|
|
last
|
last | string |
ユーザーの姓。 「isProfileComplete」が true に設定されている場合は必須 |
|
|
役割
|
role | True | string |
開発者、チーム マネージャー、または会社管理者のいずれかであるユーザーに割り当てられたロール |
|
team
|
team | string |
ユーザーが関連付けられているチーム |
|
|
tags
|
tags | array of string |
ユーザーに関する識別情報。 例: 本社、アジア太平洋 |
|
|
_id
|
_id | string |
言語 ID |
|
|
_framework
|
_framework | string |
言語フレームワーク |
戻り値
- ユーザーを作成
- UserCreated
ユーザーを削除
指定された ID で参照されているユーザーを削除します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ID
|
id | True | string |
ユーザー リソース ID。 |
戻り値
- ユーザーの削除
- UserDeleted
ユーザーを取得
これは、すべてのユーザー レコードを取得するために使用されます。 応答は、返す属性名を一覧表示するフィールド クエリ パラメーターを渡すことによって形成できます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
フィールド
|
fields | string |
フィールドの配列。 提供された属性のみを返します。 各属性はコンマで区切る必要があります。 |
|
|
ページ
|
page | integer |
ページ分割された結果セットの指定されたページ番号を返します。 ページ サイズは 1000 レコードです。 |
戻り値
UserData の一覧
- ユーザーの一覧
- UsersList
ユーザーを更新
指定されたデータでユーザーを更新します。 タグは置き換えられます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ID
|
id | True | string |
ユーザー リソース ID。 |
|
SSO の場合は通知をスキップ
|
skipNotifyIfSso | boolean |
ユーザーに送信される電子メール通知の変更を無効にするために使用されます。 |
|
|
email
|
ユーザーの電子メール アドレス |
|||
|
enabled
|
enabled | boolean |
プラットフォームでのユーザー ステータス |
|
|
役割
|
role | string |
開発者、チーム マネージャー、または会社管理者のいずれかであるユーザーに割り当てられたロール |
|
|
team
|
team | string |
ユーザーが関連付けられているチーム |
|
|
tags
|
tags | array of string |
ユーザーに関する識別情報。 例: 本社、アジア太平洋 |
|
|
_id
|
_id | string |
言語 ID |
|
|
_framework
|
_framework | string |
言語フレームワーク |
戻り値
- ユーザーの更新
- UserUpdated
リソースを取得する
学習リソースの一覧
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
リソース
|
resources | array of Resource |
学習進行状況を検索する
学習の説明フィルター - ユーザー、チームおよびタグ
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー
|
users | string |
学習の進行状況に含めるユーザー (コンマで区切られた 1 つ以上のユーザー電子メール) |
|
|
team_names
|
team_names | string |
チーム名 (コンマで区切られた 1 つ以上のチーム名) |
|
|
tags
|
tags | string |
ユーザー タグ (コンマで区切られた 1 つ以上のユーザー タグ) |
|
|
page
|
page | integer |
結果のページ番号 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
開発者
|
developers | array of ResourceRecord | |
|
total_pages
|
links.total_pages | integer |
結果に含まれるページの合計数 |
|
results_per_page
|
links.results_per_page | integer |
各ページの結果の最大数 |
|
next_page
|
links.next_page | integer |
次のページのページ番号 (存在する場合) |
|
prev_page
|
links.prev_page | integer |
前のページのページ番号 (存在する場合) |
|
total_results
|
links.total_results | integer |
結果の合計数 |
完了、読み取り、または視聴した学習リソースを表示する
学習の説明
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ページ
|
page | integer |
結果のページ番号 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
開発者
|
developers | array of ResourceRecord | |
|
total_pages
|
links.total_pages | integer |
結果に含まれるページの合計数 |
|
results_per_page
|
links.results_per_page | integer |
各ページの結果の最大数 |
|
next_page
|
links.next_page | integer |
次のページのページ番号 (存在する場合) |
|
prev_page
|
links.prev_page | integer |
前のページのページ番号 (存在する場合) |
|
total_results
|
links.total_results | integer |
結果の合計数 |
所要時間を取得する
評価、学習、トーナメント、トレーニング全体でプラットフォームに費やした時間。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ページ
|
page | integer |
結果のページ番号 |
|
|
ID
|
id | string |
UUID 形式のユーザー ID に基づいて結果をフィルター処理する |
|
|
Email
|
string |
電子メールに基づいて結果をフィルター処理する |
||
|
タグ
|
tags | string |
結果ベースをフィルター処理して、タグを持つユーザーを表示します。 指定されたタグはコンマで区切られ、OR ロジックを使用して結果をフィルター処理します。 |
|
|
チーム
|
team | string |
結果をフィルター処理して、ユーザーが指定されたチームに属していることを示す |
|
|
開始日
|
startdate | date-time |
結果をフィルター処理して、1 日の始まりからの結果を含みます。 日付の形式 'YYYY-MM-DD'。 UTC 内 |
|
|
終了日
|
enddate | date-time |
結果をフィルター処理して、1 日の終わりまでのすべての結果を含みます。 日付の形式 'YYYY-MM-DD'。 UTC 内 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ユーザー
|
users | array of UsersTimeSpent | |
|
total_pages
|
links.total_pages | integer |
結果に含まれるページの合計数 |
|
results_per_page
|
links.results_per_page | integer |
各ページの結果の最大数 |
|
next_page
|
links.next_page | integer |
次のページのページ番号 (存在する場合) |
|
prev_page
|
links.prev_page | integer |
前のページのページ番号 (存在する場合) |
|
total_results
|
links.total_results | integer |
結果の合計数 |
最も関わりのあるチーム活動を取得する
このエンドポイントは、最も関わりのある上位「N」チームを返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
報告期間
|
report_period | integer |
最も関わりのあるチームを表示する日数 (report_period は、単独で、または enddate とともに指定する必要があります) |
|
|
開始日
|
startdate | string |
日付範囲の開始日 (report_period で指定しないでください)。 形式: YYYY-MM-DDTHH:mm:ss.SSSZ |
|
|
終了日
|
enddate | string |
日付範囲の終了日 (startdate よりも大きくする必要があります)。 形式: YYYY-MM-DDTHH:mm:ss.SSSZ |
|
|
チームの数
|
number_of_teams | integer |
チームの上位「N」の数 |
|
|
タグ
|
tags | string |
ユーザー タグ |
|
|
ページ
|
page | integer |
結果のページ番号 |
戻り値
社内で最も関わりのあるチーム
- 本文
- MostEngagedTeams
最も関わりのあるユーザー活動を取得する
このエンドポイントは、最も関わりのある上位「N」ユーザーを返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
報告期間
|
report_period | integer |
最も関わりのあるユーザーを表示する日数 (report_period は、単独で、または enddate とともに指定する必要があります) |
|
|
開始日
|
startdate | string |
日付範囲の開始日 (report_period で指定しないでください)。 形式: YYYY-MM-DDTHH:mm:ss.SSSZ |
|
|
終了日
|
enddate | string |
日付範囲の終了日 (startdate よりも大きくする必要があります)。 形式: YYYY-MM-DDTHH:mm:ss.SSSZ |
|
|
ユーザー数
|
number_of_users | integer |
ユーザーの上位「N」の数 |
|
|
チーム名
|
team_name | string |
チーム名 |
|
|
タグ
|
tags | string |
ユーザー タグ |
|
|
ページ
|
page | integer |
結果のページ番号 |
戻り値
社内で最も関わりのあるユーザー
- 本文
- MostEngagedUsers
検索コースの開発者の進行状況
このエンドポイントは、組織内のすべての開発者のコースス進行状況を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ぺージ
|
page | integer |
結果のページ番号 |
|
|
course_id
|
course_id | array of uuid |
コース ID の配列 |
|
|
user_id
|
user_id | array of uuid |
ユーザー リソース ID の配列 |
|
|
ステータス
|
status | string |
コース ステータス |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
データ
|
data | array of object | |
|
user_id
|
data.user_id | string |
ユーザー リソース ID |
|
ステータス
|
data.status | string |
コース ステータス |
|
正確性
|
data.accuracy | integer |
正しい試行の割合 |
|
信頼度
|
data.confidence | integer |
使用可能なヒントに対する使用されたヒットの比率 |
|
minutes_spent
|
data.minutes_spent | integer |
ユーザーがコースに費やした分単位での合計時間 |
|
first_completed_date
|
data.first_completed_date | date-time |
最初のコース言語が完了した日付 |
|
first_enrolled_date
|
data.first_enrolled_date | date-time |
最初のコース言語が登録された日付 |
|
進行状況
|
data.progress | integer |
コースの進行状況 |
|
言語
|
data.languages | array of CourseDeveloperProgressLanguageEntry |
コースの言語の一覧 |
|
招待
|
data.invites | array of CourseDeveloperProgressInviteEntry |
招待とアラームの一覧 |
|
total_pages
|
links.total_pages | integer |
結果に含まれるページの合計数 |
|
results_per_page
|
links.results_per_page | integer |
各ページの結果の最大数 |
|
next_page
|
links.next_page | integer |
次のページのページ番号 (存在する場合) |
|
prev_page
|
links.prev_page | integer |
前のページのページ番号 (存在する場合) |
|
total_results
|
links.total_results | integer |
結果の合計数 |
検索評価
このエンドポイントは、評価に関連するデータポイントの範囲を含む評価オブジェクトの一覧を返します。 これには、他の評価 API エンドポイントと組み合わせて使用できる評価 ID が含まれます。 結果は、状態、名前、サポートされている言語、難易度に基づいてフィルター処理できます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ステータス
|
status | string |
評価の状態 |
|
|
name
|
name | string |
評価名 |
|
|
_id
|
_id | string |
言語 ID |
|
|
_framework
|
_framework | string |
言語フレームワーク |
|
|
難易度
|
difficulty | string |
評価の難易度 |
|
|
page
|
page | integer |
結果のページ番号 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
評価
|
assessments | array of Assessment | |
|
total_pages
|
links.total_pages | integer |
結果に含まれるページの合計数 |
|
results_per_page
|
links.results_per_page | integer |
各ページの結果の最大数 |
|
next_page
|
links.next_page | integer |
次のページのページ番号 (存在する場合) |
|
prev_page
|
links.prev_page | integer |
前のページのページ番号 (存在する場合) |
|
total_results
|
links.total_results | integer |
結果の合計数 |
検索評価の試行
このエンドポイントは、指定された ID で評価を受けたすべての開発者の詳細なレポートを返します。 レポートの範囲は、さまざまな方法でフィルター処理できます。 クエリで電子メール アドレスを指定することにより、指定された開発者に結果をフィルター処理できます。 状態が提供されている場合、指定された状態の評価試行のみが含まれます。 チーム名が提供されている場合、それらのチーム内のユーザーの評価試行のみが含まれます。 タグが提供されている場合、それらのタグでのユーザーの評価試行のみが含まれます。 pass_status が提供されている場合、指定された pass_status での評価試行のみが含まれます。 これには、概要レポートのすべてのデータに加えて、評価の一部であるすべての課題の詳細が含まれます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
assessment_id
|
assessment_id | string |
評価 ID |
|
|
name
|
name | string |
評価名 |
|
|
ユーザー
|
users | string |
評価を試みるユーザー (コンマで区切られた 1 つ以上のユーザー電子メール) |
|
|
ステータス
|
status | string |
評価試行の状態 |
|
|
team_names
|
team_names | string |
チーム名 (コンマで区切られた 1 つ以上のチーム名) |
|
|
tags
|
tags | string |
ユーザー タグ (コンマで区切られた 1 つ以上のユーザー タグ) |
|
|
pass_status
|
pass_status | string |
評価試行の合格の状態 |
|
|
page
|
page | integer |
結果のページ番号 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
試行
|
attempts | array of object |
試行 |
|
ID
|
attempts._id | string |
評価試行 ID |
|
評価
|
attempts._assessment | string |
それが属する評価 |
|
評価名
|
attempts.name | string |
評価名 |
|
名称
|
attempts.developer.name | string |
開発者の名前 (名 + ミドル + 姓)。 |
|
Email
|
attempts.developer.email | string |
開発者のメール アドレス。 |
|
以来のメンバー
|
attempts.developer.member_since | string |
開発者がメンバーになった日付。 |
|
最後のログイン
|
attempts.developer.last_logged_in | string |
開発者が最後にログインした日付。 |
|
Status
|
attempts.developer.status | string |
開発者アカウントの現在の状態。 |
|
会社
|
attempts.developer.company | string |
開発者が所属する会社名。 |
|
チーム
|
attempts.developer.team | string |
開発者が所属するチーム名。 |
|
tags
|
attempts.developer.tags | array of string |
tags |
|
ロール
|
attempts.developer.roles | array of string |
ロール |
|
Status
|
attempts.status | string |
保留中、進行中、完了、または「到達不能」の可能性がある課題/評価の状態を示します。 |
|
言語
|
attempts.language | string |
評価の言語/フレームワーク。 null 値 = 複数の言語をサポートする評価のために選択されていない言語/フレームワーク。 |
|
開始済み
|
attempts.started | string |
評価が開始された日時。 |
|
完成
|
attempts.completed | string |
評価が完了された日時 |
|
期限
|
attempts.deadline | string |
評価期限の日時。 評価に時間制限がない場合、期限は null 値になります。 |
|
スコア
|
attempts.score | integer |
% で評価のスコア。 |
|
で完了
|
attempts.completed_in | string |
評価の試行を完了するのにかかった時間。 |
|
合格グレード
|
attempts.passing_grade | integer |
評価に合格するために必要なパーセンテージ。 |
|
合格の状態
|
attempts.pass_status | string |
評価の合格の状態。 |
|
修正
|
attempts.progress.correct | integer |
正しい課題の数。 |
|
不正解です
|
attempts.progress.incorrect | integer |
正しくない課題の数。 |
|
課題数
|
attempts.progress.number_of_challenges | integer |
課題の合計数。 |
|
完成
|
attempts.progress.completed | integer |
評価が完了された日時。 |
|
場所
|
attempts.accuracy.located | integer |
見つかった脆弱性の % |
|
識別子
|
attempts.accuracy.identified | integer |
脆弱性識別子の % |
|
修正済み
|
attempts.accuracy.fixed | integer |
修正済み脆弱性の % |
|
課題
|
attempts.challenges | array of object |
課題 |
|
数値
|
attempts.challenges.number | integer |
数値 |
|
category
|
attempts.challenges.category | string |
category |
|
subcategory
|
attempts.challenges.subcategory | string |
subcategory |
|
難易度
|
attempts.challenges.difficulty | string |
難易度 |
|
ステータス
|
attempts.challenges.status | string |
ステータス |
|
max_score
|
attempts.challenges.max_score | integer |
max_score |
|
スコア
|
attempts.challenges.score | integer |
スコア |
|
ステータス
|
attempts.challenges.locate.status | string |
ステータス |
|
ステータス
|
attempts.challenges.identify.status | string |
ステータス |
|
ステータス
|
attempts.challenges.fix.status | string |
ステータス |
|
合計ページ数
|
links.total_pages | integer |
結果に含まれるページの合計数。 |
|
ページごとの結果
|
links.results_per_page | integer |
各ページの結果の最大数。 |
|
次のページ
|
links.next_page | integer |
次のページのページ番号 (存在する場合)。 |
|
前のページ
|
links.prev_page | integer |
前のページのページ番号 (存在する場合)。 |
|
合計結果数
|
links.total_results | integer |
結果の合計数。 |
活動の上位担当者を取得する
これは上位担当者ユーザーの一覧を取得するために使用されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
報告期間
|
report_period | integer |
統計の変化を表示する日数 |
|
|
ユーザー数
|
num_users | integer |
返される上位担当者の数 |
|
|
ページ
|
page | integer |
結果のページ番号 |
|
|
タグ
|
tags | string |
結果をフィルター処理して、指定したタグの上位担当者を表示します。 指定されたタグはコンマで区切られ、OR ロジックを使用して結果をフィルター処理します。 |
|
|
チーム
|
team | string |
結果をフィルター処理して、特定のチームの上位担当者を表示する |
|
|
開始日時
|
starttime | date-time |
指定された時間以降に完了した進行状況からのポイントが含まれます。 形式: YYYY-MM-DDTHH:mm:ss.SSSZ |
|
|
終了日時
|
endtime | date-time |
指定された時間以前に完了した進行状況からのポイントが含まれます。 形式: YYYY-MM-DDTHH:mm:ss.SSSZ |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
スキーマ
|
schema | TopPerformers |
上位担当者の一覧 |
活動の長所と短所を取得する
このエンドポイントは、特定の言語またはすべての言語について、会社、チーム、またはユーザーの平均的な長所と短所 (クエリの粒度のレベルに応じて) を返す
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ターゲットの種類
|
targetType | string |
ターゲットの種類。 API キーのスコープに応じた既定値。 レポート キーの既定値は会社です。 チーム キーの既定値はチームです。 |
|
|
ターゲット識別子
|
targetIdentifier | string |
ターゲット識別子 (チーム名、ユーザーの電子メール、またはユーザー ID) |
|
|
言語 ID
|
languageId | string |
言語 ID |
|
|
言語フレームワーク
|
languageFramework | string |
言語フレームワーク |
|
|
ページ
|
page | integer |
結果のページ番号 |
戻り値
平均的な長所と短所のオブジェクト
評価の試行を取得する
このエンドポイントは、指定された ID で評価を受けたすべての開発者の詳細なレポートを返します。 レポートの範囲は、さまざまな方法でフィルター処理できます。 クエリで電子メール アドレスを指定することにより、指定された開発者に結果をフィルター処理できます。 開始日が提供されている場合、この日付以降 (および含む) に開始または完了した試行のみが含まれます。 終了日が提供されている場合、この日付より前に開始または完了した課題のみが含まれます。 両方を指定すると、フィルターを適用する日付範囲が示されます。 これには、概要レポートのすべてのデータに加えて、評価の一部であるすべての課題の詳細が含まれます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
評価 ID
|
assessment_id | True | string |
評価 ID |
|
ページ
|
page | integer |
結果のページ番号 |
|
|
開発者の電子メール
|
developer | string |
フィルターを適用する開発者のメール アドレス |
|
|
開始日
|
startdate | date-time |
指定された日付以降に開始された返却の試行のみ。 形式: YYYY-MM-DDTHH:mm:ss.SSSZ |
|
|
終了日
|
enddate | date-time |
指定された日付以前に開始または完了された返却の試行のみ。 形式: YYYY-MM-DDTHH:mm:ss.SSSZ |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
試行
|
attempts | array of object |
試行 |
|
ID
|
attempts._id | string |
評価試行 ID |
|
テスト
|
attempts._assessment | string |
それが属する評価 |
|
評価名
|
attempts.name | string |
評価名 |
|
名称
|
attempts.developer.name | string |
開発者の名前 (名 + ミドル + 姓)。 |
|
Email
|
attempts.developer.email | string |
開発者のメール アドレス。 |
|
以来のメンバー
|
attempts.developer.member_since | string |
開発者がメンバーになった日付。 |
|
最後のログイン
|
attempts.developer.last_logged_in | string |
開発者が最後にログインした日付。 |
|
Status
|
attempts.developer.status | string |
開発者アカウントの現在の状態。 |
|
会社
|
attempts.developer.company | string |
開発者が所属する会社名。 |
|
チーム
|
attempts.developer.team | string |
開発者が所属するチーム名。 |
|
tags
|
attempts.developer.tags | array of string |
tags |
|
ロール
|
attempts.developer.roles | array of string |
ロール |
|
Status
|
attempts.status | string |
保留中、進行中、完了、または「到達不能」の可能性がある課題/評価の状態を示します。 |
|
言語
|
attempts.language | string |
評価の言語/フレームワーク。 null 値 = 複数の言語をサポートする評価のために選択されていない言語/フレームワーク。 |
|
開始済み
|
attempts.started | string |
評価が開始された日時。 |
|
完成
|
attempts.completed | string |
評価が完了された日時 |
|
期限
|
attempts.deadline | string |
評価期限の日時。 評価に時間制限がない場合、期限は null 値になります。 |
|
スコア
|
attempts.score | integer |
% で評価のスコア。 |
|
で完了
|
attempts.completed_in | string |
評価の試行を完了するのにかかった時間。 |
|
合格グレード
|
attempts.passing_grade | integer |
評価に合格するために必要なパーセンテージ。 |
|
合格の状態
|
attempts.pass_status | string |
評価の合格の状態。 |
|
修正
|
attempts.progress.correct | integer |
正しい課題の数。 |
|
不正解です
|
attempts.progress.incorrect | integer |
正しくない課題の数。 |
|
課題数
|
attempts.progress.number_of_challenges | integer |
課題の合計数。 |
|
完成
|
attempts.progress.completed | integer |
評価が完了された日時。 |
|
場所
|
attempts.accuracy.located | integer |
見つかった脆弱性の % |
|
識別子
|
attempts.accuracy.identified | integer |
脆弱性識別子の % |
|
修正済み
|
attempts.accuracy.fixed | integer |
修正済み脆弱性の % |
|
課題
|
attempts.challenges | array of object |
課題 |
|
数値
|
attempts.challenges.number | integer |
数値 |
|
category
|
attempts.challenges.category | string |
category |
|
subcategory
|
attempts.challenges.subcategory | string |
subcategory |
|
難易度
|
attempts.challenges.difficulty | string |
難易度 |
|
ステータス
|
attempts.challenges.status | string |
ステータス |
|
max_score
|
attempts.challenges.max_score | integer |
max_score |
|
スコア
|
attempts.challenges.score | integer |
スコア |
|
ステータス
|
attempts.challenges.locate.status | string |
ステータス |
|
ステータス
|
attempts.challenges.identify.status | string |
ステータス |
|
ステータス
|
attempts.challenges.fix.status | string |
ステータス |
|
合計ページ数
|
links.total_pages | integer |
結果に含まれるページの合計数。 |
|
ページごとの結果
|
links.results_per_page | integer |
各ページの結果の最大数。 |
|
次のページ
|
links.next_page | integer |
次のページのページ番号 (存在する場合)。 |
|
前のページ
|
links.prev_page | integer |
前のページのページ番号 (存在する場合)。 |
|
合計結果数
|
links.total_results | integer |
結果の合計数。 |
評価を割り当てる
このエンドポイントは、指定された評価を特定のユーザー/チームに割り当てます。 電子メール、inviteUrl、および招待電子メールが送信されたかどうかを示すステータスとともに、評価に割り当てられたユーザーのリストを返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
評価 ID
|
assessment_id | True | string |
評価 ID |
|
users
|
users | array of string |
評価を割り当てるユーザーの一覧 |
|
|
チーム
|
teams | array of string |
評価を割り当てるチームの一覧 |
|
|
sendEmail
|
sendEmail | boolean |
評価の割り当て時に評価招待メールが送信されたかどうかを示すフラグ (既定: true) |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
assessmentInvitations
|
assessmentInvitations | array of AssessmentAssignResponse |
評価を取得する
このエンドポイントは、評価に関連するデータポイントの範囲を含む評価オブジェクトの一覧を返します。 これには、他の評価 API エンドポイントと組み合わせて使用できる評価 ID が含まれます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ページ
|
page | integer |
結果のページ番号 |
|
|
開始日
|
startdate | date-time |
指定された日付以降に開始された返却の評価のみ。 形式: YYYY-MM-DDTHH:mm:ss.SSSZ |
|
|
終了日
|
enddate | date-time |
指定された日付以前に開始または完了された返却の評価のみ。 形式: YYYY-MM-DDTHH:mm:ss.SSSZ |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
評価
|
assessments | array of Assessment | |
|
total_pages
|
links.total_pages | integer |
結果に含まれるページの合計数 |
|
results_per_page
|
links.results_per_page | integer |
各ページの結果の最大数 |
|
next_page
|
links.next_page | integer |
次のページのページ番号 (存在する場合) |
|
prev_page
|
links.prev_page | integer |
前のページのページ番号 (存在する場合) |
|
total_results
|
links.total_results | integer |
結果の合計数 |
開発者の進行状況を取得する
このエンドポイントは、組織内のすべての開発者のトレーニングの進行状況と、現在の領域、レベル、およびクエストの進行状況を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ページ
|
page | integer |
結果のページ番号 |
戻り値
これには、言語、領域、レベル、およびクエストのそれぞれにおける各開発者の進行状況が含まれる
- 開発者の進行状況
- DevelopersProgress
開発者ランキングを取得する
このエンドポイントは、組織内のすべての開発者の一覧と、現時点のの統計、およびレポート期間 (1、7、または 30 日) の統計の変化を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
報告期間
|
report_period | integer |
統計の変化を表示する日数 |
|
|
ページ
|
page | integer |
結果のページ番号 |
|
|
開始日
|
startdate | date-time |
指定された時間以降に完了したランキングからのポイントが含まれます。 形式: YYYY-MM-DDTHH:mm:ss.SSSZ |
|
|
終了日
|
enddate | date-time |
指定された時間以前に完了したランキングからのポイントが含まれます。 形式: YYYY-MM-DDTHH:mm:ss.SSSZ |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ランキング
|
leaderboard | array of object |
ランキング |
|
順位
|
leaderboard.rank | integer |
トーナメント内の参加者の最終位置。 |
|
名称
|
leaderboard.developer.name | string |
開発者の名前 (名 + ミドル + 姓) |
|
Email
|
leaderboard.developer.email | string |
開発者のメール アドレス。 |
|
以来のメンバー
|
leaderboard.developer.member_since | string |
開発者がメンバーになった日付。 |
|
最後のログイン
|
leaderboard.developer.last_logged_in | string |
開発者が最後にログインした日付。 |
|
Status
|
leaderboard.developer.status | string |
開発者アカウントの現在の状態。 |
|
会社
|
leaderboard.developer.company | string |
開発者が所属する会社名 |
|
チーム
|
leaderboard.developer.team | string |
開発者が所属するチーム名。 |
|
tags
|
leaderboard.developer.tags | array of string |
tags |
|
ロール
|
leaderboard.developer.roles | array of string |
ロール |
|
ブロック済み
|
leaderboard.blocked | boolean |
この参加者がトーナメントからブロックされたかどうか。 |
|
費やした分
|
leaderboard.minutes_spent | integer |
開発者が回答に費やした時間 (分)。 |
|
言語
|
leaderboard.language | string |
参加者が使用した言語/フレームワーク。 |
|
最大ポイント数
|
leaderboard.max_points | integer |
トーナメントで使用可能なポイントの最大数 |
|
ポイント
|
leaderboard.points | integer |
参加者が獲得したポイント数。 |
|
使用されたヒント
|
leaderboard.hints_used | integer |
参加者が使用したヒントの数。 |
|
失われた命
|
leaderboard.lives_lost | integer |
トーナメント中に参加者が失った命の数。 |
|
レベル
|
leaderboard.levels | array of object |
レベル |
|
name
|
leaderboard.levels.name | string |
name |
|
課題
|
leaderboard.levels.challenges | array of object |
課題 |
|
数値
|
leaderboard.levels.challenges.number | integer |
数値 |
|
category
|
leaderboard.levels.challenges.category | string |
category |
|
subcategory
|
leaderboard.levels.challenges.subcategory | string |
subcategory |
|
難易度
|
leaderboard.levels.challenges.difficulty | string |
難易度 |
|
ステータス
|
leaderboard.levels.challenges.status | string |
ステータス |
|
max_points
|
leaderboard.levels.challenges.max_points | integer |
max_points |
|
ポイント
|
leaderboard.levels.challenges.points | integer |
ポイント |
|
codebase_size
|
leaderboard.levels.challenges.codebase_size | string |
codebase_size |
|
minutes_spent
|
leaderboard.levels.challenges.minutes_spent | integer |
minutes_spent |
|
ステージ
|
leaderboard.levels.challenges.stages | array of object |
ステージ |
|
数値
|
leaderboard.levels.challenges.stages.number | integer |
数値 |
|
name
|
leaderboard.levels.challenges.stages.name | string |
name |
|
ステータス
|
leaderboard.levels.challenges.stages.status | string |
ステータス |
|
ポイント
|
leaderboard.levels.challenges.stages.points | integer |
ポイント |
|
max_points
|
leaderboard.levels.challenges.stages.max_points | integer |
max_points |
|
minutes_spent
|
leaderboard.levels.challenges.stages.minutes_spent | integer |
minutes_spent |
|
lives_lost
|
leaderboard.levels.challenges.stages.lives_lost | integer |
lives_lost |
|
hints_used
|
leaderboard.levels.challenges.stages.hints_used | integer |
hints_used |
|
合計ページ数
|
links.total_pages | integer |
結果に含まれるページの合計数 |
|
ページごとの結果
|
links.results_per_page | integer |
各ページの結果の最大数。 |
|
次のページ
|
links.next_page | integer |
次のページのページ番号 (存在する場合)。 |
|
前のページ
|
links.prev_page | integer |
前のページのページ番号 (存在する場合)。 |
|
合計結果数
|
links.total_results | integer |
結果の合計数。 |
開発者ランキングを検索する
このエンドポイントは、組織内のすべての開発者の一覧と、現時点のの統計を返します。これには、報告期間 (1、7、または 30 日) または特定の日付範囲での統計の変化も一覧表示されます。 結果は、開発者の電子メール、開発者のタグ、およびチーム名に基づいてフィルター処理できます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
report_period_in_days
|
report_period_in_days | integer |
レポートする過去の日数 (有効な値 - 1、7、および 30 日) |
|
|
startdate
|
startdate | string |
開発者ランキングは、指定された時間以降に完了しました。 形式: YYYY-MM-DDTHH:mm:ss.SSSZ |
|
|
enddate
|
enddate | string |
開発者ランキングは、指定された時間以前に完了しました。 形式: YYYY-MM-DDTHH:mm:ss.SSSZ |
|
|
ユーザー
|
users | string |
ランキングに含めるユーザー (コンマで区切られた 1 つ以上のユーザー電子メール) |
|
|
team_names
|
team_names | string |
チーム名 (コンマで区切られた 1 つ以上のチーム名) |
|
|
tags
|
tags | string |
ユーザー タグ (コンマで区切られた 1 つ以上のユーザー タグ) |
|
|
page
|
page | integer |
結果のページ番号 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ランキング
|
leaderboard | array of object |
ランキング |
|
順位
|
leaderboard.rank | integer |
トーナメント内の参加者の最終位置。 |
|
名称
|
leaderboard.developer.name | string |
開発者の名前 (名 + ミドル + 姓)。 |
|
Email
|
leaderboard.developer.email | string |
開発者のメール アドレス |
|
以来のメンバー
|
leaderboard.developer.member_since | string |
開発者がメンバーになった日付。 |
|
最後のログイン
|
leaderboard.developer.last_logged_in | string |
開発者が最後にログインした日付。 |
|
Status
|
leaderboard.developer.status | string |
開発者アカウントの現在の状態。 |
|
会社
|
leaderboard.developer.company | string |
開発者が所属する会社名。 |
|
チーム
|
leaderboard.developer.team | string |
開発者が所属するチーム名。 |
|
tags
|
leaderboard.developer.tags | array of string |
tags |
|
ロール
|
leaderboard.developer.roles | array of string |
ロール |
|
ブロック済み
|
leaderboard.blocked | boolean |
この参加者がトーナメントからブロックされたかどうか。 |
|
費やした分
|
leaderboard.minutes_spent | integer |
開発者が回答に費やした時間 (分)。 |
|
言語
|
leaderboard.language | string |
参加者が使用した言語/フレームワーク。 |
|
最大ポイント数
|
leaderboard.max_points | integer |
トーナメントで使用可能なポイントの最大数。 |
|
ポイント
|
leaderboard.points | integer |
参加者が獲得したポイント数。 |
|
使用されたヒント
|
leaderboard.hints_used | integer |
参加者が使用したヒントの数。 |
|
失われた命
|
leaderboard.lives_lost | integer |
トーナメント中に参加者が失った命の数。 |
|
レベル
|
leaderboard.levels | array of object |
レベル |
|
name
|
leaderboard.levels.name | string |
name |
|
課題
|
leaderboard.levels.challenges | array of object |
課題 |
|
数値
|
leaderboard.levels.challenges.number | integer |
数値 |
|
category
|
leaderboard.levels.challenges.category | string |
category |
|
subcategory
|
leaderboard.levels.challenges.subcategory | string |
subcategory |
|
難易度
|
leaderboard.levels.challenges.difficulty | string |
難易度 |
|
ステータス
|
leaderboard.levels.challenges.status | string |
ステータス |
|
max_points
|
leaderboard.levels.challenges.max_points | integer |
max_points |
|
ポイント
|
leaderboard.levels.challenges.points | integer |
ポイント |
|
codebase_size
|
leaderboard.levels.challenges.codebase_size | string |
codebase_size |
|
minutes_spent
|
leaderboard.levels.challenges.minutes_spent | integer |
minutes_spent |
|
ステージ
|
leaderboard.levels.challenges.stages | array of object |
ステージ |
|
数値
|
leaderboard.levels.challenges.stages.number | integer |
数値 |
|
name
|
leaderboard.levels.challenges.stages.name | string |
name |
|
ステータス
|
leaderboard.levels.challenges.stages.status | string |
ステータス |
|
ポイント
|
leaderboard.levels.challenges.stages.points | integer |
ポイント |
|
max_points
|
leaderboard.levels.challenges.stages.max_points | integer |
max_points |
|
minutes_spent
|
leaderboard.levels.challenges.stages.minutes_spent | integer |
minutes_spent |
|
lives_lost
|
leaderboard.levels.challenges.stages.lives_lost | integer |
lives_lost |
|
hints_used
|
leaderboard.levels.challenges.stages.hints_used | integer |
hints_used |
|
合計ページ数
|
links.total_pages | integer |
結果に含まれるページの合計数。 |
|
ページごとの結果
|
links.results_per_page | integer |
各ページの結果の最大数。 |
|
次のページ
|
links.next_page | integer |
次のページのページ番号 (存在する場合)。 |
|
前のページ
|
links.prev_page | integer |
前のページのページ番号 (存在する場合)。 |
|
合計結果数
|
links.total_results | integer |
結果の合計数。 |
開発者活動を取得する
このエンドポイントは、組織内のすべての開発者の詳細な課題ログを、開発者の課題スコア、難易度、および課題結果とともに返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ページ
|
page | integer |
結果のページ番号 |
戻り値
指定された期間の課題の詳細なログ
- 開発者活動
- DevelopersActivity
開発者活動を検索する
このエンドポイントは、組織内のすべての開発者の詳細な課題ログを、開発者の課題スコア、難易度、および課題結果とともに返します。 これには、レポート期間 (1、7、または 30 日) または特定の日付範囲にわたる課題ログも一覧表示されます。 結果は、開発者の電子メール、開発者のタグ、およびチーム名に基づいてフィルター処理できます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
report_period_in_days
|
report_period_in_days | integer |
レポートする過去の日数 (有効な値 - 1、7、および 30 日) |
|
|
startdate
|
startdate | string |
開発者課題ログは、指定された時間以降に完了しました。 形式: YYYY-MM-DDTHH:mm:ss.SSSZ |
|
|
enddate
|
enddate | string |
開発者課題ログは、指定された時間以前に完了しました。 形式: YYYY-MM-DDTHH:mm:ss.SSSZ |
|
|
ユーザー
|
users | string |
課題ログに含めるユーザー (コンマで区切られた 1 つ以上のユーザー電子メール) |
|
|
team_names
|
team_names | string |
チーム名 (コンマで区切られた 1 つ以上のチーム名) |
|
|
tags
|
tags | string |
ユーザー タグ (コンマで区切られた 1 つ以上のユーザー タグ) |
|
|
page
|
page | integer |
結果のページ番号 |
戻り値
指定された期間の課題の詳細なログ
- 開発者活動
- DevelopersActivity
開発者進行状況を検索する
このエンドポイントは、組織内のすべての開発者のトレーニングの進行状況と、現在の領域、レベル、およびクエストの進行状況を返します。 これには、レポート期間 (1、7、または 30 日) または特定の日付範囲にわたる開発者進行状況での課題も一覧表示されます。 結果は、開発者の電子メール、開発者のタグ、およびチーム名に基づいてフィルター処理できます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
report_period_in_days
|
report_period_in_days | integer |
レポートする過去の日数 (有効な値 - 1、7、および 30 日) |
|
|
startdate
|
startdate | string |
開発者進行状況は、指定された時間以降に完了しました。 形式: YYYY-MM-DDTHH:mm:ss.SSSZ |
|
|
enddate
|
enddate | string |
開発者進行状況は、指定された時間以前に完了しました。 形式: YYYY-MM-DDTHH:mm:ss.SSSZ |
|
|
ユーザー
|
users | string |
開発者進行状況に含めるユーザー (コンマで区切られた 1 つ以上のユーザー電子メール) |
|
|
team_names
|
team_names | string |
チーム名 (コンマで区切られた 1 つ以上のチーム名) |
|
|
tags
|
tags | string |
ユーザー タグ (コンマで区切られた 1 つ以上のユーザー タグ) |
|
|
page
|
page | integer |
結果のページ番号 |
戻り値
これには、言語、領域、レベル、およびクエストのそれぞれにおける各開発者の進行状況が含まれる
- 開発者の進行状況
- DevelopersProgress
定義
トーナメント
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
_id
|
_id | string |
トーナメントの ID |
|
name
|
name | string |
トーナメントの名前 |
|
description
|
description | string |
トーナメントの説明 |
|
start_time
|
start_time | date-time |
トーナメントが開始する時刻 |
|
end_time
|
end_time | date-time |
トーナメントが終了する時刻 |
|
timezone
|
timezone | string |
トーナメントが開催されているタイムゾーン |
TournamentParticipant
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
順位
|
rank | integer |
トーナメント内の参加者の最終位置 |
|
開発者
|
developer | Developer |
個々の開発者に関する情報 |
|
blocked
|
blocked | boolean |
この参加者がトーナメントからブロックされたかどうか |
|
minutes_spent
|
minutes_spent | integer |
開発者が回答に費やした時間 (分) |
|
language
|
language | string |
参加者が使用した言語/フレームワーク |
|
max_points
|
max_points | integer |
トーナメントで使用可能なポイントの最大数 |
|
ポイント
|
points | integer |
参加者が獲得したポイント数 |
|
hints_used
|
hints_used | integer |
参加者が使用したヒントの数 |
|
lives_lost
|
lives_lost | integer |
トーナメント中に参加者が失った命の数 |
|
レベル
|
levels | array of Level |
課題のレベル |
レベル
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
name
|
name | string |
レベル名 |
|
課題
|
challenges | array of object | |
|
数値
|
challenges.number | integer |
課題番号 (1 から開始) |
|
category
|
challenges.category | string |
課題のカテゴリ |
|
subcategory
|
challenges.subcategory | string |
課題のサブカテゴリ |
|
難易度
|
challenges.difficulty | string | |
|
Status
|
challenges.status | Status |
保留中、進行中、完了、または「到達不能」の可能性がある課題/評価の状態を示す |
|
max_points
|
challenges.max_points | integer |
この課題の使用可能な最大ポイント |
|
ポイント
|
challenges.points | integer |
この課題で獲得したポイント |
|
codebase_size
|
challenges.codebase_size | string | |
|
minutes_spent
|
challenges.minutes_spent | integer |
開発者が回答に費やした時間 (分) |
|
ステージ
|
challenges.stages | array of Stage |
段階
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
数値
|
number | integer |
ステージ番号 |
|
name
|
name | string |
ステージの名前 |
|
ステータス
|
status | string |
このステージでの試行の状態 |
|
ポイント
|
points | integer |
このステージで獲得したポイント |
|
max_points
|
max_points | integer |
このステージで使用可能な最大ポイント |
|
minutes_spent
|
minutes_spent | integer |
開発者が回答に費やした時間 (分) |
|
lives_lost
|
lives_lost | integer |
このステージで失われた命の数 |
|
hints_used
|
hints_used | integer |
このステージで使用されたヒントの数 |
評価
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
_id
|
_id | string |
評価 ID |
|
ステータス
|
status | string |
評価の状態 |
|
name
|
name | string |
評価の名前 |
|
description
|
description | string |
評価の説明 |
|
supported_languages
|
supported_languages | array of string |
評価に使用できる言語/フレームワークの一覧 |
|
難易度
|
difficulty | string |
評価の難易度 |
|
success_ratio
|
success_ratio | integer |
評価に合格するために必要な割合 |
|
emits_certificate
|
emits_certificate | boolean |
評価は証明書にリンクされていますか? |
|
time_limit
|
time_limit | integer |
ミリ秒単位の評価の制限時間。 null 値 = 制限時間なし |
|
start_date
|
start_date | date-time |
評価が開始する日付 |
|
end_date
|
end_date | date-time |
評価が終了する日付 |
|
timezone
|
timezone | string |
評価のタイム ゾーン |
|
number_of_challenges
|
number_of_challenges | integer |
評価内の課題の数 |
|
self_assess
|
self_assess | boolean |
評価は公開評価ですか? |
|
retries_allowed
|
retries_allowed | boolean |
この評価で再試行は許可されていますか? |
Status
preferredDevLanguage
優先する言語の開発
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
_id
|
_id | string |
言語 ID |
|
_framework
|
_framework | string |
言語フレームワーク |
AssessmentAssignResponse
評価への応答は POST 要求を割り当てる
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
user
|
user | string |
ユーザーのメール ID |
|
inviteEmailSent
|
inviteEmailSent | boolean |
招待メールは送信されましたか ? |
|
inviteUrl
|
inviteUrl | string |
評価の招待 URL |
TeamLeaderboard
チーム ランキングには、指定されたレポート期間中に有効なすべてのチーム ランキング エントリが含まれる
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
report_period_in_days
|
report_period_in_days | integer |
レポートする過去の日数 |
|
ランキング
|
leaderboard | array of TeamLeaderboardEntry | |
|
total_pages
|
links.total_pages | integer |
結果に含まれるページの合計数 |
|
results_per_page
|
links.results_per_page | integer |
各ページの結果の最大数 |
|
next_page
|
links.next_page | integer |
次のページのページ番号 (存在する場合) |
|
prev_page
|
links.prev_page | integer |
前のページのページ番号 (存在する場合) |
|
total_results
|
links.total_results | integer |
結果の合計数 |
TeamLeaderboardEntry
チーム ランキングにエントリする
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
順位
|
rank | integer |
ランキングでのチームのランク。 |
|
name
|
name | string |
チームの名前 |
|
開発者
|
developers | integer |
チームの開発者の番号 |
|
points_average
|
points_average | integer |
チームの平均ポイント |
|
points_total
|
points_total | integer |
チームの合計ポイント |
|
正確性
|
accuracy | integer |
チームの精度 (% で) |
|
confidence_level
|
confidence_level | integer |
チームの信頼度 (% で) |
|
time_spent
|
time_spent | integer |
チームが課題に費やした合計分数 |
|
installed_sensei
|
installed_sensei | integer |
先生をインストールしたチーム内の開発者の数 |
|
レポート期間中の統計
|
stats_over_report_period | StatsOverReportPeriod |
指定されたレポート期間に対して計算された統計 |
MostEngagedTeams
社内で最も関わりのあるチーム
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
チーム
|
teams | array of TeamEntry |
チームの詳細 |
|
total_pages
|
links.total_pages | integer |
結果に含まれるページの合計数 |
|
results_per_page
|
links.results_per_page | integer |
各ページの結果の最大数 |
|
next_page
|
links.next_page | integer |
次のページのページ番号 (存在する場合) |
|
prev_page
|
links.prev_page | integer |
前のページのページ番号 (存在する場合) |
|
total_results
|
links.total_results | integer |
結果の合計数 |
TeamEntry
このオブジェクトはチームの詳細を表す
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
name
|
name | string |
チームの名前 |
|
ステータス
|
status | string |
チームの状態 |
|
timeSpent
|
timeSpent | integer |
費やしたチーム時間 |
MostEngagedUsers
社内で最も関わりのあるユーザー
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ユーザー
|
users | array of UserEntry |
ユーザーの詳細 |
|
total_pages
|
links.total_pages | integer |
結果に含まれるページの合計数 |
|
results_per_page
|
links.results_per_page | integer |
各ページの結果の最大数 |
|
next_page
|
links.next_page | integer |
次のページのページ番号 (存在する場合) |
|
prev_page
|
links.prev_page | integer |
前のページのページ番号 (存在する場合) |
|
total_results
|
links.total_results | integer |
結果の合計数 |
UserEntry
このオブジェクトはユーザーの詳細を表す
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
name
|
name | string |
ユーザーの名前 |
|
ステータス
|
status | string |
ユーザーの状態 |
|
timeSpent
|
timeSpent | integer |
ユーザーによる使用時間 |
StatsOverReportPeriod
指定されたレポート期間に対して計算された統計
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
points_gained
|
points_gained | integer |
開発者が獲得したポイント数 |
|
accuracy_change
|
accuracy_change | integer |
報告期間中の精度の変化 |
|
confidence_level_change
|
confidence_level_change | integer |
報告期間中の信頼度の変化 |
|
minutes_spent
|
minutes_spent | integer |
チームが課題に費やした分数 |
|
challenges_correct
|
challenges_correct | integer |
正しい課題の数 |
|
challenges_incorrect
|
challenges_incorrect | integer |
正しくない課題の数 |
開発者
個々の開発者に関する情報
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
name
|
name | string |
開発者の名前 (名 + ミドル + 姓) |
|
email
|
string |
開発者のメール アドレス |
|
|
member_since
|
member_since | date-time |
開発者がメンバーになった日付 |
|
last_logged_in
|
last_logged_in | date-time |
開発者が最後にログインした日付 |
|
ステータス
|
status | string |
開発者アカウントの現在の状態 |
|
company
|
company | string |
開発者が所属する会社名 |
|
team
|
team | string |
開発者が所属するチーム名 |
|
tags
|
tags | array of string |
開発者に関連付けられたタグ |
|
ロール
|
roles | string |
この開発者が持つロール |
DevelopersProgress
これには、言語、領域、レベル、およびクエストのそれぞれにおける各開発者の進行状況が含まれる
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
開発者
|
developers | array of DeveloperProgressEntry |
トレーニングを試行した開発者の一覧 |
|
total_pages
|
links.total_pages | integer |
結果に含まれるページの合計数 |
|
results_per_page
|
links.results_per_page | integer |
各ページの結果の最大数 |
|
next_page
|
links.next_page | integer |
次のページのページ番号 (存在する場合) |
|
prev_page
|
links.prev_page | integer |
前のページのページ番号 (存在する場合) |
|
total_results
|
links.total_results | integer |
結果の合計数 |
DeveloperProgressEntry
このエントリは、開発者の情報とトレーニング モードでの試行の進行状況を含む開発者のトレーニングの進行状況のオブジェクトを表す
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
開発者
|
developer | Developer |
個々の開発者に関する情報 |
|
言語
|
languages | array of TrainingProgressEntry |
開発者がトレーニング モードで試行した言語の一覧 |
TrainingProgressEntry
言語と領域の一覧の完了の進行状況を含むエントリ
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
name
|
name | string |
言語フレームワークの名前 |
|
language_progress
|
language_progress | integer |
完了した言語の割合 |
|
領域
|
realms | array of object |
各言語の領域の一覧 |
|
name
|
realms.name | string |
領域の名前 |
|
realm_progress
|
realms.realm_progress | integer |
完了した領域の割合 |
|
レベル
|
realms.levels | array of object |
各領域のレベルの一覧 |
|
name
|
realms.levels.name | string |
レベルの名前 |
|
level_progress
|
realms.levels.level_progress | integer |
完了したレベルの割合 |
|
クエスト
|
realms.levels.quests | array of object |
各レベルのクエストの一覧 |
|
name
|
realms.levels.quests.name | string |
クエストの名前 |
|
quest_progress
|
realms.levels.quests.quest_progress | integer |
完了したクエストの割合 |
DevelopersActivity
指定された期間の課題の詳細なログ
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
活動
|
activities | array of ActivityEntry |
課題の試行を含む言語の一覧を含む開発者の一覧 |
|
total_pages
|
links.total_pages | integer |
結果に含まれるページの合計数 |
|
results_per_page
|
links.results_per_page | integer |
各ページの結果の最大数 |
|
next_page
|
links.next_page | integer |
次のページのページ番号 (存在する場合) |
|
prev_page
|
links.prev_page | integer |
前のページのページ番号 (存在する場合) |
|
total_results
|
links.total_results | integer |
結果の合計数 |
ActivityEntry
このオブジェクトは、開発者とその課題の試行を表す
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
開発者
|
developer | Developer |
個々の開発者に関する情報 |
|
課題の試行
|
challenge | ChallengeAttempt |
トレーニング モードでの開発者による試行 |
ChallengeAttempt
トレーニング モードでの開発者による試行
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
language
|
language | string |
言語フレームワークの名前 |
|
領域
|
realm | string |
領域の名前 |
|
レベル
|
level | string |
レベルの名前 |
|
クエスト
|
quest | string |
クエストの名前 |
|
category
|
category | string |
課題のカテゴリ名 |
|
subcategory
|
subcategory | string |
課題のサブカテゴリ名 |
|
難易度
|
difficulty | string |
課題の難易度のレベル |
|
開始済み
|
started | date-time |
時間の課題が開始された |
|
完了済み
|
completed | date-time |
時間の課題が完了された |
|
期間
|
duration | integer |
課題が完了するまでにかかった秒単位の時間 |
|
ステータス
|
status | string |
課題の状態、1 つ以上の正しくないステージでの課題の状態が正しくない |
|
hints_used
|
hints_used | integer |
開発者が使用した課題ステージからのヒントの合計数 |
|
スコア
|
score | integer |
取得ポイント |
|
max_score
|
max_score | string |
課題で達成可能な最大ポイント |
|
脆弱性を選択
|
select_vulnerability | SelectVulnerability |
課題の課題の性質 |
|
脆弱性の検索
|
locate_vulnerability | LocateVulnerability |
課題の課題の性質 |
|
ソリューションを特定する
|
identify_solution | IdentifySolution |
課題の課題の性質 |
SelectVulnerability
課題の課題の性質
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
attempt_index
|
attempt_index | integer |
開発者がステージを試行した回数 |
|
ステータス
|
status | string |
課題の結果、out_of_reach の状態は、開発者がまだ試行していないステージを説明する |
|
max_score
|
max_score | integer |
脆弱性を選択するために達成可能な最大ポイント |
|
スコア
|
score | integer |
脆弱性を選択するために獲得したポイント |
|
スキップ済み
|
skipped | boolean |
True に設定すると、ステージはスキップされます。 ステータスが false の場合、ステージは完了しているか、まだ試行されていない |
LocateVulnerability
課題の課題の性質
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
attempt_index
|
attempt_index | integer |
開発者がステージを試行した回数 |
|
ステータス
|
status | string |
課題の結果 |
|
max_score
|
max_score | integer |
脆弱性を検索するために達成可能な最大ポイント |
|
スコア
|
score | integer |
脆弱性を検索するために獲得したポイント |
IdentifySolution
課題の課題の性質
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
attempt_index
|
attempt_index | integer |
開発者がステージを試行した回数 |
|
ステータス
|
status | string |
課題の結果 |
|
max_score
|
max_score | integer |
ソリューションを特定するために達成可能な最大ポイント |
|
スコア
|
score | integer |
ソリューションを特定するために獲得したポイント |
ResourceItem
リソース項目の詳細
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | string | |
|
name
|
name | string |
リソース
リソースの詳細
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | string | |
|
name
|
name | string | |
|
items
|
items | array of ResourceItem |
CompletedResource
完了済み学習リソースの詳細
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
resource
|
resource | array of string |
完成したリソースの分類と名前の順序指定済みリスト |
|
time_completed
|
time_completed | date-time |
学習リソースが完了したとき |
ResourceRecord
開発者の完了した学習リソースの記録
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
開発者
|
profile | Developer |
個々の開発者に関する情報 |
|
完了済み
|
completed | array of CompletedResource |
ユーザーにより完了したすべての学習リソース |
CourseURL
トレーニング コースへの URL
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
url
|
url | string |
コースへの URL |
TeamData
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
name
|
name | string |
チーム名 |
UserData
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | string |
ユーザーのリソース ID |
|
email
|
string |
ユーザーのメール |
|
|
役割
|
role | string |
開発者、チーム マネージャー、または会社管理者のいずれかであるユーザーに割り当てられたロール |
|
first
|
name.first |
名 |
|
|
ミドル
|
name.middle |
ミドル ネーム |
|
|
last
|
name.last |
姓 |
|
|
ステータス
|
status | string |
ユーザー状態 |
|
招待日
|
invite-date | date-time |
ユーザーが最後に招待された時刻 |
|
前回ログイン日
|
last-login-date | date-time |
ユーザーが最後にログインした時間 |
|
チーム データ
|
team | TeamData | |
|
tags
|
tags | array of string |
ユーザーに関する識別情報。 例: 本社、アジア太平洋 |
|
preferredDevLanguages
|
preferredDevLanguages | array of preferredDevLanguage |
優先する言語の開発 |
UserUpdated
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
statusCode
|
statusCode | integer |
成功応答メッセージの状態コード |
|
message
|
message | string |
成功応答メッセージの説明 |
|
code
|
code | string |
Secure Code Warrior コード |
UserCreated
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | string |
Secure Code Warrior リソース識別子 |
|
statusCode
|
statusCode | integer |
成功応答メッセージの状態コード |
|
message
|
message | string |
成功応答メッセージの説明 |
|
code
|
code | string |
Secure Code Warrior コード |
UserDeleted
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
statusCode
|
statusCode | integer |
成功応答メッセージの状態コード |
|
message
|
message | string |
成功応答メッセージの説明 |
|
code
|
code | string |
Secure Code Warrior コード |
UsersList
UserData の一覧
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ユーザー
|
users | array of UserData |
TopPerformers
上位担当者の一覧
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
report_period_in_days
|
report_period_in_days | integer |
レポートする過去の日数 |
|
top_performers
|
top_performers | array of TopPerformer | |
|
total_pages
|
links.total_pages | integer |
結果に含まれるページの合計数 |
|
results_per_page
|
links.results_per_page | integer |
各ページの結果の最大数 |
|
next_page
|
links.next_page | integer |
次のページのページ番号 (存在する場合) |
|
prev_page
|
links.prev_page | integer |
前のページのページ番号 (存在する場合) |
|
total_results
|
links.total_results | integer |
結果の合計数 |
TopPerformer
上位のパフォーマンス ユーザー
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ポイント
|
points | integer |
一定期間内に獲得した合計ポイント |
|
id
|
id | string |
UUID 形式のユーザー ID |
|
email
|
string |
ユーザー メール |
|
|
first
|
name.first | string |
ユーザーの名 |
|
ミドル
|
name.middle | string |
ユーザー ミドル ネーム |
|
last
|
name.last | string |
ユーザーの姓 |
|
tags
|
tags | array of string |
ユーザー タグ |
|
ステータス
|
status | string |
ユーザー状態 |
|
チーム データ
|
team | TeamData |
UsersTimeSpent
ユーザーの活動を示すエントリ。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | string |
UUID 形式のユーザー ID |
|
email
|
string |
ユーザー メール |
|
|
first
|
name.first | string |
ユーザーの名 |
|
ミドル
|
name.middle | string |
ユーザー ミドル ネーム |
|
last
|
name.last | string |
ユーザーの姓 |
|
tags
|
tags | array of string |
ユーザー タグ |
|
ステータス
|
status | string |
ユーザー状態 |
|
チーム データ
|
team | TeamData | |
|
費やした時間
|
time-spent | array of object |
1 日の費やした時間/活動の内訳を含む日付の配列 |
|
date
|
time-spent.date | date |
UTC での日付 |
|
評価
|
time-spent.activity.Assessments | integer |
評価に費やした時間 |
|
学習
|
time-spent.activity.Learning | integer |
学習に費やした時間 |
|
トーナメント
|
time-spent.activity.Tournaments | integer |
トーナメントに費やした時間 |
|
トレーニング
|
time-spent.activity.Training | integer |
トレーニングに費やした時間 |
StrengthsAndWeaknesses
平均的な長所と短所のオブジェクト
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
auth
|
auth | AverageStrengthsAndWeaknessesEntry |
このオブジェクトは、個々の管理カテゴリを表す |
|
data_handling
|
data_handling | AverageStrengthsAndWeaknessesEntry |
このオブジェクトは、個々の管理カテゴリを表す |
|
misconfig
|
misconfig | AverageStrengthsAndWeaknessesEntry |
このオブジェクトは、個々の管理カテゴリを表す |
|
プラクティス
|
practices | AverageStrengthsAndWeaknessesEntry |
このオブジェクトは、個々の管理カテゴリを表す |
|
sensitive_data
|
sensitive_data | AverageStrengthsAndWeaknessesEntry |
このオブジェクトは、個々の管理カテゴリを表す |
|
その他
|
other | AverageStrengthsAndWeaknessesEntry |
このオブジェクトは、個々の管理カテゴリを表す |
AverageStrengthsAndWeaknessesEntry
このオブジェクトは、個々の管理カテゴリを表す
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
課題
|
challenges | ChallengesEntry |
課題データ |
|
ヒント
|
hints | HintsEntry |
ヒント データ |
|
ポイント
|
points | integer |
ポイント |
|
timeSpent
|
timeSpent | integer |
所要時間 |
ChallengesEntry
課題データ
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
試行済み
|
attempted | integer |
試行済みの課題 |
|
修正
|
correct | integer |
試行済みの修正 |
|
不正解
|
incorrect | integer |
試行済みの不正解 |
|
percentageCorrect
|
percentageCorrect | integer |
正しい割合 |
|
ratioCorrect
|
ratioCorrect | number |
正しい比率 |
HintsEntry
ヒント データ
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
confidenceLevel
|
confidenceLevel | integer |
信頼度レベル |
|
total
|
total | integer |
合計 |
|
使用済
|
used | integer |
使用済み |
TeamDetails
チームの詳細
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | string |
チーム ID |
|
name
|
name | string |
チームの名前 |
|
tags
|
tags | array of string |
チームに関する識別情報。 例: 本社、アジア太平洋、エンジニアリング |
|
onboardingMessage
|
onboardingMessage | string |
チームのオン ボーディング メッセージ |
|
ステータス
|
status | string |
チームの状態 |
|
memberJoinToken
|
memberJoinToken | string |
メンバー参加トークン |
|
companyName
|
companyName | string |
会社の名前。 |
|
言語
|
languages | array of string |
チーム言語 |
TeamDeleteResponse
チーム 削除応答
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
deleteStatus
|
deleteStatus | string |
削除操作の状態 |
コース
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
_id
|
_id | string |
コース ID |
|
name
|
name | string |
コースの名前 |
|
description
|
description | string |
コースの説明 |
|
ステータス
|
status | string |
コースの状態 |
|
supported_languages
|
supported_languages | array of string |
コースに使用できる言語/フレームワークの一覧 |
|
期限
|
deadline | date-time |
コースが終了する日付 |
|
created_by
|
created_by | string |
コースの作成者の ResourceId |
CourseDeveloperProgressEntry
このエントリは、開発者コースの進行状況を表す
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
user_id
|
user_id | string |
ユーザー リソース ID |
|
ステータス
|
status | string |
コース ステータス |
|
正確性
|
accuracy | integer |
正しい試行の割合 |
|
信頼度
|
confidence | integer |
使用可能なヒントに対する使用されたヒットの比率 |
|
minutes_spent
|
minutes_spent | integer |
ユーザーがコースに費やした分単位での合計時間 |
|
first_completed_date
|
first_completed_date | date-time |
最初のコース言語が完了した日付 |
|
first_enrolled_date
|
first_enrolled_date | date-time |
最初のコース言語が登録された日付 |
|
進行状況
|
progress | integer |
コースの進行状況 |
|
言語
|
languages | array of CourseDeveloperProgressLanguageEntry |
コースの言語の一覧 |
|
招待
|
invites | array of CourseDeveloperProgressInviteEntry |
招待とアラームの一覧 |
CourseDeveloperProgressInviteEntry
CourseDeveloperProgressLanguageEntry
このエントリは、単一の言語の開発者コース進行状況を表す
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
language
|
language | string |
プログラミング言語 |
|
ステータス
|
status | string |
コース言語の状態 |
|
正確性
|
accuracy | integer |
言語の正しい試行の割合 |
|
信頼度
|
confidence | integer |
言語の使用可能なヒントに対する使用されたヒントの比率 |
|
minutes_spent
|
minutes_spent | integer |
ユーザーが言語のコースに費やした分単位での合計時間 |
|
進行状況
|
progress | integer |
言語のコースの進行状況 |
|
videos_watched
|
videos_watched | integer |
ユーザーがその言語で視聴した動画の量 |