安全代码战士（独立发布者）（预览版）

此安全代码勇士连接器https://securecodewarrior.com提供对学习平台的编程访问。安全代码勇士使安全编码成为开发人员的积极且引人入胜的体验，因为他们提高了软件安全技能。借助旗舰学习平台，我们引导每个编码者沿着自己的首选学习途径，使安全技能型开发人员成为我们互联世界的日常超级英雄。

此连接器在以下产品和区域中可用：

服务	Class	区域
Copilot Studio	高级	除以下各项外的所有 Power Automate 区域： - 美国政府（GCC） - 美国政府（GCC High） - 由世纪互联运营的中国云 - 美国国防部（DoD）
逻辑应用程序	标准	除以下各项外的所有逻辑应用区域： - Azure 政府区域 - Azure 中国区域 - 美国国防部（DoD）
Power Apps	高级	除以下各项外的所有 Power Apps 区域： - 美国政府（GCC） - 美国政府（GCC High） - 由世纪互联运营的中国云 - 美国国防部（DoD）
Power Automate	高级	除以下各项外的所有 Power Automate 区域： - 美国政府（GCC） - 美国政府（GCC High） - 由世纪互联运营的中国云 - 美国国防部（DoD）

联系人
Name	特洛伊·泰勒
URL	https://www.hitachisolutions.com
Email	ttaylor@hitachisolutions.com

连接器元数据
发布者	Hitachi 解决方案
详细了解安全代码战士	https://docs.microsoft.com/connectors/securecodewarrior
网站	https://www.securecodewarrior.com/
隐私策略	https://www.securecodewarrior.com/trust/privacy-policy
类别	IT作

正在创建连接

连接器支持以下身份验证类型：


默认	用于创建连接的参数。	所有区域	不可共享

违约

适用：所有区域

用于创建连接的参数。

这是不可共享的连接。如果 Power App 与另一个用户共享，系统会提示其他用户显式创建新连接。

Name	类型	Description	必选
API 令牌	securestring	此 API 的 API 令牌	True

限制

名称	调用	续订期
每个连接的 API 调用数	100	60 秒

操作

分配评估	此终结点会将给定的评估分配给指定的用户/团队。返回一个列表，其中包含分配给评估的用户及其电子邮件、inviteUrl 和状态，该列表指示是否发送了邀请电子邮件。
创建团队	这用于创建团队。
创建用户	创建用户。
删除团队	这用于删除团队。
删除用户	删除由给定 ID 引用的用户。
搜索学习进度	学习说明筛选器 - 用户、团队和标记
搜索开发人员排行榜	此终结点返回组织内所有开发人员及其当前统计信息的列表。这还会列出报告期间（可能为 1、7 或 30 天）或给定日期范围的统计信息更改。可以根据开发人员电子邮件、开发人员标记和团队名称筛选结果。
搜索开发人员活动	此终结点返回组织内所有开发人员的详细质询日志，其中包含开发人员的挑战分数、难度和挑战结果。这还会列出报告期间（可能为 1、7 或 30 天）或给定日期范围的质询日志。可以根据开发人员电子邮件、开发人员标记和团队名称筛选结果。
搜索开发人员进度	此终结点返回组织中所有开发人员的培训进度，并具有当前领域、级别和任务进度。这还会列出报表期间（可能为 1、7 或 30 天）或给定日期范围的开发人员进度更改。可以根据开发人员电子邮件、开发人员标记和团队名称筛选结果。
搜索用户	这用于检索所有用户记录。响应可以通过传入字段查询参数来定义要返回的属性名称。筛选器是通过通过正文传递筛选条件来实现的。
搜索评估	此终结点将返回包含与评估相关的一系列数据点的评估对象列表。这包括评估 ID，这些 ID 可以与其他评估 API 终结点结合使用。可以根据状态、名称、支持的语言和难度筛选结果。
搜索评估尝试	此终结点返回具有给定 ID 的评估的所有开发人员的详细报告。可以通过多种方式筛选报表的范围。可以通过向其电子邮件地址（es）提供查询来筛选给定开发人员的结果。如果提供了状态，则仅包含具有指定状态的评估尝试。如果提供团队名称（s），则仅包括这些团队中的用户的评估尝试。如果提供了标记（s），则仅包含具有这些标记的用户的评估尝试。如果提供了pass_status，则仅包含具有指定pass_status的评估尝试。这包括摘要报表中的所有数据，以及评估中所有挑战的详细信息。
搜索课程开发人员进度	此终结点返回组织内所有开发人员的课程进度。
搜索锦标赛排行榜	此终结点返回单个锦标赛的排行榜。这包括开发人员参与的所有级别、挑战和阶段，以及每个级别的详细指标。此终结点还可以在报告期间（可能为 1、7 或 30 天）或给定日期范围返回排行榜。可以根据开发人员电子邮件、开发人员标记和团队名称筛选结果。
显示已完成、读取或监视的学习资源	学习说明
更新团队详细信息	这用于更新团队的详细信息。
更新用户	使用给定数据更新用户。标记将被替换。
获取 Teams	此终结点将返回包含与团队相关的数据点范围的 Team 对象列表。这包括可与其他团队 API 终结点结合使用的团队 ID。
获取团队排行榜	此终结点返回组织内所有团队的列表，其中包含其当前统计信息以及报告期间统计信息的变化（可能为 1、7 或 30 天）。
获取团队详细信息	这用于获取团队的详细信息。
获取开发人员排行榜	此终结点返回组织内所有开发人员的列表，其中包含其当前统计信息以及报告期间统计信息的变化（可能为 1、7 或 30 天）。
获取开发人员活动	此终结点返回组织内所有开发人员的详细质询日志，其中包含开发人员的挑战分数、难度和挑战结果。
获取开发人员进度	此终结点返回组织中所有开发人员的培训进度，并具有当前领域、级别和任务进度。
获取所有课程	此终结点将返回包含一系列与课程相关的数据点的 Course 对象列表。这包括课程 ID，这些 ID 可以与其他课程 API 终结点结合使用。
获取最参与的团队活动	此终结点返回最参与的“N”顶级团队。
获取最参与的用户活动	此终结点返回最参与用户最多的“N”。
获取活动优缺点	此终结点返回特定语言或所有语言的平均优缺点（具体取决于查询的粒度级别）
获取活动顶级性能	这用于检索性能最高的用户列表。
获取用户	这用于检索单个用户记录。响应可以通过传入字段查询参数来定义要返回的属性名称。
获取用户	这用于检索所有用户记录。响应可以通过传入字段查询参数来定义要返回的属性名称。
获取花费的时间	跨评估、学习、锦标赛和培训在平台上花费的时间。
获取评估	此终结点将返回包含与评估相关的一系列数据点的评估对象列表。这包括评估 ID，这些 ID 可以与其他评估 API 终结点结合使用。
获取评估尝试	此终结点返回具有给定 ID 的评估的所有开发人员的详细报告。可以通过多种方式筛选报表的范围。可以通过向其电子邮件地址提供查询来筛选给定开发人员的结果。如果提供了开始日期，则仅包含在此日期之后（包括）之后或已完成的尝试。如果提供了结束日期，则仅包含在此日期之前或之前完成的挑战。提供这两者都表示要筛选的日期范围。这包括摘要报表中的所有数据，以及评估中所有挑战的详细信息。
获取课程 URL	包含课程 URL 的 JSON
获取课程的所有开发人员的进度	此终结点将返回指定课程的所有开发人员的进度。
获取资源	学习资源列表
获取锦标赛	此终结点返回公司中的锦标赛列表。
获取锦标赛排行榜	此终结点返回单个锦标赛的排行榜。这包括开发人员参与的所有级别、挑战和阶段，以及每个级别的详细指标。

分配评估

操作 ID:: AssessmentAssign

此终结点会将给定的评估分配给指定的用户/团队。返回一个列表，其中包含分配给评估的用户及其电子邮件、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

创建团队

操作 ID:: TeamCreate

这用于创建团队。

参数

名称	密钥	类型	说明
姓名	name	string	工作组名称
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	granted	integer	授予的许可证（仅当许可证类型设置为使用情况时才有效）

团队详细信息

Body: TeamDetails

创建用户

操作 ID:: UserCreate

创建用户。

参数

名称	密钥	必需	类型	说明
发送邀请	sendInvite		boolean	标志以禁用用户邀请和邀请提醒。
enabled	enabled		boolean	平台上的用户状态
电子邮件	email	True	string	用户的电子邮件
isProfileComplete	isProfileComplete		boolean	根据需要转换配置文件完成所需的属性。如果设置为 true 属性“name.first”和“name.last”（根据需要），则名称是可选的
第一	first		string	用户名。如果“isProfileComplete”设置为 true，则为必需
中间	middle		string	用户中间名
last	last		string	用户名。如果“isProfileComplete”设置为 true，则为必需
角色	role	True	string	分配给用户的角色，该角色是开发人员、团队经理或公司管理员之一
团队	team		string	用户与之关联的团队
tags	tags		array of string	有关用户的任何标识信息。示例：头季度、Asia-Pacific
_id	_id		string	语言 ID
_框架	_framework		string	语言框架

用户已创建: UserCreated

删除团队

操作 ID:: TeamDelete

这用于删除团队。

参数

名称	密钥	必需	类型	说明
团队 ID	team_id	True	string	团队 ID

团队删除响应

Body: TeamDeleteResponse

删除用户

操作 ID:: UserDelete

删除由给定 ID 引用的用户。

参数

名称	密钥	必需	类型	说明
ID	id	True	string	用户资源 ID。

用户已删除: UserDeleted

搜索学习进度

操作 ID:: LearningSearchProgress

学习说明筛选器 - 用户、团队和标记

参数

名称	密钥	类型	说明
users	users	string	要包括在学习进度中的用户（一个或多个用户电子邮件，用逗号分隔）
team_names	team_names	string	团队名称（一个或多个团队名称，用逗号分隔）
tags	tags	string	用户标记（一个或多个用户标记，用逗号分隔）
页面	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	结果总数

搜索开发人员排行榜

操作 ID:: DeveloperSearchLeaderboard

此终结点返回组织内所有开发人员及其当前统计信息的列表。这还会列出报告期间（可能为 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	users	string	要包含在排行榜中的用户（一个或多个用户电子邮件，用逗号分隔）
team_names	team_names	string	团队名称（一个或多个团队名称，用逗号分隔）
tags	tags	string	用户标记（一个或多个用户标记，用逗号分隔）
页面	page	integer	结果的页码

名称	路径	类型	说明
排行榜	leaderboard	array of object	排行榜
等级	leaderboard.rank	integer	参与者在锦标赛中的最后位置。
Name	leaderboard.developer.name	string	开发人员的名称（第一个 + 中间 + 姓氏）。
Email	leaderboard.developer.email	string	开发人员电子邮件地址
成员自	leaderboard.developer.member_since	string	开发人员成为成员的日期。
上次登录	leaderboard.developer.last_logged_in	string	开发人员上次登录的日期。
状态	leaderboard.developer.status	string	开发人员帐户的当前状态。
公司	leaderboard.developer.company	string	开发人员所属的公司名称。
团队	leaderboard.developer.team	string	开发人员所属的团队名称。
tags	leaderboard.developer.tags	array of string	tags
roles	leaderboard.developer.roles	array of string	roles
Blocked	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	水平
姓名	leaderboard.levels.name	string	姓名
挑战	leaderboard.levels.challenges	array of object	挑战
数字	leaderboard.levels.challenges.number	integer	数字
分类	leaderboard.levels.challenges.category	string	分类
子类别	leaderboard.levels.challenges.subcategory	string	子类别
难度	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
stages	leaderboard.levels.challenges.stages	array of object	stages
数字	leaderboard.levels.challenges.stages.number	integer	数字
姓名	leaderboard.levels.challenges.stages.name	string	姓名
状态	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	结果总数。

搜索开发人员活动

操作 ID:: DeveloperSearchActivity

此终结点返回组织内所有开发人员的详细质询日志，其中包含开发人员的挑战分数、难度和挑战结果。这还会列出报告期间（可能为 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	users	string	要包含在质询日志中的用户（一个或多个用户电子邮件，用逗号分隔）
team_names	team_names	string	团队名称（一个或多个团队名称，用逗号分隔）
tags	tags	string	用户标记（一个或多个用户标记，用逗号分隔）
页面	page	integer	结果的页码

给定时间段的挑战的详细日志

开发人员活动: DevelopersActivity

搜索开发人员进度

操作 ID:: DevelopersSearchProgress

此终结点返回组织中所有开发人员的培训进度，并具有当前领域、级别和任务进度。这还会列出报表期间（可能为 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	users	string	要包含在开发人员进度中的用户（一个或多个用户电子邮件，用逗号分隔）
team_names	team_names	string	团队名称（一个或多个团队名称，用逗号分隔）
tags	tags	string	用户标记（一个或多个用户标记，用逗号分隔）
页面	page	integer	结果的页码

这包含每个语言、领域、级别和任务上每个开发人员的进度

开发人员进度: DevelopersProgress

搜索用户

操作 ID:: UserSearch

这用于检索所有用户记录。响应可以通过传入字段查询参数来定义要返回的属性名称。筛选器是通过通过正文传递筛选条件来实现的。

参数

名称	密钥	类型	说明
Fields	fields	string	字段数组。仅返回提供的属性。每个属性都应以逗号分隔。
页	page	integer	返回分页结果集的给定页码。页面大小为 1000 条记录。
id	id	string	用户资源 ID
电子邮件	email	string	用户的电子邮件
角色	role	string	分配给用户的角色，该角色是开发人员、团队经理或公司管理员之一
团队	team	string	用户与之关联的团队
tags	tags	array of string	有关用户的任何标识信息。示例：头季度、Asia-Pacific

UserData 列表

用户列表: UsersList

搜索评估

操作 ID:: AssessmentSearch

此终结点将返回包含与评估相关的一系列数据点的评估对象列表。这包括评估 ID，这些 ID 可以与其他评估 API 终结点结合使用。可以根据状态、名称、支持的语言和难度筛选结果。

参数

名称	密钥	类型	说明
状态	status	string	评估状态
姓名	name	string	评估名称
_id	_id	string	语言 ID
_框架	_framework	string	语言框架
难度	difficulty	string	评估难度
页面	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:: AssessmentSearchAttempts

此终结点返回具有给定 ID 的评估的所有开发人员的详细报告。可以通过多种方式筛选报表的范围。可以通过向其电子邮件地址（es）提供查询来筛选给定开发人员的结果。如果提供了状态，则仅包含具有指定状态的评估尝试。如果提供团队名称（s），则仅包括这些团队中的用户的评估尝试。如果提供了标记（s），则仅包含具有这些标记的用户的评估尝试。如果提供了pass_status，则仅包含具有指定pass_status的评估尝试。这包括摘要报表中的所有数据，以及评估中所有挑战的详细信息。

参数

名称	密钥	类型	说明
assessment_id	assessment_id	string	评估 ID
姓名	name	string	评估名称
users	users	string	尝试评估的用户（一个或多个用户电子邮件，用逗号分隔）
状态	status	string	评估尝试状态
team_names	team_names	string	团队名称（一个或多个团队名称，用逗号分隔）
tags	tags	string	用户标记（一个或多个用户标记，用逗号分隔）
pass_status	pass_status	string	评估尝试通过状态
页面	page	integer	结果的页码

名称	路径	类型	说明
尝试	attempts	array of object	尝试
ID	attempts._id	string	评估尝试 ID
Assessment	attempts._assessment	string	它所属的评估
评估名称	attempts.name	string	评估名称
Name	attempts.developer.name	string	开发人员的名称（第一个 + 中间 + 姓氏）。
Email	attempts.developer.email	string	开发人员的电子邮件地址。
成员自	attempts.developer.member_since	string	开发人员成为成员的日期。
上次登录	attempts.developer.last_logged_in	string	开发人员上次登录的日期。
状态	attempts.developer.status	string	开发人员帐户的当前状态。
公司	attempts.developer.company	string	开发人员所属的公司名称。
团队	attempts.developer.team	string	开发人员所属的团队名称。
tags	attempts.developer.tags	array of string	tags
roles	attempts.developer.roles	array of string	roles
状态	attempts.status	string	指示可能处于挂起状态、正在进行中或“无法访问”的挑战/评估的状态。
语言	attempts.language	string	评估的语言/框架。 null = 未选择用于支持多种语言的评估语言/框架。
Started	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	数字
分类	attempts.challenges.category	string	分类
子类别	attempts.challenges.subcategory	string	子类别
难度	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	结果总数。

搜索课程开发人员进度

操作 ID:: DeveloperSearchProgress

此终结点返回组织内所有开发人员的课程进度。

参数

名称	密钥	类型	说明
页	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	结果总数

搜索锦标赛排行榜

操作 ID:: TournamentSearchLeaderboard

此终结点返回单个锦标赛的排行榜。这包括开发人员参与的所有级别、挑战和阶段，以及每个级别的详细指标。此终结点还可以在报告期间（可能为 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	users		string	要包含在排行榜中的用户（一个或多个用户电子邮件，用逗号分隔）
team_names	team_names		string	团队名称（一个或多个团队名称，用逗号分隔）
tags	tags		string	用户标记（一个或多个用户标记，用逗号分隔）
页面	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	结果总数

显示已完成、读取或监视的学习资源

操作 ID:: LearningGetProgress

学习说明

参数

名称	密钥	必需	类型	说明
页	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	结果总数

更新团队详细信息

操作 ID:: TeamUpdate

这用于更新团队的详细信息。

参数

名称	密钥	必需	类型	说明
团队 ID	team_id	True	string	团队 ID
姓名	name		string	工作组名称
tags	tags		array of string	有关团队的任何标识信息。示例：头季度、亚太地区、工程
状态	status		string	团队状态
onboardingmessage	onboardingmessage		string	加入团队消息
语言	languages		array of string	团队语言列表、_id和_framework用双冒号分隔（：:)用逗号（，）

团队详细信息

Body: TeamDetails

更新用户

操作 ID:: UserUpdate

使用给定数据更新用户。标记将被替换。

参数

名称	密钥	必需	类型	说明
ID	id	True	string	用户资源 ID。
跳过 Notify If SSO	skipNotifyIfSso		boolean	用于禁用发送给用户的电子邮件通知的更改。
电子邮件	email		email	用户的电子邮件地址
enabled	enabled		boolean	平台上的用户状态
角色	role		string	分配给用户的角色，该角色是开发人员、团队经理或公司管理员之一
团队	team		string	用户与之关联的团队
tags	tags		array of string	有关用户的任何标识信息。示例：头季度、Asia-Pacific
_id	_id		string	语言 ID
_框架	_framework		string	语言框架

用户已更新: UserUpdated

获取 Teams

操作 ID:: TeamsGet

此终结点将返回包含与团队相关的数据点范围的 Team 对象列表。这包括可与其他团队 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:: TeamGetLeaderboard

此终结点返回组织内所有团队的列表，其中包含其当前统计信息以及报告期间统计信息的变化（可能为 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

response: array of TeamLeaderboard

获取团队详细信息

操作 ID:: TeamGetDetails

这用于获取团队的详细信息。

参数

名称	密钥	必需	类型	说明
团队 ID	team_id	True	string	团队 ID

团队详细信息

Body: TeamDetails

获取开发人员排行榜

操作 ID:: DeveloperGetLeaderboard

此终结点返回组织内所有开发人员的列表，其中包含其当前统计信息以及报告期间统计信息的变化（可能为 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	参与者在锦标赛中的最后位置。
Name	leaderboard.developer.name	string	开发人员的名称（第一个 + 中间 + 姓氏）
Email	leaderboard.developer.email	string	开发人员的电子邮件地址。
成员自	leaderboard.developer.member_since	string	开发人员成为成员的日期。
上次登录	leaderboard.developer.last_logged_in	string	开发人员上次登录的日期。
状态	leaderboard.developer.status	string	开发人员帐户的当前状态。
公司	leaderboard.developer.company	string	开发人员所属的公司名称
团队	leaderboard.developer.team	string	开发人员所属的团队名称。
tags	leaderboard.developer.tags	array of string	tags
roles	leaderboard.developer.roles	array of string	roles
Blocked	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	水平
姓名	leaderboard.levels.name	string	姓名
挑战	leaderboard.levels.challenges	array of object	挑战
数字	leaderboard.levels.challenges.number	integer	数字
分类	leaderboard.levels.challenges.category	string	分类
子类别	leaderboard.levels.challenges.subcategory	string	子类别
难度	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
stages	leaderboard.levels.challenges.stages	array of object	stages
数字	leaderboard.levels.challenges.stages.number	integer	数字
姓名	leaderboard.levels.challenges.stages.name	string	姓名
状态	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	结果总数。

获取开发人员活动

操作 ID:: DeveloperGetActivity

此终结点返回组织内所有开发人员的详细质询日志，其中包含开发人员的挑战分数、难度和挑战结果。

参数

名称	密钥	必需	类型	说明
页	page		integer	结果的页码

给定时间段的挑战的详细日志

开发人员活动: DevelopersActivity

获取开发人员进度

操作 ID:: DeveloperGetProgress

此终结点返回组织中所有开发人员的培训进度，并具有当前领域、级别和任务进度。

参数

名称	密钥	必需	类型	说明
页	page		integer	结果的页码

这包含每个语言、领域、级别和任务上每个开发人员的进度

开发人员进度: DevelopersProgress

获取所有课程

操作 ID:: CoursesGet

此终结点将返回包含一系列与课程相关的数据点的 Course 对象列表。这包括课程 ID，这些 ID 可以与其他课程 API 终结点结合使用。

参数

名称	密钥	必需	类型	说明
页	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	结果总数

获取最参与的团队活动

操作 ID:: TeamGetMostEngaged

此终结点返回最参与的“N”顶级团队。

参数

名称	密钥	类型	说明
报告周期	report_period	integer	查看大多数参与团队的天数（report_period应单独指定或结束日期）
开始日期	startdate	string	日期范围的开始日期（不应使用report_period指定）。格式：YYYY-MM-DDTHH：mm：ss。SSSZ
结束日期	enddate	string	日期范围的结束日期（应大于开始日期）。格式：YYYY-MM-DDTHH：mm：ss。SSSZ
Teams 数量	number_of_teams	integer	排名靠前的“N”团队数
标记	tags	string	用户标记
页	page	integer	结果的页码

公司中参与率最高的 Teams

Body: MostEngagedTeams

获取最参与的用户活动

操作 ID:: UserGetMostEngaged

此终结点返回最参与用户最多的“N”。

参数

名称	密钥	类型	说明
报告周期	report_period	integer	查看大多数参与用户（应单独指定或终止日期）的天数（report_period）
开始日期	startdate	string	日期范围的开始日期（不应使用report_period指定）。格式：YYYY-MM-DDTHH：mm：ss。SSSZ
结束日期	enddate	string	日期范围的结束日期（应大于开始日期）。格式：YYYY-MM-DDTHH：mm：ss。SSSZ
用户数	number_of_users	integer	排名靠前的“N”用户数
工作组名称	team_name	string	工作组名称
标记	tags	string	用户标记
页	page	integer	结果的页码

公司中大多数参与用户

Body: MostEngagedUsers

获取活动优缺点

操作 ID:: ActivityGetStrengthsAndWeaknesses

此终结点返回特定语言或所有语言的平均优缺点（具体取决于查询的粒度级别）

参数

名称	密钥	类型	说明
目标类型	targetType	string	目标类型。默认值取决于 API 密钥的范围。报告密钥默认为公司。团队密钥默认为团队。
目标标识符	targetIdentifier	string	目标标识符（团队名称、用户电子邮件或用户 ID）
语言 ID	languageId	string	语言 ID
语言框架	languageFramework	string	语言框架
页	page	integer	结果的页码

平均优缺点对象

Body: StrengthsAndWeaknesses

获取活动顶级性能

操作 ID:: ActivityGetTopPerform

这用于检索性能最高的用户列表。

参数

名称	密钥	类型	说明
报告周期	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	表现最强者列表

获取用户

操作 ID:: UserGet

这用于检索单个用户记录。响应可以通过传入字段查询参数来定义要返回的属性名称。

参数

名称	密钥	必需	类型	说明
ID	id	True	string	用户资源 ID。
ID 类型	idtype		string	用于对 URL 中的用户 ID 类型进行分类。
Fields	fields		string	字段数组。仅返回筛选器中指定的属性。每个属性都应以逗号分隔。

用户数据: UserData

获取用户

操作 ID:: UsersGet

这用于检索所有用户记录。响应可以通过传入字段查询参数来定义要返回的属性名称。

参数

名称	密钥	必需	类型	说明
Fields	fields		string	字段数组。仅返回提供的属性。每个属性都应以逗号分隔。
页	page		integer	返回分页结果集的给定页码。页面大小为 1000 条记录。

UserData 列表

用户列表: UsersList

获取花费的时间

操作 ID:: TimeGetSpent

跨评估、学习、锦标赛和培训在平台上花费的时间。

参数

名称	密钥	类型	说明
页	page	integer	结果的页码
ID	id	string	基于 UUID 格式的用户 ID 筛选结果
Email	email	string	基于电子邮件筛选结果
标记	tags	string	筛选结果基础以显示带有标记的用户。指定的标记由逗号分隔，并使用 OR 逻辑筛选结果。
团队	team	string	筛选结果以显示用户属于指定团队
开始日期	startdate	date-time	筛选结果以包括一天开始的结果。日期格式“YYYY-MM-DD”。 UTC 格式
结束日期	enddate	date-time	筛选结果以包括所有结果直到一天结束。日期格式“YYYY-MM-DD”。 UTC 格式

名称	路径	类型	说明
users	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	结果总数

获取评估

操作 ID:: AssessmentsGet

此终结点将返回包含与评估相关的一系列数据点的评估对象列表。这包括评估 ID，这些 ID 可以与其他评估 API 终结点结合使用。

参数

名称	密钥	类型	说明
页	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	结果总数

获取评估尝试

操作 ID:: AssessmentGetAttempts

此终结点返回具有给定 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
Assessment	attempts._assessment	string	它所属的评估
评估名称	attempts.name	string	评估名称
Name	attempts.developer.name	string	开发人员的名称（第一个 + 中间 + 姓氏）。
Email	attempts.developer.email	string	开发人员的电子邮件地址。
成员自	attempts.developer.member_since	string	开发人员成为成员的日期。
上次登录	attempts.developer.last_logged_in	string	开发人员上次登录的日期。
状态	attempts.developer.status	string	开发人员帐户的当前状态。
公司	attempts.developer.company	string	开发人员所属的公司名称。
团队	attempts.developer.team	string	开发人员所属的团队名称。
tags	attempts.developer.tags	array of string	tags
roles	attempts.developer.roles	array of string	roles
状态	attempts.status	string	指示可能处于挂起状态、正在进行中或“无法访问”的挑战/评估的状态。
语言	attempts.language	string	评估的语言/框架。 null = 未选择用于支持多种语言的评估语言/框架。
Started	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	数字
分类	attempts.challenges.category	string	分类
子类别	attempts.challenges.subcategory	string	子类别
难度	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	结果总数。

获取课程 URL

操作 ID:: CourseGetURL

包含课程 URL 的 JSON

参数

名称	密钥	必需	类型	说明
语言框架	language_framework	True	string	采用“Java：：Spring”格式的语言和框架的名称
课程	course	True	string	当然，名称
模块	module	True	string	当然模块的名称
重定向	redirect		boolean	将用户重定向到返回 URL

培训课程的 URL

课程 URL: CourseURL

获取课程的所有开发人员的进度

操作 ID:: CourseGetDevelopersProgress

此终结点将返回指定课程的所有开发人员的进度。

参数

名称	密钥	必需	类型	说明
课程 ID	course_id	True	string	课程 ID
页	page		integer	结果的页码

名称	路径	类型	说明
数据	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	结果总数

获取资源

操作 ID:: LearningGetResources

学习资源列表

名称	路径	类型	说明
资源	resources	array of Resource

获取锦标赛

操作 ID:: TournamentsGet

此终结点返回公司中的锦标赛列表。

参数

名称	密钥	类型	说明
页	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:: TournamentGetLeaderboard

此终结点返回单个锦标赛的排行榜。这包括开发人员参与的所有级别、挑战和阶段，以及每个级别的详细指标。

参数

名称	密钥	必需	类型	说明
锦标赛 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	结果总数

定义

比赛

名称	路径	类型	说明
_id	_id	string	锦标赛的 ID
姓名	name	string	锦标赛的名称
描述	description	string	锦标赛说明
开始时间	start_time	date-time	锦标赛开始的时间
end_time	end_time	date-time	锦标赛结束的时间
timezone	timezone	string	锦标赛正在举行的时区

TournamentParticipant

名称	路径	类型	说明
级别	rank	integer	参与者在锦标赛中的最终位置
开发人员	developer	Developer	有关单个开发人员的信息
封锁	blocked	boolean	此参与者是否被阻止离开巡回演出
minutes_spent	minutes_spent	integer	开发人员花了多长时间（以分钟为单位）
语言	language	string	参与者使用的语言/框架
max_points	max_points	integer	锦标赛中可用的最大积分数
点	points	integer	参与者获得的积分量
hints_used	hints_used	integer	参与者使用的提示数
lives_lost	lives_lost	integer	参与者在锦标赛期间失去的生命数
水平	levels	array of Level	挑战级别

级别

名称	路径	类型	说明
姓名	name	string	级别名称
挑战	challenges	array of object
数字	challenges.number	integer	挑战号（从 1 开始）
分类	challenges.category	string	挑战类别
子类别	challenges.subcategory	string	挑战子类别
难度	challenges.difficulty	string
状态	challenges.status	Status	指示质询/评估的状态，可能处于挂起状态、正在进行中或“无法访问”
max_points	challenges.max_points	integer	此挑战提供的最大积分
点	challenges.points	integer	为此挑战获得的积分
codebase_size	challenges.codebase_size	string
minutes_spent	challenges.minutes_spent	integer	开发人员花了多长时间（以分钟为单位）
stages	challenges.stages	array of Stage

阶段

名称	路径	类型	说明
数字	number	integer	阶段号
姓名	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	此阶段使用的提示数

Assessment

名称	路径	类型	说明
_id	_id	string	评估 ID
状态	status	string	评估的状态
姓名	name	string	评估的名称
描述	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	是否允许重试此评估？

状态

指示质询/评估的状态，可能处于挂起状态、正在进行中或“无法访问”

状态: string

preferredDevLanguage

开发语言首选项

名称	路径	类型	说明
_id	_id	string	语言 ID
_框架	_framework	string	语言框架

AssessmentAssignResponse

响应评估分配 POST 请求

名称	路径	类型	说明
用户	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	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	团队中已安装 sensei 的开发人员数
报告期间统计信息	stats_over_report_period	StatsOverReportPeriod	给定报告周期计算的统计信息

MostEngagedTeams

公司中参与率最高的 Teams

名称	路径	类型	说明
团队	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	string	团队的名称
状态	status	string	团队的状态
timeSpent	timeSpent	integer	团队花费的时间

MostEngagedUsers

公司中大多数参与用户

名称	路径	类型	说明
users	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	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	string	开发人员的名称（第一个 + 中间 + 姓氏）
电子邮件	email	string	开发人员电子邮件地址
member_since	member_since	date-time	开发人员成为成员的日期
last_logged_in	last_logged_in	date-time	开发人员上次登录的日期
状态	status	string	开发人员帐户的当前状态
公司	company	string	开发人员所属的公司名称
团队	team	string	开发人员所属的团队名称
tags	tags	array of string	与此开发人员关联的标记
roles	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	string	语言框架的名称
language_progress	language_progress	integer	已完成语言的百分比
领域	realms	array of object	每种语言的领域列表
姓名	realms.name	string	领域名称
realm_progress	realms.realm_progress	integer	已完成领域百分比
水平	realms.levels	array of object	每个领域的级别列表
姓名	realms.levels.name	string	级别名称
level_progress	realms.levels.level_progress	integer	已完成级别的百分比
任务	realms.levels.quests	array of object	每个级别的任务列表
姓名	realms.levels.quests.name	string	quest 的名称
quest_progress	realms.levels.quests.quest_progress	integer	已完成任务百分比

DevelopersActivity

给定时间段的挑战的详细日志

名称	路径	类型	说明
activities	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	everloper 在训练模式下进行的尝试

ChallengeAttempt

everloper 在训练模式下进行的尝试

名称	路径	类型	说明
语言	language	string	语言框架的名称
realm	realm	string	领域名称
水平仪	level	string	级别名称
寻求	quest	string	quest 的名称
分类	category	string	质询的类别名称
子类别	subcategory	string	质询的子类别名称
难度	difficulty	string	挑战难度级别
入门	started	date-time	时间挑战已启动
完成	completed	date-time	完成时间挑战
duration	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	string

Resource

资源详细信息

名称	路径	类型
id	id	string
姓名	name	string
items	items	array of ResourceItem

CompletedResource

已完成学习资源的详细信息

名称	路径	类型	说明
资源	resource	array of string	已完成资源的分类和名称的有序列表
time_completed	time_completed	date-time	学习资源完成后

资源记录

开发人员已完成学习资源的记录

名称	路径	类型	说明
开发人员	profile	Developer	有关单个开发人员的信息
完成	completed	array of CompletedResource	用户完成的所有学习资源

CourseURL

培训课程的 URL

名称	路径	类型	说明
网址	url	string	课程 URL

TeamData

名称	路径	类型	说明
姓名	name	string	团队名称

UserData

名称	路径	类型	说明
id	id	string	用户的资源 ID
电子邮件	email	string	用户的电子邮件
角色	role	string	分配给用户的角色，该角色是开发人员、团队经理或公司管理员之一
第一	name.first		名字
中间	name.middle		中间名
last	name.last		姓氏
状态	status	string	用户状态
invite-date	invite-date	date-time	上次邀请用户的时间
last-login-date	last-login-date	date-time	用户上次登录的时间
团队数据	team	TeamData
tags	tags	array of string	有关用户的任何标识信息。示例：头季度、Asia-Pacific
preferredDevLanguages	preferredDevLanguages	array of preferredDevLanguage	开发语言首选项

UserUpdated

名称	路径	类型	说明
状态码	statusCode	integer	成功响应消息状态代码
消息	message	string	成功响应消息说明
代码	code	string	安全代码勇士代码

UserCreated

名称	路径	类型	说明
id	id	string	安全代码勇士资源标识符
状态码	statusCode	integer	成功响应消息状态代码
消息	message	string	成功响应消息说明
代码	code	string	安全代码勇士代码

UserDeleted

名称	路径	类型	说明
状态码	statusCode	integer	成功响应消息状态代码
消息	message	string	成功响应消息说明
代码	code	string	安全代码勇士代码

UsersList

UserData 列表

名称	路径	类型	说明
users	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	用户电子邮件
第一	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	用户电子邮件
第一	name.first	string	用户名
中间	name.middle	string	用户中间名
last	name.last	string	用户名
tags	tags	array of string	用户标记
状态	status	string	用户状态
团队数据	team	TeamData
花费的时间	time-spent	array of object	日期数组，按一天中的时间/活动细分
date	time-spent.date	date	UTC 格式的日期
评估	time-spent.activity.Assessments	integer	评估所用的时间
学习	time-spent.activity.Learning	integer	学习所用的时间
比赛	time-spent.activity.Tournaments	integer	锦标赛花费的时间
Training	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	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	integer	Total
使用的内容	used	integer	已使用

TeamDetails

团队详细信息

名称	路径	类型	说明
id	id	string	团队 ID
姓名	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	string	课程的名称
描述	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	string	编程语言
状态	status	string	课程语言的状态
准确度	accuracy	integer	语言的正确尝试百分比
可信度	confidence	integer	用于语言可用提示的命中率
minutes_spent	minutes_spent	integer	用户花在课程中为语言花费的总时间
进展	progress	integer	语言课程的进度
videos_watched	videos_watched	integer	用户观看了语言的视频量

通过

安全代码战士 （独立发布者） （预览版）

正在创建连接

违约

限制

操作

分配评估

参数

返回

创建团队

参数

返回

创建用户

参数

返回

删除团队

参数

返回

删除用户

参数

返回

搜索学习进度

参数

返回

搜索开发人员排行榜

参数

返回

搜索开发人员活动

参数

返回

搜索开发人员进度

参数

返回

搜索用户

参数

返回

搜索评估

参数

返回

搜索评估尝试

参数

返回

搜索课程开发人员进度

参数

返回

搜索锦标赛排行榜

参数

返回

显示已完成、读取或监视的学习资源

参数

返回

更新团队详细信息

参数

返回

更新用户

参数

返回

获取 Teams

参数

返回

获取团队排行榜

参数

返回

获取团队详细信息

参数

返回

获取开发人员排行榜

参数

返回

获取开发人员活动

参数

返回

获取开发人员进度

参数

返回

获取所有课程

参数

返回

获取最参与的团队活动

参数

安全代码战士（独立发布者）（预览版）