Secure Code Warrior (независимый издатель) (предварительная версия)

Этот соединитель Secure Code Warrior(https://securecodewarrior.com) предоставляет программный доступ к платформе обучения. Secure Code Warrior делает безопасный код положительным и привлекательным для разработчиков, так как они повышают свои навыки безопасности программного обеспечения. С нашей флагманской платформой обучения мы руководствуемся каждым кодировщиком по собственной предпочтительной схеме обучения, чтобы разработчики, квалифицированные по безопасности, стали повседневными супергероями нашего подключенного мира.

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

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

Контакт
Имя	Трой Тейлор
URL	https://www.hitachisolutions.com
Адрес электронной почты	ttaylor@hitachisolutions.com

Метаданные соединителя
Publisher	Решения Для Хит
Узнайте больше о Secure Code Warrior	https://docs.microsoft.com/connectors/securecodewarrior
Website	https://www.securecodewarrior.com/
Политика конфиденциальности	https://www.securecodewarrior.com/trust/privacy-policy
Категории	ИТ-операции

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

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

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

По умолчанию

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

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

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

Имя	Тип	Description	Обязательно
Токен API	securestring	Маркер API для этого API	True

Ограничения регулирования

Имя	Вызовы	Период обновления
Вызовы API для каждого подключения	100	60 секунд

Действия

Действия разработчиков поиска	Эта конечная точка возвращает подробный журнал вызовов всех разработчиков в организации, с оценкой проблем, сложностью и результатом задачи разработчика. В этом разделе также перечислены журналы вызовов за период отчета (который может быть 1, 7 или 30 дней) или заданный диапазон дат. Результаты можно фильтровать на основе сообщений электронной почты разработчика, тегов разработчиков и имен команд.
Назначение оценок	Эта конечная точка назначает указанную оценку указанным пользователям или командам. Возвращает список пользователей, назначенных оценке с помощью электронной почты, пригласитьUrl и состояние, указывающее, было ли отправлено письмо приглашения.
Обновление пользователя	Обновляет пользователя заданными данными. Теги будут заменены.
Обновление сведений о команде	Это используется для обновления сведений о команде.
Оценка поиска	Эта конечная точка возвращает список объектов оценки, содержащих диапазон точек данных, связанных с оценками. К ним относятся идентификаторы оценки, которые могут использоваться вместе с другими конечными точками API оценки. Результаты можно фильтровать на основе состояния, имени, поддерживаемого языка и сложности.
Поиск в области лидеров разработчиков	Эта конечная точка возвращает список всех разработчиков в организации с текущими статистическими данными. В этом разделе также перечислены изменения статистики за период отчета (которые могут быть 1, 7 или 30 дней) или заданный диапазон дат. Результаты можно фильтровать на основе сообщений электронной почты разработчика, тегов разработчиков и имен команд.
Поиск в списке лидеров турнира	Эта конечная точка возвращает список лидеров для одного турнира. К ним относятся все уровни, проблемы и этапы, в которые участвовал разработчик, с подробными метриками каждого из них. Эта конечная точка также может возвращать таблицу лидеров за период отчета (это может быть 1, 7 или 30 дней) или заданный диапазон дат. Результаты можно фильтровать на основе сообщений электронной почты разработчика, тегов разработчиков и имен команд.
Поиск пользователей	Используется для получения всех записей пользователей. Ответ может быть сформирован путем передачи параметра запроса полей, в котором перечислены имена атрибутов для возврата. Фильтр достигается путем передачи критериев фильтра через текст.
Показывает ресурсы обучения, которые будут завершены, прочитаны или просмотрированы	Описание обучения
Получение Teams	Эта конечная точка возвращает список объектов Team, содержащих диапазон точек данных, связанных с командами. Сюда входят идентификаторы групп, которые могут использоваться в сочетании с другими конечными точками API команды.
Получение URL-адреса курса	JSON, содержащий URL-адрес курса
Получение времени	Время, затраченное на платформу по оценкам, обучению, турнирам и обучению.
Получение всех курсов	Эта конечная точка возвращает список объектов Course, содержащих диапазон точек данных, связанных с курсами. К ним относятся идентификаторы курсов, которые могут использоваться в сочетании с другими конечными точками API курса.
Получение действий разработчика	Эта конечная точка возвращает подробный журнал вызовов всех разработчиков в организации, с оценкой проблем, сложностью и результатом задачи разработчика.
Получение лучших исполнителей действий	Это используется для получения списка наиболее выполняющихся пользователей.
Получение наиболее активного взаимодействия пользователей	Эта конечная точка возвращает топ "N" наиболее заинтересованных пользователей.
Получение наиболее активной деятельности группы	Эта конечная точка возвращает топ "N" наиболее заинтересованных команд.
Получение оценок	Эта конечная точка возвращает список объектов оценки, содержащих диапазон точек данных, связанных с оценками. К ним относятся идентификаторы оценки, которые могут использоваться вместе с другими конечными точками API оценки.
Получение пользователей	Используется для получения всех записей пользователей. Ответ может быть сформирован путем передачи параметра запроса полей, в котором перечислены имена атрибутов для возврата.
Получение попыток оценки	Эта конечная точка возвращает подробный отчет для всех разработчиков, которые приняли оценку с указанным идентификатором. Область отчета может фильтроваться несколькими способами. Вы можете фильтровать результаты для данного разработчика, указав свой адрес электронной почты запросом. Если указана дата начала, включены только попытки, запущенные или завершенные после (и включая) эту дату. Если указана дата окончания, до включения этой даты будут включены только проблемы, запущенные или завершенные. Предоставление обоих значений указывает диапазон дат для фильтрации. Сюда входят все данные в сводном отчете и подробные сведения обо всех проблемах, которые являются частью оценки.
Получение ресурсов	Список ресурсов обучения
Получение сведений о команде	Это используется для получения сведений о команде.
Получение сильных и слабых мест активности	Эта конечная точка возвращает средние сильные и слабые места для компании, команды или пользователя (в зависимости от уровня детализации запроса) для определенного языка или всех языков.
Получение списка лидеров турнира	Эта конечная точка возвращает список лидеров для одного турнира. К ним относятся все уровни, проблемы и этапы, в которые участвовал разработчик, с подробными метриками каждого из них.
Получение таблицы лидеров группы	Эта конечная точка возвращает список всех команд в организации с текущими статистическими данными, а также изменения статистики за период отчета (это может быть 1, 7 или 30 дней).
Получение таблицы лидеров разработчиков	Эта конечная точка возвращает список всех разработчиков в организации с текущими статистиками, а также изменения статистики за период отчета (это может быть 1, 7 или 30 дней).
Получение турниров	Эта конечная точка возвращает список турниров в компании.
Получение хода выполнения разработчика	Эта конечная точка возвращает ход обучения всех разработчиков в организации с текущей областью, уровнем и прогрессом поиска.
Получите прогресс всех разработчиков для курса	Эта конечная точка возвращает ход выполнения всех разработчиков для указанного курса.
Получить пользователя	Используется для получения одной записи пользователя. Ответ может быть сформирован путем передачи параметра запроса полей, в котором перечислены имена атрибутов для возврата.
Попытки оценки поиска	Эта конечная точка возвращает подробный отчет для всех разработчиков, которые приняли оценку с указанным идентификатором. Область отчета может фильтроваться несколькими способами. Вы можете фильтровать результаты по заданным разработчикам, указав их адреса электронной почты с помощью запроса. Если задано состояние, включены только попытки оценки с указанным состоянием. Если указано имя группы, включены только попытки оценки пользователей в этих командах. Если предоставляются теги, включены только попытки оценки пользователей с этими тегами. Если предоставляется pass_status, включаются только попытки оценки с указанными pass_status. Сюда входят все данные в сводном отчете и подробные сведения обо всех проблемах, которые являются частью оценки.
Создание пользователя	Создает пользователя.
Создать рабочую группу	Это используется для создания команды.
Удаление команды	Используется для удаления команды.
Удаление пользователя	Удаляет пользователя, на который ссылается указанный идентификатор.
Ход выполнения курса поиска	Эта конечная точка возвращает ход выполнения всех разработчиков в организации.
Ход выполнения поиска разработчиков	Эта конечная точка возвращает ход обучения всех разработчиков в организации с текущей областью, уровнем и прогрессом поиска. В этом разделе также перечислены изменения хода выполнения разработчика за период отчета (которые могут быть 1, 7 или 30 дней) или заданный диапазон дат. Результаты можно фильтровать на основе сообщений электронной почты разработчика, тегов разработчиков и имен команд.
Ход обучения поиска	Фильтры описания обучения — пользователи, команды и теги

Действия разработчиков поиска

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

DeveloperSearchActivity

Эта конечная точка возвращает подробный журнал вызовов всех разработчиков в организации, с оценкой проблем, сложностью и результатом задачи разработчика. В этом разделе также перечислены журналы вызовов за период отчета (который может быть 1, 7 или 30 дней) или заданный диапазон дат. Результаты можно фильтровать на основе сообщений электронной почты разработчика, тегов разработчиков и имен команд.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
report_period_in_days	report_period_in_days		integer	Количество дней в прошлом для отчета (допустимые значения — 1, 7 и 30 дней)
startdate	startdate		string	Журналы вызовов разработчика завершили или после заданного времени. Формат: ГГГГ-ММ-DDTHH:mm:ss. SSSZ
enddate	enddate		string	Журналы вызовов разработчика завершили или до заданного времени. Формат: ГГГГ-ММ-DDTHH:mm:ss. SSSZ
users	users		string	Пользователи, которые включаются в журналы вызовов (одно или несколько сообщений электронной почты пользователей, разделенных запятыми)
team_names	team_names		string	Имена команд (один или несколько имен команд, разделенные запятыми)
tags	tags		string	Теги пользователей (один или несколько тегов пользователей, разделенные запятыми)
page	page		integer	Номер страницы результатов

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

Подробный журнал проблем за заданный период времени

Действие разработчика

DevelopersActivity

Назначение оценок

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

AssessmentAssign

Эта конечная точка назначает указанную оценку указанным пользователям или командам. Возвращает список пользователей, назначенных оценке с помощью электронной почты, пригласитьUrl и состояние, указывающее, было ли отправлено письмо приглашения.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор оценки	assessment_id	True	string	Идентификатор оценки
users	users		array of string	Список пользователей, назначаемых оценке
teams	teams		array of string	Список команд для назначения оценки
sendEmail	sendEmail		boolean	Пометка, чтобы указать, отправляется ли сообщение электронной почты о приглашении на назначение оценки (по умолчанию: true)

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

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

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

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

UserUpdate

Обновляет пользователя заданными данными. Теги будут заменены.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	string	Идентификатор ресурса пользователя.
Пропустить уведомление о едином входе	skipNotifyIfSso		boolean	Используется для отключения изменения уведомления электронной почты, отправленного пользователю.
электронная почта	email		email	Адрес электронной почты пользователя
enabled	enabled		boolean	Состояние пользователей на платформе
роль	role		string	Роль, назначенная пользователю, который является одним из разработчиков, руководителя группы или администратора компании
team	team		string	Команда, с которым связан пользователь
tags	tags		array of string	Любая информация об идентификации пользователя. Пример: кварталы головы, Asia-Pacific
_id	_id		string	Идентификатор языка
_каркас	_framework		string	Языковая платформа

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

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

UserUpdated

Обновление сведений о команде

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

TeamUpdate

Это используется для обновления сведений о команде.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор команды	team_id	True	string	Идентификатор команды
имя	name		string	Имя группы
tags	tags		array of string	Любая идентификация информации о команде. Пример: головной квартал, Азиатско-Тихоокеанский регион, инженерия
статус	status		string	Состояние команды
подключениеmessage	onboardingmessage		string	Сообщение о команде на борту
Языки	languages		array of string	Список языков группы, _id и _framework разделены двойными двоеточиями (::) и разделены запятыми (,)

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

Сведения о команде

Тело

TeamDetails

Оценка поиска

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

AssessmentSearch

Эта конечная точка возвращает список объектов оценки, содержащих диапазон точек данных, связанных с оценками. К ним относятся идентификаторы оценки, которые могут использоваться вместе с другими конечными точками API оценки. Результаты можно фильтровать на основе состояния, имени, поддерживаемого языка и сложности.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
статус	status		string	Состояние оценки
имя	name		string	Имя оценки
_id	_id		string	Идентификатор языка
_каркас	_framework		string	Языковая платформа
трудность	difficulty		string	Трудности оценки
page	page		integer	Номер страницы результатов

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

Имя	Путь	Тип	Описание
assessments	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	Общее число результатов

Поиск в области лидеров разработчиков

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

DeveloperSearchLeaderboard

Эта конечная точка возвращает список всех разработчиков в организации с текущими статистическими данными. В этом разделе также перечислены изменения статистики за период отчета (которые могут быть 1, 7 или 30 дней) или заданный диапазон дат. Результаты можно фильтровать на основе сообщений электронной почты разработчика, тегов разработчиков и имен команд.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
report_period_in_days	report_period_in_days		integer	Количество дней в прошлом для отчета (допустимые значения — 1, 7 и 30 дней)
startdate	startdate		string	Доска лидеров разработчика завершена или после заданного времени. Формат: ГГГГ-ММ-DDTHH:mm:ss. SSSZ
enddate	enddate		string	Подготовка лидеров разработчика завершена до заданного времени или до этого времени. Формат: ГГГГ-ММ-DDTHH:mm:ss. SSSZ
users	users		string	Пользователи, включаемые в список лидеров (одно или несколько сообщений электронной почты пользователей, разделенные запятыми)
team_names	team_names		string	Имена команд (один или несколько имен команд, разделенные запятыми)
tags	tags		string	Теги пользователей (один или несколько тегов пользователей, разделенные запятыми)
page	page		integer	Номер страницы результатов

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

Имя	Путь	Тип	Описание
список лидеров	leaderboard	array of object	список лидеров
Ранг	leaderboard.rank	integer	Окончательная позиция участника в турнире.
Имя	leaderboard.developer.name	string	Имя разработчика (первый + средний + фамилия).
Адрес электронной почты	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
Заблокировано	leaderboard.blocked	boolean	Был ли этот участник заблокирован из турнира.
Минуты, потраченные	leaderboard.minutes_spent	integer	Сколько времени разработчик потратил на ответы (в минутах).
Language	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
Этапах	leaderboard.levels.challenges.stages	array of object	Этапах
число/номер	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	Общее число результатов.

Поиск в списке лидеров турнира

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

TournamentSearchLeaderboard

Эта конечная точка возвращает список лидеров для одного турнира. К ним относятся все уровни, проблемы и этапы, в которые участвовал разработчик, с подробными метриками каждого из них. Эта конечная точка также может возвращать таблицу лидеров за период отчета (это может быть 1, 7 или 30 дней) или заданный диапазон дат. Результаты можно фильтровать на основе сообщений электронной почты разработчика, тегов разработчиков и имен команд.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор турнира	tournament_id	True	string	Идентификатор турнира
report_period_in_days	report_period_in_days		integer	Количество дней в прошлом для отчета (допустимые значения — 1, 7 и 30 дней)
startdate	startdate		string	Доска лидеров разработчика завершена или после заданного времени. Формат: ГГГГ-ММ-DDTHH:mm:ss. SSSZ
enddate	enddate		string	Подготовка лидеров разработчика завершена до заданного времени или до этого времени. Формат: ГГГГ-ММ-DDTHH:mm:ss. SSSZ
users	users		string	Пользователи, включаемые в список лидеров (одно или несколько сообщений электронной почты пользователей, разделенные запятыми)
team_names	team_names		string	Имена команд (один или несколько имен команд, разделенные запятыми)
tags	tags		string	Теги пользователей (один или несколько тегов пользователей, разделенные запятыми)
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	Общее число результатов

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

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

UserSearch

Используется для получения всех записей пользователей. Ответ может быть сформирован путем передачи параметра запроса полей, в котором перечислены имена атрибутов для возврата. Фильтр достигается путем передачи критериев фильтра через текст.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Fields	fields		string	Массив полей. Возвращает только указанные атрибуты. Каждый атрибут должен быть разделен запятыми.
Страница	page		integer	Возвращает заданный номер страницы результирующий набор с разбивкой на страницы. Размер страницы — 1000 записей.
id	id		string	Идентификатор ресурса пользователя
электронная почта	email		string	Сообщение электронной почты пользователя
роль	role		string	Роль, назначенная пользователю, который является одним из разработчиков, руководителя группы или администратора компании
team	team		string	Команда, с которым связан пользователь
tags	tags		array of string	Любая информация об идентификации пользователя. Пример: кварталы головы, Asia-Pacific

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

Список UserData

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

UsersList

Показывает ресурсы обучения, которые будут завершены, прочитаны или просмотрированы

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

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	Общее число результатов

Получение Teams

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

TeamsGet

Эта конечная точка возвращает список объектов Team, содержащих диапазон точек данных, связанных с командами. Сюда входят идентификаторы групп, которые могут использоваться в сочетании с другими конечными точками API команды.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Страница	page		integer	Номер страницы результатов
Имя группы	name		string	Имя команды

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

Имя	Путь	Тип	Описание
teams	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	Общее число результатов

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

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

CourseGetURL

JSON, содержащий URL-адрес курса

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Языковая платформа	language_framework	True	string	Имя языка и платформы в формате Java::Spring
Курс	course	True	string	Имя конечно
Модуль	module	True	string	Имя модуля курса
Перенаправить	redirect		boolean	Перенаправляет пользователя на URL-адрес возврата

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

URL-адрес учебных курсов

URL-адрес курса

CourseURL

Получение времени

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

TimeGetSpent

Время, затраченное на платформу по оценкам, обучению, турнирам и обучению.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Страница	page		integer	Номер страницы результатов
Идентификатор	id		string	Фильтрация результатов на основе идентификатора пользователя в формате UUID
Адрес электронной почты	email		string	Фильтрация результатов на основе электронной почты
Метки	tags		string	Отфильтруйте базу результатов, чтобы отобразить пользователей с тегами. Указанные теги разделены запятыми и используют логику OR для фильтрации результатов.
Команда	team		string	Фильтрация результатов, чтобы показать, что пользователи принадлежат указанной команде
Дата начала	startdate		date-time	Отфильтруйте результаты, чтобы включить результаты с начала дня. Формат даты "ГГГГ-ММ-ДД". В формате UTC
Дата окончания	enddate		date-time	Отфильтруйте результаты, чтобы включить все результаты до конца дня. Формат даты "ГГГГ-ММ-ДД". В формате 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	Общее число результатов

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

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

CoursesGet

Эта конечная точка возвращает список объектов Course, содержащих диапазон точек данных, связанных с курсами. К ним относятся идентификаторы курсов, которые могут использоваться в сочетании с другими конечными точками 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	Общее число результатов

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

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

DeveloperGetActivity

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Страница	page		integer	Номер страницы результатов

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

Подробный журнал проблем за заданный период времени

Действие разработчика

DevelopersActivity

Получение лучших исполнителей действий

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

ActivityGetTopPerform

Это используется для получения списка наиболее выполняющихся пользователей.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Период отчета	report_period		integer	Количество дней для просмотра изменений в статистике
Количество пользователей	num_users		integer	Количество возвращаемых лучших исполнителей
Страница	page		integer	Номер страницы результатов
Метки	tags		string	Отфильтруйте результаты, чтобы отобразить верхние пеформеры для указанных тегов. Указанные теги разделены запятыми и используют логику OR для фильтрации результатов.
Команда	team		string	Фильтрация результатов для отображения лучших исполнителей для данной команды
Время начала	starttime		date-time	Включает точки из хода выполнения, завершенного или после заданного времени. Формат: ГГГГ-ММ-DDTHH:mm:ss. SSSZ
Время окончания	endtime		date-time	Включите точки из хода выполнения, завершенного до заданного времени. Формат: ГГГГ-ММ-DDTHH:mm:ss. SSSZ

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

Имя	Путь	Тип	Описание
schema	schema	TopPerformers	Список лучших исполнителей

Получение наиболее активного взаимодействия пользователей

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

UserGetMostEngaged

Эта конечная точка возвращает топ "N" наиболее заинтересованных пользователей.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Период отчета	report_period		integer	Количество дней, за которые нужно просмотреть наиболее заинтересованных пользователей (report_period следует указать только или с завершением).
Дата начала	startdate		string	Дата начала диапазона дат (не следует указывать с report_period). Формат: ГГГГ-ММ-DDTHH:mm:ss. SSSZ
Дата окончания	enddate		string	Дата окончания диапазона дат (должно быть больше начального значения). Формат: ГГГГ-ММ-DDTHH:mm:ss. SSSZ
Количество пользователей	number_of_users		integer	Первое число пользователей "N"
Имя группы	team_name		string	Имя группы
Метки	tags		string	Теги пользователей
Страница	page		integer	Номер страницы результатов

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

Большинство заинтересованных пользователей в компании

Тело

MostEngagedUsers

Получение наиболее активной деятельности группы

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

TeamGetMostEngaged

Эта конечная точка возвращает топ "N" наиболее заинтересованных команд.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Период отчета	report_period		integer	Количество дней, за которые нужно просмотреть большинство заинтересованных команд (report_period следует указать только или с завершением).
Дата начала	startdate		string	Дата начала диапазона дат (не следует указывать с report_period). Формат: ГГГГ-ММ-DDTHH:mm:ss. SSSZ
Дата окончания	enddate		string	Дата окончания диапазона дат (должно быть больше начального значения). Формат: ГГГГ-ММ-DDTHH:mm:ss. SSSZ
Количество команд	number_of_teams		integer	Первое число команд "N"
Метки	tags		string	Теги пользователей
Страница	page		integer	Номер страницы результатов

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

Большинство заинтересованных Teams в компании

Тело

MostEngagedTeams

Получение оценок

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

AssessmentsGet

Эта конечная точка возвращает список объектов оценки, содержащих диапазон точек данных, связанных с оценками. К ним относятся идентификаторы оценки, которые могут использоваться вместе с другими конечными точками API оценки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Страница	page		integer	Номер страницы результатов
Дата начала	startdate		date-time	Только возвращаемые оценки начинаются и после заданной даты. Формат: ГГГГ-ММ-DDTHH:mm:ss. SSSZ
Дата окончания	enddate		date-time	Только возвращаемые оценки, запущенные или завершенные до заданной даты. Формат: ГГГГ-ММ-DDTHH:mm:ss. SSSZ

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

Имя	Путь	Тип	Описание
assessments	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	Общее число результатов

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

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

UsersGet

Используется для получения всех записей пользователей. Ответ может быть сформирован путем передачи параметра запроса полей, в котором перечислены имена атрибутов для возврата.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Fields	fields		string	Массив полей. Возвращает только указанные атрибуты. Каждый атрибут должен быть разделен запятыми.
Страница	page		integer	Возвращает заданный номер страницы результирующий набор с разбивкой на страницы. Размер страницы — 1000 записей.

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

Список UserData

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

UsersList

Получение попыток оценки

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

AssessmentGetAttempts

Эта конечная точка возвращает подробный отчет для всех разработчиков, которые приняли оценку с указанным идентификатором. Область отчета может фильтроваться несколькими способами. Вы можете фильтровать результаты для данного разработчика, указав свой адрес электронной почты запросом. Если указана дата начала, включены только попытки, запущенные или завершенные после (и включая) эту дату. Если указана дата окончания, до включения этой даты будут включены только проблемы, запущенные или завершенные. Предоставление обоих значений указывает диапазон дат для фильтрации. Сюда входят все данные в сводном отчете и подробные сведения обо всех проблемах, которые являются частью оценки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор оценки	assessment_id	True	string	Идентификатор оценки
Страница	page		integer	Номер страницы результатов
Электронная почта разработчика	developer		string	Адрес электронной почты разработчика для фильтрации
Дата начала	startdate		date-time	Только попытки возврата начались и после заданной даты. Формат: ГГГГ-ММ-DDTHH:mm:ss. SSSZ
Дата окончания	enddate		date-time	Только попытки возврата начались или завершены до заданной даты. Формат: ГГГГ-ММ-DDTHH:mm:ss. SSSZ

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

Имя	Путь	Тип	Описание
Попыток	attempts	array of object	Попыток
Идентификатор	attempts._id	string	Идентификатор попытки оценки
Assessment	attempts._assessment	string	Оценка, к которой она принадлежит
Имя оценки	attempts.name	string	Имя оценки
Имя	attempts.developer.name	string	Имя разработчика (первый + средний + фамилия).
Адрес электронной почты	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	Указывает состояние задачи или оценки, которая может находиться в состоянии ожидания, выполнения или "вне досягаемости".
Language	attempts.language	string	Язык или платформа оценки. NULL = язык или платформа, не выбранные для оценки, поддерживающей несколько языков.
Запуск	attempts.started	string	Дата и время начала оценки.
Завершено	attempts.completed	string	Дата и время завершения оценки
Deadline	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	Общее число результатов.

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

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

LearningGetResources

Список ресурсов обучения

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

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

Получение сведений о команде

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

TeamGetDetails

Это используется для получения сведений о команде.

Параметры

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

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

Сведения о команде

Тело

TeamDetails

Получение сильных и слабых мест активности

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

ActivityGetStrengthsAndWeaknesses

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Тип целевого объекта	targetType		string	Тип целевого объекта. Значения по умолчанию зависят от области ключа API. Ключ отчета по умолчанию используется для организации. Ключ команды по умолчанию используется для команды.
Идентификатор целевого объекта	targetIdentifier		string	Целевой идентификатор (имя группы, электронная почта пользователя или идентификатор пользователя)
Идентификатор языка	languageId		string	Идентификатор языка
Языковая платформа	languageFramework		string	Языковая платформа
Страница	page		integer	Номер страницы результатов

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

Средние сильные и слабые места объекта

Тело

StrengthsAndWeaknesses

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

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

TournamentGetLeaderboard

Эта конечная точка возвращает список лидеров для одного турнира. К ним относятся все уровни, проблемы и этапы, в которые участвовал разработчик, с подробными метриками каждого из них.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор турнира	tournament_id	True	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	Общее число результатов

Получение таблицы лидеров группы

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

TeamGetLeaderboard

Эта конечная точка возвращает список всех команд в организации с текущими статистическими данными, а также изменения статистики за период отчета (это может быть 1, 7 или 30 дней).

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Период отчета	report_period		integer	Количество дней для просмотра изменений в статистике
Опущен неактивный	omitInactive		boolean	Если задано значение true, опущены все неактивные учетные записи из результатов
Страница	page		integer	Номер страницы результатов
Дата начала	startdate		date-time	Включите ход выполнения для панели лидеров, завершенной или после заданного времени. Формат: ГГГГ-ММ-DDTHH:mm:ss. SSSZ
Дата окончания	enddate		date-time	Включите ход выполнения для панели лидеров, завершенной до заданного времени или до этого времени. Формат: ГГГГ-ММ-DDTHH:mm:ss. SSSZ

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

response

array of TeamLeaderboard

Получение таблицы лидеров разработчиков

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

DeveloperGetLeaderboard

Эта конечная точка возвращает список всех разработчиков в организации с текущими статистиками, а также изменения статистики за период отчета (это может быть 1, 7 или 30 дней).

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Период отчета	report_period		integer	Количество дней для просмотра изменений в статистике
Страница	page		integer	Номер страницы результатов
Дата начала	startdate		date-time	Включите ход выполнения для панели лидеров, завершенной или после заданного времени. Формат: ГГГГ-ММ-DDTHH:mm:ss. SSSZ
Дата окончания	enddate		date-time	Включите ход выполнения для панели лидеров, завершенной до заданного времени или до этого времени. Формат: ГГГГ-ММ-DDTHH:mm:ss. SSSZ

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

Имя	Путь	Тип	Описание
список лидеров	leaderboard	array of object	список лидеров
Ранг	leaderboard.rank	integer	Окончательная позиция участника в турнире.
Имя	leaderboard.developer.name	string	Имя разработчика (первая + средняя + фамилия)
Адрес электронной почты	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
Заблокировано	leaderboard.blocked	boolean	Был ли этот участник заблокирован из турнира.
Минуты, потраченные	leaderboard.minutes_spent	integer	Сколько времени разработчик потратил на ответы (в минутах).
Language	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
Этапах	leaderboard.levels.challenges.stages	array of object	Этапах
число/номер	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	Общее число результатов.

Получение турниров

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

TournamentsGet

Эта конечная точка возвращает список турниров в компании.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Страница	page		integer	Номер страницы результатов
Название турнира	name		string	Имя турнира
Дата начала	startdate		date-time	Возвращаются только турниры, которые начинаются или после заданного времени. Формат: ГГГГ-ММ-DDTHH:mm:ss. SSSZ
Дата окончания	enddate		date-time	Возвращаются только турниры, которые завершают или до заданного времени. время: ГГГГ-ММ-ДДTHH:мм:сс. 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	Общее число результатов

Получение хода выполнения разработчика

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

DeveloperGetProgress

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Страница	page		integer	Номер страницы результатов

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

Это содержит ход выполнения каждого разработчика на каждом из языков, областей, уровней и квестов

Ход разработки

DevelopersProgress

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

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

CourseGetDevelopersProgress

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор курса	course_id	True	string	Идентификатор курса
Страница	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	Общее число результатов

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

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

UserGet

Используется для получения одной записи пользователя. Ответ может быть сформирован путем передачи параметра запроса полей, в котором перечислены имена атрибутов для возврата.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор	id	True	string	Идентификатор ресурса пользователя.
Тип идентификатора	idtype		string	Используется для классификации типа идентификатора пользователя в URL-адресе.
Fields	fields		string	Массив полей. Возвращает только атрибуты, указанные в фильтре. Каждый атрибут должен быть разделен запятыми.

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

Пользовательские данные

UserData

Попытки оценки поиска

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

AssessmentSearchAttempts

Эта конечная точка возвращает подробный отчет для всех разработчиков, которые приняли оценку с указанным идентификатором. Область отчета может фильтроваться несколькими способами. Вы можете фильтровать результаты по заданным разработчикам, указав их адреса электронной почты с помощью запроса. Если задано состояние, включены только попытки оценки с указанным состоянием. Если указано имя группы, включены только попытки оценки пользователей в этих командах. Если предоставляются теги, включены только попытки оценки пользователей с этими тегами. Если предоставляется pass_status, включаются только попытки оценки с указанными pass_status. Сюда входят все данные в сводном отчете и подробные сведения обо всех проблемах, которые являются частью оценки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
assessment_id	assessment_id		string	Идентификатор оценки
имя	name		string	Имя оценки
users	users		string	Пользователи пытаются выполнить оценку (одно или несколько сообщений электронной почты пользователей, разделенных запятыми)
статус	status		string	Состояние попытки оценки
team_names	team_names		string	Имена команд (один или несколько имен команд, разделенные запятыми)
tags	tags		string	Теги пользователей (один или несколько тегов пользователей, разделенные запятыми)
pass_status	pass_status		string	Состояние передачи попытки оценки
page	page		integer	Номер страницы результатов

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

Имя	Путь	Тип	Описание
Попыток	attempts	array of object	Попыток
Идентификатор	attempts._id	string	Идентификатор попытки оценки
Assessment	attempts._assessment	string	Оценка, к которой она принадлежит
Имя оценки	attempts.name	string	Имя оценки
Имя	attempts.developer.name	string	Имя разработчика (первый + средний + фамилия).
Адрес электронной почты	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	Указывает состояние задачи или оценки, которая может находиться в состоянии ожидания, выполнения или "вне досягаемости".
Language	attempts.language	string	Язык или платформа оценки. NULL = язык или платформа, не выбранные для оценки, поддерживающей несколько языков.
Запуск	attempts.started	string	Дата и время начала оценки.
Завершено	attempts.completed	string	Дата и время завершения оценки
Deadline	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	Общее число результатов.

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

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

UserCreate

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Отправить приглашение	sendInvite		boolean	Пометка для отключения напоминаний о приглашении и приглашении пользователей.
enabled	enabled		boolean	Состояние пользователей на платформе
электронная почта	email	True	string	Сообщение электронной почты пользователя
isProfileComplete	isProfileComplete		boolean	Преобразует свойства, необходимые для завершения профиля по мере необходимости. Если задано значение true properties "name.first" и "name.last", то при необходимости имя является необязательным.
первый	first		string	Имя пользователя. Обязательный, если для параметра isProfileComplete задано значение true
середина	middle		string	Имя промежуточного имени пользователя
последний	last		string	Фамилия пользователя. Обязательный, если для параметра isProfileComplete задано значение true
роль	role	True	string	Роль, назначенная пользователю, который является одним из разработчиков, руководителя группы или администратора компании
team	team		string	Команда, с которым связан пользователь
tags	tags		array of string	Любая информация об идентификации пользователя. Пример: кварталы головы, Asia-Pacific
_id	_id		string	Идентификатор языка
_каркас	_framework		string	Языковая платформа

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

Пользователь создан

UserCreated

Создать рабочую группу

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

TeamCreate

Это используется для создания команды.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
имя	name		string	Имя группы
tags	tags		array of string	Любая идентификация информации о команде. Пример: головной квартал, Азиатско-Тихоокеанский регион, инженерия
activeFrom	activeFrom		string	Команда Active From. Формат: ГГГГ-ММ-DDTHH:mm:ss. SSSZ
activeUntil	activeUntil		string	Команда активна до. Формат: ГГГГ-ММ-DDTHH:mm:ss. SSSZ
Языки	languages		array of string	Список языков группы, _id и _framework разделены двойными двоеточиями (::) и разделены запятыми (,)
подключениеmessage	onboardingmessage		string	Сообщение о команде на борту
type	type		string	Тип лицензии
granted	granted		integer	Предоставленные лицензии (допустимы только в том случае, если тип лицензии задан для использования)

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

Сведения о команде

Тело

TeamDetails

Удаление команды

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

TeamDelete

Используется для удаления команды.

Параметры

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

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

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

Тело

TeamDeleteResponse

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

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

UserDelete

Удаляет пользователя, на который ссылается указанный идентификатор.

Параметры

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

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

Удалено пользователем

UserDeleted

Ход выполнения курса поиска

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

DeveloperSearchProgress

Эта конечная точка возвращает ход выполнения всех разработчиков в организации.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Страница	page		integer	Номер страницы результатов
course_id	course_id		array of uuid	Массив конечного идентификатора
user_id	user_id		array of uuid	Массив идентификатора ресурса пользователя
статус	status		string	Состояние курса

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

Имя	Путь	Тип	Описание
данные	data	array of object
user_id	data.user_id	string	Идентификатор ресурса пользователя
статус	data.status	string	Состояние курса
точность	data.accuracy	integer	Процент правильных попыток
уверенность	data.confidence	integer	Соотношение попаданий, используемых для доступных подсказок
minutes_spent	data.minutes_spent	integer	Общее время в mimnutes, которое пользователь потратил на курс
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	Общее число результатов

Ход выполнения поиска разработчиков

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

DevelopersSearchProgress

Эта конечная точка возвращает ход обучения всех разработчиков в организации с текущей областью, уровнем и прогрессом поиска. В этом разделе также перечислены изменения хода выполнения разработчика за период отчета (которые могут быть 1, 7 или 30 дней) или заданный диапазон дат. Результаты можно фильтровать на основе сообщений электронной почты разработчика, тегов разработчиков и имен команд.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
report_period_in_days	report_period_in_days		integer	Количество дней в прошлом для отчета (допустимые значения — 1, 7 и 30 дней)
startdate	startdate		string	Ход выполнения разработчика завершен или после заданного времени. Формат: ГГГГ-ММ-DDTHH:mm:ss. SSSZ
enddate	enddate		string	Ход выполнения разработчика завершен или до заданного времени. Формат: ГГГГ-ММ-DDTHH:mm:ss. SSSZ
users	users		string	Пользователи, которые включаются в ход разработки (одно или несколько сообщений электронной почты пользователей, разделенные запятыми)
team_names	team_names		string	Имена команд (один или несколько имен команд, разделенные запятыми)
tags	tags		string	Теги пользователей (один или несколько тегов пользователей, разделенные запятыми)
page	page		integer	Номер страницы результатов

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

Это содержит ход выполнения каждого разработчика на каждом из языков, областей, уровней и квестов

Ход разработки

DevelopersProgress

Ход обучения поиска

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

LearningSearchProgress

Фильтры описания обучения — пользователи, команды и теги

Параметры

Имя	Ключ	Обязательно	Тип	Описание
users	users		string	Пользователи, которые включаются в процесс обучения (одно или несколько сообщений электронной почты пользователей, разделенных запятыми)
team_names	team_names		string	Имена команд (один или несколько имен команд, разделенные запятыми)
tags	tags		string	Теги пользователей (один или несколько тегов пользователей, разделенные запятыми)
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	Общее число результатов

Определения

Турнир

Имя	Путь	Тип	Описание
_id	_id	string	Идентификатор турнира
имя	name	string	Имя турнира
описание	description	string	Описание турнира
время начала	start_time	date-time	Время начала турнира
время окончания	end_time	date-time	Время окончания турнира
timezone	timezone	string	Часовой пояс, в котором проводится турнир

ТурнирParticipant

Имя	Путь	Тип	Описание
ранг	rank	integer	Окончательная позиция участника в турнире
Developer	developer	Developer	Сведения о отдельном разработчике
блокированный	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	Уровни задачи

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	Как долго разработчик потратил ответы (в минутах)
Этапах	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	Идентификатор оценки
статус	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	Идентификатор языка
_каркас	_framework	string	Языковая платформа

AssessmentAssignResponse

Ответ на назначение запроса POST

Имя	Путь	Тип	Описание
Пользователь	user	string	Идентификатор электронной почты пользователя
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	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	Время команды, затраченное

БольшинствоEngagedUsers

Большинство заинтересованных пользователей в компании

Имя	Путь	Тип	Описание
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	Количество неправильных вызовов

Developer

Сведения о отдельном разработчике

Имя	Путь	Тип	Описание
имя	name	string	Имя разработчика (первая + средняя + фамилия)
электронная почта	email	string	Адрес электронной почты разработчиков
member_since	member_since	date-time	Дата, когда разработчик стал членом
last_logged_in	last_logged_in	date-time	Дата последнего входа разработчика
статус	status	string	Текущее состояние учетной записи разработчика
компания	company	string	Название компании, в которую входит разработчик
team	team	string	Имя команды, в которую входит разработчик
tags	tags	array of string	Теги, связанные с этим разработчиком
roles	roles	string	Роли, которые у этого разработчика

РазработчикиProgress

Это содержит ход выполнения каждого разработчика на каждом из языков, областей, уровней и квестов

Имя	Путь	Тип	Описание
Разработчики	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	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_progress	realms.levels.quests.quest_progress	integer	процент завершенных квестов

РазработчикиActivity

Подробный журнал проблем за заданный период времени

Имя	Путь	Тип	Описание
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	Developer	Сведения о отдельном разработчике
Попытка вызова	challenge	ChallengeAttempt	Попытка deverloper в режиме обучения

ChallengeAttempt

Попытка deverloper в режиме обучения

Имя	Путь	Тип	Описание
language	language	string	Имя языковой платформы
царство	realm	string	Имя области
уровень	level	string	Имя уровня
поиски	quest	string	Имя квеста
категория	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, этап завершен или еще не выполнена попытка

НайтиVulnerability

Характер проблемы

Имя	Путь	Тип	Описание
attempt_index	attempt_index	integer	Количество попыток разработчика
статус	status	string	Результат задачи
max_score	max_score	integer	Максимальное количество точек, доступных для обнаружения уязвимости
счёт	score	integer	Точки, приобретенные для обнаружения уязвимости

ИдентификацияSolution

Характер проблемы

Имя	Путь	Тип	Описание
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	resource	array of string	Упорядоченный список категории и имени завершенного ресурса
time_completed	time_completed	date-time	Когда ресурс обучения был завершен

Ресурсная запись

Запись завершенных ресурсов обучения разработчика

Имя	Путь	Тип	Описание
Developer	profile	Developer	Сведения о отдельном разработчике
завершено	completed	array of CompletedResource	Все ресурсы обучения, завершенные пользователем

CourseURL

URL-адрес учебных курсов

Имя	Путь	Тип	Описание
URL-адрес	url	string	URL-адрес курса

TeamData

Имя	Путь	Тип	Описание
имя	name	string	Имя команды

UserData

Имя	Путь	Тип	Описание
id	id	string	Идентификатор ресурса пользователя
электронная почта	email	string	Сообщение электронной почты пользователя
роль	role	string	Роль, назначенная пользователю, который является одним из разработчиков, руководителя группы или администратора компании
первый	name.first		Имя (первое имя)
середина	name.middle		Отчество/второе имя
последний	name.last		Фамилия
статус	status	string	Состояние пользователя
дата приглашения	invite-date	date-time	Время последнего приглашения пользователя
дата последнего входа	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	Идентификатор ресурса Secure Code Warrior
код состояния	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
электронная почта	email	string	Электронная почта пользователя
первый	name.first	string	Имя пользователя
середина	name.middle	string	Имя промежуточного имени пользователя
последний	name.last	string	Фамилия пользователя
tags	tags	array of string	Теги пользователей
статус	status	string	Состояние пользователя
Данные группы	team	TeamData

UsersTimeSpent

Запись, показывающая действия пользователей.

Имя	Путь	Тип	Описание
id	id	string	Идентификатор пользователя в формате UUID
электронная почта	email	string	Электронная почта пользователя
первый	name.first	string	Имя пользователя
середина	name.middle	string	Имя промежуточного имени пользователя
последний	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	Время, затраченное на турниры
Обучение	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	integer	Уровень вероятности
итог	total	integer	Total
used	used	integer	Б/у

TeamDetails

Сведения о команде

Имя	Путь	Тип	Описание
id	id	string	Идентификатор команды
имя	name	string	Имя команды
tags	tags	array of string	Любая идентификация информации о команде. Пример: головной квартал, Азиатско-Тихоокеанский регион, инженерия
подключениеMessage	onboardingMessage	string	Сообщение о посадке для команды
статус	status	string	Состояние команды
memberJoinToken	memberJoinToken	string	Маркер присоединения к члену
companyName	companyName	string	Название компании
Языки	languages	array of string	Языки группы

TeamDeleteResponse

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

Имя	Путь	Тип	Описание
deleteStatus	deleteStatus	string	Состояние операции удаления

Курс

Имя	Путь	Тип	Описание
_id	_id	string	Идентификатор курса
имя	name	string	Имя курса
описание	description	string	Описание курса
статус	status	string	Состояние курса
supported_languages	supported_languages	array of string	Список языков и платформ, доступных для курса
срок	deadline	date-time	Дата окончания курса
создано пользователем	created_by	string	ResourceId автора курса

CourseDeveloperProgressEntry

Эта запись представляет ход выполнения курса разработчика

Имя	Путь	Тип	Описание
user_id	user_id	string	Идентификатор ресурса пользователя
статус	status	string	Состояние курса
точность	accuracy	integer	Процент правильных попыток
уверенность	confidence	integer	Соотношение попаданий, используемых для доступных подсказок
minutes_spent	minutes_spent	integer	Общее время в mimnutes, которое пользователь потратил на курс
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	Общее время в mimnutes, которое пользователь потратил на курс для языка
прогресс	progress	integer	Ход выполнения курса для языка
videos_watched	videos_watched	integer	Количество пользователей видео, просматриваемых на языке