Secure Code Warrior (Independent Publisher) (Versão prévia)
Esse conector do Secure Code Warrior(https://securecodewarrior.com) fornece acesso programático à plataforma de aprendizagem. O Secure Code Warrior torna a codificação segura uma experiência positiva e envolvente para os desenvolvedores à medida que aumentam suas habilidades de segurança de software. Com nossa plataforma de aprendizagem principal, orientamos cada codificador ao longo de seu próprio roteiro de aprendizagem preferencial, para que os desenvolvedores qualificados para segurança se tornem os super-heróis cotidianos do nosso mundo conectado.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Troy Taylor |
| URL | https://www.hitachisolutions.com |
| ttaylor@hitachisolutions.com |
| Metadados do conector | |
|---|---|
| Publicador | Soluções hitachi |
| Saiba mais sobre o Secure Code Warrior | https://docs.microsoft.com/connectors/securecodewarrior |
| Site | https://www.securecodewarrior.com/ |
| Política de privacidade | https://www.securecodewarrior.com/trust/privacy-policy |
| Categorias | Operações de TI |
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: todas as regiões
Parâmetros para criar conexão.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Token API | secureString | O token de API para essa api | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Atividade de desenvolvedores de pesquisa |
Esse ponto de extremidade retorna o log de desafio detalhado de todos os desenvolvedores dentro da organização, com pontuação de desafio, dificuldade e resultado do desafio do desenvolvedor. Isso também lista o log de desafios durante o período de relatório (que pode ser de 1, 7 ou 30 dias) ou um determinado intervalo de datas. Os resultados podem ser filtrados com base em emails do desenvolvedor, marcas de desenvolvedor e nomes de equipe. |
| Atribuir Avaliações |
Esse ponto de extremidade atribuirá a avaliação fornecida aos usuários/equipes especificados. Retorna uma lista de usuários que foram atribuídos à avaliação com seus emails, inviteUrl e status indicando se o email de convite foi enviado. |
| Atualizar detalhes da equipe |
Isso é usado para atualizar detalhes de uma equipe. |
| Atualizar Usuário |
Atualiza um usuário com os dados especificados. As marcas serão substituídas. |
| Avaliação de Pesquisa |
Esse ponto de extremidade retornará uma lista de objetos de Avaliação que contêm um intervalo de pontos de dados relacionados a avaliações. Isso inclui IDs de avaliação, que podem ser usadas em conjunto com os outros pontos de extremidade da API de avaliações. Os resultados podem ser filtrados com base no status, nome, linguagem com suporte e dificuldade. |
| Criar um usuário |
Cria um usuário. |
| Criar uma equipe |
Isso é usado para criar uma equipe. |
| Excluir equipe |
Isso é usado para excluir uma equipe. |
| Excluir usuário |
Exclui o usuário referenciado pela ID fornecida. |
| Mostra os recursos de aprendizagem que foram concluídos, lidos ou assistidos |
Descrição do aprendizado |
| Obter a atividade de equipe mais engajada |
Esse ponto de extremidade retorna as principais equipes 'N' mais engajadas. |
| Obter a atividade dos usuários mais engajada |
Esse ponto de extremidade retorna os principais 'N' usuários mais envolvidos. |
| Obter atividade do desenvolvedor |
Esse ponto de extremidade retorna o log de desafio detalhado de todos os desenvolvedores dentro da organização, com pontuação de desafio, dificuldade e resultado do desafio do desenvolvedor. |
| Obter avaliações |
Esse ponto de extremidade retornará uma lista de objetos de Avaliação que contêm um intervalo de pontos de dados relacionados a avaliações. Isso inclui IDs de avaliação, que podem ser usadas em conjunto com os outros pontos de extremidade da API de avaliações. |
| Obter detalhes da equipe |
Isso é usado para obter detalhes de uma equipe. |
| Obter o Placar de Líderes da Equipe |
Esse ponto de extremidade retorna uma lista de todas as equipes dentro da organização, com suas estatísticas atuais, bem como a alteração nas estatísticas durante o período de relatório (que pode ser de 1, 7 ou 30 dias). |
| Obter o Placar de Líderes do Desenvolvedor |
Esse ponto de extremidade retorna uma lista de todos os desenvolvedores dentro da organização, com suas estatísticas atuais, bem como a alteração nas estatísticas durante o período de relatório (que pode ser de 1, 7 ou 30 dias). |
| Obter o progresso de todos os desenvolvedores para o curso |
Esse ponto de extremidade retornará o progresso de todos os desenvolvedores para o curso especificado. |
| Obter o Teams |
Esse ponto de extremidade retornará uma lista de objetos da Equipe que contêm um intervalo de pontos de dados relacionados às equipes. Isso inclui IDs de equipe, que podem ser usadas em conjunto com os outros pontos de extremidade da API de equipe. |
| Obter os principais desempenhos da atividade |
Isso é usado para recuperar a lista de usuários com melhor desempenho. |
| Obter placar de líderes do torneio |
Esse ponto de extremidade retorna a tabela de classificação para um único torneio. Isso inclui todos os níveis, desafios e estágios dos quais o desenvolvedor participou, com métricas detalhadas de cada um. |
| Obter pontos fortes e fracos da atividade |
Esse ponto de extremidade retorna os pontos fortes e fracos médios de uma empresa, equipe ou usuário (dependendo do nível de granularidade da consulta) para um idioma específico ou todos os idiomas |
| Obter progresso do desenvolvedor |
Esse ponto de extremidade retorna o progresso de treinamento de todos os desenvolvedores dentro da organização, com o progresso atual do realm, do nível e da busca. |
| Obter recursos |
Lista de recursos de aprendizagem |
| Obter tempo gasto |
Tempo gasto na plataforma em Avaliações, Aprendizagem, Torneios e Treinamento. |
| Obter tentativas de avaliação |
Esse ponto de extremidade retorna um relatório detalhado para todos os desenvolvedores que fizeram a Avaliação com a ID fornecida. O escopo do relatório pode ser filtrado de várias maneiras. Você pode filtrar os resultados para um determinado desenvolvedor fornecendo seu endereço de email com a consulta. Se uma data de início for fornecida, somente as tentativas iniciadas ou concluídas após (e incluindo) essa data serão incluídas. Se uma data de término for fornecida, somente os desafios iniciados ou concluídos antes dessa data serão incluídos. Fornecer ambos indica um intervalo de datas para filtrar. Isso inclui todos os dados no relatório de resumo, além de detalhes sobre todos os desafios que fazem parte da avaliação. |
| Obter todos os cursos |
Esse ponto de extremidade retornará uma lista de objetos Course que contêm um intervalo de pontos de dados relacionados a cursos. Isso inclui IDs de curso, que podem ser usadas em conjunto com os outros pontos de extremidade da API do curso. |
| Obter torneios |
Esse ponto de extremidade retorna uma lista de torneios na empresa. |
| Obter URL do curso |
JSON que contém a URL do curso |
| Obter usuário |
Isso é usado para recuperar um único registro de usuário. A resposta pode ser moldada passando um parâmetro de consulta de campos listando os nomes de atributo a serem retornados. |
| Obter usuários |
Isso é usado para recuperar todos os registros de usuário. A resposta pode ser moldada passando um parâmetro de consulta de campos listando os nomes de atributo a serem retornados. |
| Pesquisar o progresso do aprendizado |
Filtros de descrição de aprendizagem – usuários, equipes e marcas |
| Pesquisar usuários |
Isso é usado para recuperar todos os registros de usuário. A resposta pode ser moldada passando um parâmetro de consulta de campos listando os nomes de atributo a serem retornados. O filtro é obtido passando os critérios de filtro pelo corpo. |
| Progresso dos desenvolvedores de pesquisa |
Esse ponto de extremidade retorna o progresso de treinamento de todos os desenvolvedores dentro da organização, com o progresso atual do realm, do nível e da busca. Isso também lista a alteração no progresso do desenvolvedor durante o período de relatório (que pode ser de 1, 7 ou 30 dias) ou um determinado intervalo de datas. Os resultados podem ser filtrados com base em emails do desenvolvedor, marcas de desenvolvedor e nomes de equipe. |
| Progresso dos desenvolvedores do curso de pesquisa |
Esse ponto de extremidade retorna o progresso do curso de todos os desenvolvedores dentro da organização. |
| Tabela de líderes do desenvolvedor de pesquisa |
Esse ponto de extremidade retorna uma lista de todos os desenvolvedores dentro da organização, com suas estatísticas atuais. Isso também lista a alteração nas estatísticas durante o período do relatório (que pode ser de 1, 7 ou 30 dias) ou um determinado intervalo de datas. Os resultados podem ser filtrados com base em emails do desenvolvedor, marcas de desenvolvedor e nomes de equipe. |
| Tabela de líderes do torneio de pesquisa |
Esse ponto de extremidade retorna a tabela de classificação para um único torneio. Isso inclui todos os níveis, desafios e estágios dos quais o desenvolvedor participou, com métricas detalhadas de cada um. Esse ponto de extremidade também pode retornar o placar de líderes durante um período de relatório (que pode ser de 1, 7 ou 30 dias) ou um determinado intervalo de datas. Os resultados podem ser filtrados com base em emails do desenvolvedor, marcas de desenvolvedor e nomes de equipe. |
| Tentativas de avaliação de pesquisa |
Esse ponto de extremidade retorna um relatório detalhado para todos os desenvolvedores que fizeram a Avaliação com a ID fornecida. O escopo do relatório pode ser filtrado de várias maneiras. Você pode filtrar os resultados para determinados desenvolvedores fornecendo seus endereços de email com a consulta. Se um status for fornecido, somente as tentativas de avaliação com o status especificado serão incluídas. Se os nomes da equipe forem fornecidos, somente as tentativas de avaliação de usuários dentro dessas equipes serão incluídas. Se as marcas forem fornecidas, somente as tentativas de avaliação de usuários com essas marcas serão incluídas. Se um pass_status for fornecido, somente as tentativas de avaliação com pass_status especificadas serão incluídas. Isso inclui todos os dados no relatório de resumo, além de detalhes sobre todos os desafios que fazem parte da avaliação. |
Atividade de desenvolvedores de pesquisa
Esse ponto de extremidade retorna o log de desafio detalhado de todos os desenvolvedores dentro da organização, com pontuação de desafio, dificuldade e resultado do desafio do desenvolvedor. Isso também lista o log de desafios durante o período de relatório (que pode ser de 1, 7 ou 30 dias) ou um determinado intervalo de datas. Os resultados podem ser filtrados com base em emails do desenvolvedor, marcas de desenvolvedor e nomes de equipe.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
report_period_in_days
|
report_period_in_days | integer |
O número de dias anteriores para relatar (valores válidos - 1, 7 e 30 dias) |
|
|
startdate
|
startdate | string |
logs de desafio do desenvolvedor concluídos em ou após o horário determinado. Formato: YYYY-MM-DDTHH:mm:ss. SSSZ |
|
|
enddate
|
enddate | string |
logs de desafio do desenvolvedor concluídos antes ou antes do horário especificado. Formato: YYYY-MM-DDTHH:mm:ss. SSSZ |
|
|
users
|
users | string |
Usuários a serem incluídos em logs de desafios (um ou mais emails de usuário, separados por vírgula) |
|
|
team_names
|
team_names | string |
Nomes de equipe (um ou mais nomes de equipe, separados por vírgula) |
|
|
tags
|
tags | string |
Marcas de usuário (uma ou mais marcas de usuário, separadas por vírgula) |
|
|
página
|
page | integer |
O número de página de resultados |
Retornos
Log detalhado de desafios para um determinado período de tempo
- Atividade do desenvolvedor
- DevelopersActivity
Atribuir Avaliações
Esse ponto de extremidade atribuirá a avaliação fornecida aos usuários/equipes especificados. Retorna uma lista de usuários que foram atribuídos à avaliação com seus emails, inviteUrl e status indicando se o email de convite foi enviado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da avaliação
|
assessment_id | True | string |
A ID da avaliação |
|
users
|
users | array of string |
Lista de usuários aos quais atribuir a avaliação |
|
|
equipes
|
teams | array of string |
Lista de equipes à qual atribuir a avaliação |
|
|
sendEmail
|
sendEmail | boolean |
Sinalizar para indicar se o email de convite de avaliação enviado na avaliação de atribuição (Padrão: true) |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
assessmentInvitations
|
assessmentInvitations | array of AssessmentAssignResponse |
Atualizar detalhes da equipe
Isso é usado para atualizar detalhes de uma equipe.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
team_id | True | string |
ID da equipe |
|
nome
|
name | string |
Nome da Equipe |
|
|
tags
|
tags | array of string |
Qualquer informação de identificação sobre a equipe. Exemplo: Head Quarters, Ásia-Pacífico, Engenharia |
|
|
status
|
status | string |
Status da equipe |
|
|
onboardingmessage
|
onboardingmessage | string |
Equipe na mensagem de embarque |
|
|
Idiomas
|
languages | array of string |
Lista de idiomas de equipe, _id e _framework separados por dois-pontos (::) e separados por vírgulas (,) |
Retornos
Detalhes da equipe
- Corpo
- TeamDetails
Atualizar Usuário
Atualiza um usuário com os dados especificados. As marcas serão substituídas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
A ID do recurso do usuário. |
|
Ignorar notificação se o SSO
|
skipNotifyIfSso | boolean |
Usado para desabilitar a alteração da notificação por email enviada ao usuário. |
|
|
email
|
O endereço de email do usuário |
|||
|
enabled
|
enabled | boolean |
Status dos usuários na plataforma |
|
|
função
|
role | string |
A função atribuída ao usuário que é um dos desenvolvedores, gerente de equipe ou administrador da empresa |
|
|
equipe
|
team | string |
A equipe à qual o usuário está associado |
|
|
tags
|
tags | array of string |
Qualquer informação de identificação sobre o usuário. Exemplo: Trimestres principais, Asia-Pacific |
|
|
_id
|
_id | string |
ID do idioma |
|
|
_estrutura
|
_framework | string |
Estrutura de Idiomas |
Retornos
- Usuário Atualizado
- UserUpdated
Avaliação de Pesquisa
Esse ponto de extremidade retornará uma lista de objetos de Avaliação que contêm um intervalo de pontos de dados relacionados a avaliações. Isso inclui IDs de avaliação, que podem ser usadas em conjunto com os outros pontos de extremidade da API de avaliações. Os resultados podem ser filtrados com base no status, nome, linguagem com suporte e dificuldade.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
status
|
status | string |
Status da avaliação |
|
|
nome
|
name | string |
Nome da avaliação |
|
|
_id
|
_id | string |
ID do idioma |
|
|
_estrutura
|
_framework | string |
Estrutura de linguagem |
|
|
dificuldade
|
difficulty | string |
Dificuldade de avaliação |
|
|
página
|
page | integer |
O número de página de resultados |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
avaliações
|
assessments | array of Assessment | |
|
total_pages
|
links.total_pages | integer |
O número total de páginas nos resultados |
|
results_per_page
|
links.results_per_page | integer |
O número máximo de resultados em cada página |
|
next_page
|
links.next_page | integer |
O número da página seguinte (se houver) |
|
prev_page
|
links.prev_page | integer |
O número da página anterior (se houver) |
|
total_results
|
links.total_results | integer |
O número total dos resultados |
Criar um usuário
Cria um usuário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Enviar Convite
|
sendInvite | boolean |
Sinalizar para desabilitar lembretes de convite e convite do usuário. |
|
|
enabled
|
enabled | boolean |
Status dos usuários na plataforma |
|
|
email
|
True | string |
O email do usuário |
|
|
isProfileComplete
|
isProfileComplete | boolean |
Converte as propriedades necessárias para a conclusão do perfil conforme necessário. Se definido como propriedades verdadeiras 'name.first' e 'name.last' conforme necessário, caso contrário, o nome será opcional |
|
|
primeiro
|
first | string |
Nome do usuário. Obrigatório se 'isProfileComplete' for definido como true |
|
|
meio
|
middle | string |
Nome do meio do usuário |
|
|
último
|
last | string |
Sobrenome do usuário. Obrigatório se 'isProfileComplete' for definido como true |
|
|
função
|
role | True | string |
A função atribuída ao usuário que é um dos desenvolvedores, gerente de equipe ou administrador da empresa |
|
equipe
|
team | string |
A equipe à qual o usuário está associado |
|
|
tags
|
tags | array of string |
Qualquer informação de identificação sobre o usuário. Exemplo: Trimestres principais, Asia-Pacific |
|
|
_id
|
_id | string |
ID do idioma |
|
|
_estrutura
|
_framework | string |
Estrutura de Idiomas |
Retornos
- Criado pelo usuário
- UserCreated
Criar uma equipe
Isso é usado para criar uma equipe.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
nome
|
name | string |
Nome da Equipe |
|
|
tags
|
tags | array of string |
Qualquer informação de identificação sobre a equipe. Exemplo: Head Quarters, Ásia-Pacífico, Engenharia |
|
|
activeFrom
|
activeFrom | string |
Team Active From. Formato: YYYY-MM-DDTHH:mm:ss. SSSZ |
|
|
activeUntil
|
activeUntil | string |
Equipe ativa até. Formato: YYYY-MM-DDTHH:mm:ss. SSSZ |
|
|
Idiomas
|
languages | array of string |
Lista de idiomas de equipe, _id e _framework separados por dois-pontos (::) e separados por vírgulas (,) |
|
|
onboardingmessage
|
onboardingmessage | string |
Equipe na mensagem de embarque |
|
|
tipo
|
type | string |
Tipo de licença |
|
|
concedido
|
granted | integer |
Licenças concedidas (válidas somente se o tipo de licença for definido como uso) |
Retornos
Detalhes da equipe
- Corpo
- TeamDetails
Excluir equipe
Isso é usado para excluir uma equipe.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
team_id | True | string |
ID da equipe |
Retornos
Resposta de exclusão de equipe
- Corpo
- TeamDeleteResponse
Excluir usuário
Exclui o usuário referenciado pela ID fornecida.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
A ID do recurso do usuário. |
Retornos
- Usuário Excluído
- UserDeleted
Mostra os recursos de aprendizagem que foram concluídos, lidos ou assistidos
Descrição do aprendizado
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
O número de página de resultados |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Desenvolvedores
|
developers | array of ResourceRecord | |
|
total_pages
|
links.total_pages | integer |
O número total de páginas nos resultados |
|
results_per_page
|
links.results_per_page | integer |
O número máximo de resultados em cada página |
|
next_page
|
links.next_page | integer |
O número da página seguinte (se houver) |
|
prev_page
|
links.prev_page | integer |
O número da página anterior (se houver) |
|
total_results
|
links.total_results | integer |
O número total dos resultados |
Obter a atividade de equipe mais engajada
Esse ponto de extremidade retorna as principais equipes 'N' mais engajadas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Período de Relatório
|
report_period | integer |
O número de dias para exibir a maioria das equipes envolvidas (report_period deve ser especificado sozinho ou com enddate) |
|
|
Data de Início
|
startdate | string |
Data de início do intervalo de datas (não deve ser especificada com report_period). Formato: YYYY-MM-DDTHH:mm:ss. SSSZ |
|
|
Data de Término
|
enddate | string |
Data de término do intervalo de datas (deve ser maior que iniciar). Formato: YYYY-MM-DDTHH:mm:ss. SSSZ |
|
|
Número de equipes
|
number_of_teams | integer |
Número 'N' superior de equipes |
|
|
Etiquetas
|
tags | string |
Marcas de usuário |
|
|
Página
|
page | integer |
O número de página de resultados |
Retornos
Equipes mais engajadas na empresa
- Corpo
- MostEngagedTeams
Obter a atividade dos usuários mais engajada
Esse ponto de extremidade retorna os principais 'N' usuários mais envolvidos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Período de Relatório
|
report_period | integer |
O número de dias para exibir a maioria dos usuários envolvidos (report_period deve ser especificado sozinho ou com enddate) |
|
|
Data de Início
|
startdate | string |
Data de início do intervalo de datas (não deve ser especificada com report_period). Formato: YYYY-MM-DDTHH:mm:ss. SSSZ |
|
|
Data de Término
|
enddate | string |
Data de término do intervalo de datas (deve ser maior que iniciar). Formato: YYYY-MM-DDTHH:mm:ss. SSSZ |
|
|
Número de usuários
|
number_of_users | integer |
Número 'N' superior de usuários |
|
|
Nome da Equipe
|
team_name | string |
Nome da Equipe |
|
|
Etiquetas
|
tags | string |
Marcas de usuário |
|
|
Página
|
page | integer |
O número de página de resultados |
Retornos
Usuários mais engajados na empresa
- Corpo
- MostEngagedUsers
Obter atividade do desenvolvedor
Esse ponto de extremidade retorna o log de desafio detalhado de todos os desenvolvedores dentro da organização, com pontuação de desafio, dificuldade e resultado do desafio do desenvolvedor.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
O número de página de resultados |
Retornos
Log detalhado de desafios para um determinado período de tempo
- Atividade do desenvolvedor
- DevelopersActivity
Obter avaliações
Esse ponto de extremidade retornará uma lista de objetos de Avaliação que contêm um intervalo de pontos de dados relacionados a avaliações. Isso inclui IDs de avaliação, que podem ser usadas em conjunto com os outros pontos de extremidade da API de avaliações.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
O número de página de resultados |
|
|
Data de Início
|
startdate | date-time |
Somente as avaliações de retorno iniciadas após a data determinada. Formato: YYYY-MM-DDTHH:mm:ss. SSSZ |
|
|
Data de Término
|
enddate | date-time |
Retornar somente as avaliações iniciadas ou concluídas antes da data determinada. Formato: YYYY-MM-DDTHH:mm:ss. SSSZ |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
avaliações
|
assessments | array of Assessment | |
|
total_pages
|
links.total_pages | integer |
O número total de páginas nos resultados |
|
results_per_page
|
links.results_per_page | integer |
O número máximo de resultados em cada página |
|
next_page
|
links.next_page | integer |
O número da página seguinte (se houver) |
|
prev_page
|
links.prev_page | integer |
O número da página anterior (se houver) |
|
total_results
|
links.total_results | integer |
O número total dos resultados |
Obter detalhes da equipe
Isso é usado para obter detalhes de uma equipe.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da equipe
|
team_id | True | string |
ID da equipe |
Retornos
Detalhes da equipe
- Corpo
- TeamDetails
Obter o Placar de Líderes da Equipe
Esse ponto de extremidade retorna uma lista de todas as equipes dentro da organização, com suas estatísticas atuais, bem como a alteração nas estatísticas durante o período de relatório (que pode ser de 1, 7 ou 30 dias).
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Período de Relatório
|
report_period | integer |
O número de dias para exibir as alterações nas estatísticas |
|
|
Omitir Inativo
|
omitInactive | boolean |
Quando definido como true, omitirá todas as contas inativas dos resultados |
|
|
Página
|
page | integer |
O número de página de resultados |
|
|
Data de Início
|
startdate | date-time |
Inclua o progresso do placar de líderes concluído em ou após o horário determinado. Formato: YYYY-MM-DDTHH:mm:ss. SSSZ |
|
|
Data de Término
|
enddate | date-time |
Inclua o progresso do placar de líderes concluído antes ou antes do horário especificado. Formato: YYYY-MM-DDTHH:mm:ss. SSSZ |
Retornos
- response
- array of TeamLeaderboard
Obter o Placar de Líderes do Desenvolvedor
Esse ponto de extremidade retorna uma lista de todos os desenvolvedores dentro da organização, com suas estatísticas atuais, bem como a alteração nas estatísticas durante o período de relatório (que pode ser de 1, 7 ou 30 dias).
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Período de Relatório
|
report_period | integer |
O número de dias para exibir as alterações nas estatísticas |
|
|
Página
|
page | integer |
O número de página de resultados |
|
|
Data de Início
|
startdate | date-time |
Inclua o progresso do placar de líderes concluído em ou após o horário determinado. Formato: YYYY-MM-DDTHH:mm:ss. SSSZ |
|
|
Data de Término
|
enddate | date-time |
Inclua o progresso do placar de líderes concluído antes ou antes do horário especificado. Formato: YYYY-MM-DDTHH:mm:ss. SSSZ |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
placar de líderes
|
leaderboard | array of object |
placar de líderes |
|
Classificação
|
leaderboard.rank | integer |
A posição final do participante dentro do torneio. |
|
Nome
|
leaderboard.developer.name | string |
O nome do desenvolvedor (primeiro + meio + sobrenome) |
|
Email
|
leaderboard.developer.email | string |
O endereço de email do desenvolvedor. |
|
Membro desde
|
leaderboard.developer.member_since | string |
A data em que o desenvolvedor se tornou membro. |
|
Última entrada
|
leaderboard.developer.last_logged_in | string |
A data em que o desenvolvedor fez logon pela última vez. |
|
Situação
|
leaderboard.developer.status | string |
O status atual da conta de desenvolvedor. |
|
Empresa
|
leaderboard.developer.company | string |
O nome da empresa do qual o desenvolvedor faz parte |
|
Equipe
|
leaderboard.developer.team | string |
O nome da equipe do qual o desenvolvedor faz parte. |
|
tags
|
leaderboard.developer.tags | array of string |
tags |
|
funções
|
leaderboard.developer.roles | array of string |
funções |
|
Blocked
|
leaderboard.blocked | boolean |
Se este participante foi bloqueado do torneio. |
|
Minutos Gastos
|
leaderboard.minutes_spent | integer |
Quanto tempo o desenvolvedor gastou respondendo (em minutos). |
|
Linguagem
|
leaderboard.language | string |
A linguagem/estrutura usada pelo participante. |
|
Pontos Máximos
|
leaderboard.max_points | integer |
A quantidade máxima de pontos disponíveis no torneio |
|
Pontos
|
leaderboard.points | integer |
A quantidade de pontos que o participante ganhou. |
|
Dicas usadas
|
leaderboard.hints_used | integer |
Número de dicas usadas pelo participante. |
|
Vidas Perdidas
|
leaderboard.lives_lost | integer |
O número de vidas que o participante perdeu durante o torneio. |
|
níveis
|
leaderboard.levels | array of object |
níveis |
|
nome
|
leaderboard.levels.name | string |
nome |
|
Desafios
|
leaderboard.levels.challenges | array of object |
Desafios |
|
número
|
leaderboard.levels.challenges.number | integer |
número |
|
categoria
|
leaderboard.levels.challenges.category | string |
categoria |
|
subcategory
|
leaderboard.levels.challenges.subcategory | string |
subcategory |
|
dificuldade
|
leaderboard.levels.challenges.difficulty | string |
dificuldade |
|
status
|
leaderboard.levels.challenges.status | string |
status |
|
max_points
|
leaderboard.levels.challenges.max_points | integer |
max_points |
|
Pontos
|
leaderboard.levels.challenges.points | integer |
Pontos |
|
codebase_size
|
leaderboard.levels.challenges.codebase_size | string |
codebase_size |
|
minutes_spent
|
leaderboard.levels.challenges.minutes_spent | integer |
minutes_spent |
|
fases
|
leaderboard.levels.challenges.stages | array of object |
fases |
|
número
|
leaderboard.levels.challenges.stages.number | integer |
número |
|
nome
|
leaderboard.levels.challenges.stages.name | string |
nome |
|
status
|
leaderboard.levels.challenges.stages.status | string |
status |
|
Pontos
|
leaderboard.levels.challenges.stages.points | integer |
Pontos |
|
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 |
|
Total de Páginas
|
links.total_pages | integer |
O número total de páginas nos resultados |
|
Resultados por Página
|
links.results_per_page | integer |
O número máximo de resultados em cada página. |
|
Próxima Página
|
links.next_page | integer |
O número da página seguinte (se houver). |
|
Página Anterior
|
links.prev_page | integer |
O número da página anterior (se houver). |
|
Total de resultados
|
links.total_results | integer |
O número total dos resultados. |
Obter o progresso de todos os desenvolvedores para o curso
Esse ponto de extremidade retornará o progresso de todos os desenvolvedores para o curso especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do Curso
|
course_id | True | string |
ID do Curso |
|
Página
|
page | integer |
O número de página de resultados |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
dados
|
data | array of CourseDeveloperProgressEntry | |
|
total_pages
|
links.total_pages | integer |
O número total de páginas nos resultados |
|
results_per_page
|
links.results_per_page | integer |
O número máximo de resultados em cada página |
|
next_page
|
links.next_page | integer |
O número da página seguinte (se houver) |
|
prev_page
|
links.prev_page | integer |
O número da página anterior (se houver) |
|
total_results
|
links.total_results | integer |
O número total dos resultados |
Obter o Teams
Esse ponto de extremidade retornará uma lista de objetos da Equipe que contêm um intervalo de pontos de dados relacionados às equipes. Isso inclui IDs de equipe, que podem ser usadas em conjunto com os outros pontos de extremidade da API de equipe.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
O número de página de resultados |
|
|
Nome da Equipe
|
name | string |
Nome da equipe |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
equipes
|
teams | array of TeamDetails | |
|
total_pages
|
links.total_pages | integer |
O número total de páginas nos resultados |
|
results_per_page
|
links.results_per_page | integer |
O número máximo de resultados em cada página |
|
next_page
|
links.next_page | integer |
O número da página seguinte (se houver) |
|
prev_page
|
links.prev_page | integer |
O número da página anterior (se houver) |
|
total_results
|
links.total_results | integer |
O número total dos resultados |
Obter os principais desempenhos da atividade
Isso é usado para recuperar a lista de usuários com melhor desempenho.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Período de Relatório
|
report_period | integer |
O número de dias para exibir as alterações nas estatísticas |
|
|
Número de usuários
|
num_users | integer |
O número de melhores artistas a serem retornados |
|
|
Página
|
page | integer |
O número de página de resultados |
|
|
Etiquetas
|
tags | string |
Filtre os resultados para mostrar os principais peformers para as marcas especificadas. As marcas especificadas são propagadas por vírgulas e usam a lógica OR para filtrar resultados. |
|
|
Equipe
|
team | string |
Filtrar os resultados para mostrar os melhores desempenhos para a equipe determinada |
|
|
Hora de Início
|
starttime | date-time |
Inclui pontos do progresso concluído em ou após o horário determinado. Formato: YYYY-MM-DDTHH:mm:ss. SSSZ |
|
|
Hora de Término
|
endtime | date-time |
Inclua pontos do progresso concluídos antes ou antes do horário determinado. Formato: YYYY-MM-DDTHH:mm:ss. SSSZ |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
esquema
|
schema | TopPerformers |
Lista dos principais artistas |
Obter placar de líderes do torneio
Esse ponto de extremidade retorna a tabela de classificação para um único torneio. Isso inclui todos os níveis, desafios e estágios dos quais o desenvolvedor participou, com métricas detalhadas de cada um.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do torneio
|
tournament_id | True | string |
A ID do torneio |
|
Página
|
page | integer |
O número de página de resultados |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
placar de líderes
|
leaderboard | array of TournamentParticipant | |
|
total_pages
|
links.total_pages | integer |
O número total de páginas nos resultados |
|
results_per_page
|
links.results_per_page | integer |
O número máximo de resultados em cada página |
|
next_page
|
links.next_page | integer |
O número da página seguinte (se houver) |
|
prev_page
|
links.prev_page | integer |
O número da página anterior (se houver) |
|
total_results
|
links.total_results | integer |
O número total dos resultados |
Obter pontos fortes e fracos da atividade
Esse ponto de extremidade retorna os pontos fortes e fracos médios de uma empresa, equipe ou usuário (dependendo do nível de granularidade da consulta) para um idioma específico ou todos os idiomas
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de destino
|
targetType | string |
Tipo de destino. Padrões, dependendo do escopo da chave de API. A chave de relatório usa como padrão a empresa. A chave de equipe usa como padrão a equipe. |
|
|
Identificador de destino
|
targetIdentifier | string |
Identificador de Destino (Nome da Equipe, Email do Usuário ou ID de Usuário) |
|
|
ID do idioma
|
languageId | string |
ID do idioma |
|
|
Estrutura de Idiomas
|
languageFramework | string |
Estrutura de Idiomas |
|
|
Página
|
page | integer |
O número de página de resultados |
Retornos
Objeto de pontos fortes e fracos médios
- Corpo
- StrengthsAndWeaknesses
Obter progresso do desenvolvedor
Esse ponto de extremidade retorna o progresso de treinamento de todos os desenvolvedores dentro da organização, com o progresso atual do realm, do nível e da busca.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
O número de página de resultados |
Retornos
Isso contém o progresso de cada desenvolvedor em cada linguagem, realms, níveis e missões
- Progresso do desenvolvedor
- DevelopersProgress
Obter recursos
Lista de recursos de aprendizagem
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
resources
|
resources | array of Resource |
Obter tempo gasto
Tempo gasto na plataforma em Avaliações, Aprendizagem, Torneios e Treinamento.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
O número de página de resultados |
|
|
ID
|
id | string |
Filtrar resultados com base na ID do usuário no formato UUID |
|
|
Email
|
string |
Filtrar resultados com base em email |
||
|
Etiquetas
|
tags | string |
Filtrar a base de resultados para mostrar os usuários com as marcas. As marcas especificadas são propagadas por vírgulas e usam a lógica OR para filtrar resultados. |
|
|
Equipe
|
team | string |
Filtrar resultados para mostrar que os usuários pertencem à equipe especificada |
|
|
Data de Início
|
startdate | date-time |
Filtre os resultados para incluir os resultados do início do dia. Formato de data 'YYYYY-MM-DD'. Em UTC |
|
|
Data de Término
|
enddate | date-time |
Filtre os resultados para incluir todos os resultados até o final do dia. Formato de data 'YYYYY-MM-DD'. Em UTC |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
users
|
users | array of UsersTimeSpent | |
|
total_pages
|
links.total_pages | integer |
O número total de páginas nos resultados |
|
results_per_page
|
links.results_per_page | integer |
O número máximo de resultados em cada página |
|
next_page
|
links.next_page | integer |
O número da página seguinte (se houver) |
|
prev_page
|
links.prev_page | integer |
O número da página anterior (se houver) |
|
total_results
|
links.total_results | integer |
O número total dos resultados |
Obter tentativas de avaliação
Esse ponto de extremidade retorna um relatório detalhado para todos os desenvolvedores que fizeram a Avaliação com a ID fornecida. O escopo do relatório pode ser filtrado de várias maneiras. Você pode filtrar os resultados para um determinado desenvolvedor fornecendo seu endereço de email com a consulta. Se uma data de início for fornecida, somente as tentativas iniciadas ou concluídas após (e incluindo) essa data serão incluídas. Se uma data de término for fornecida, somente os desafios iniciados ou concluídos antes dessa data serão incluídos. Fornecer ambos indica um intervalo de datas para filtrar. Isso inclui todos os dados no relatório de resumo, além de detalhes sobre todos os desafios que fazem parte da avaliação.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da avaliação
|
assessment_id | True | string |
A ID da avaliação |
|
Página
|
page | integer |
O número de página de resultados |
|
|
Email do desenvolvedor
|
developer | string |
O endereço de email do desenvolvedor no qual filtrar |
|
|
Data de Início
|
startdate | date-time |
Somente as tentativas de retorno iniciadas após a data determinada. Formato: YYYY-MM-DDTHH:mm:ss. SSSZ |
|
|
Data de Término
|
enddate | date-time |
Retornar somente as tentativas iniciadas ou concluídas antes da data determinada. Formato: YYYY-MM-DDTHH:mm:ss. SSSZ |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Tentativas
|
attempts | array of object |
Tentativas |
|
ID
|
attempts._id | string |
A ID da tentativa de avaliação |
|
Assessment
|
attempts._assessment | string |
A avaliação à qual pertence |
|
Nome da avaliação
|
attempts.name | string |
O nome da avaliação |
|
Nome
|
attempts.developer.name | string |
O nome do desenvolvedor (primeiro + meio + sobrenome). |
|
Email
|
attempts.developer.email | string |
O endereço de email do desenvolvedor. |
|
Membro desde
|
attempts.developer.member_since | string |
A data em que o desenvolvedor se tornou membro. |
|
Última entrada
|
attempts.developer.last_logged_in | string |
A data em que o desenvolvedor fez logon pela última vez. |
|
Situação
|
attempts.developer.status | string |
O status atual da conta de desenvolvedor. |
|
Empresa
|
attempts.developer.company | string |
O nome da empresa da qual o desenvolvedor faz parte. |
|
Equipe
|
attempts.developer.team | string |
O nome da equipe do qual o desenvolvedor faz parte. |
|
tags
|
attempts.developer.tags | array of string |
tags |
|
funções
|
attempts.developer.roles | array of string |
funções |
|
Situação
|
attempts.status | string |
Indica o status de um desafio/avaliação que pode estar pendente, em andamento, feita ou "fora de alcance". |
|
Linguagem
|
attempts.language | string |
O idioma/estrutura da avaliação. nulo = idioma/estrutura não selecionado para avaliação que dá suporte a mais de um idioma. |
|
Iniciado
|
attempts.started | string |
A data/hora em que a avaliação foi iniciada. |
|
Concluído
|
attempts.completed | string |
A data/hora em que a avaliação foi concluída |
|
Data limite
|
attempts.deadline | string |
A data/hora do prazo de avaliação. Se uma avaliação não tiver um limite de tempo, o prazo será nulo. |
|
Score
|
attempts.score | integer |
Pontuação de avaliação em %. |
|
Concluído em
|
attempts.completed_in | string |
O tempo necessário para concluir a tentativa de avaliação. |
|
Nota de aprovação
|
attempts.passing_grade | integer |
O percentual necessário para passar na avaliação. |
|
Status de Passagem
|
attempts.pass_status | string |
O status de aprovação da avaliação. |
|
Correto
|
attempts.progress.correct | integer |
O número de desafios corretos. |
|
Incorreto
|
attempts.progress.incorrect | integer |
O número de desafios incorretos. |
|
Número de desafios
|
attempts.progress.number_of_challenges | integer |
O número total de desafios. |
|
Concluído
|
attempts.progress.completed | integer |
A data/hora em que a avaliação foi concluída. |
|
Localizado
|
attempts.accuracy.located | integer |
O % de vulnerabilidades localizadas |
|
Identificado
|
attempts.accuracy.identified | integer |
O % de vulnerabilidades identificadas |
|
Correção
|
attempts.accuracy.fixed | integer |
O % de vulnerabilidades corrigido |
|
Desafios
|
attempts.challenges | array of object |
Desafios |
|
número
|
attempts.challenges.number | integer |
número |
|
categoria
|
attempts.challenges.category | string |
categoria |
|
subcategory
|
attempts.challenges.subcategory | string |
subcategory |
|
dificuldade
|
attempts.challenges.difficulty | string |
dificuldade |
|
status
|
attempts.challenges.status | string |
status |
|
max_score
|
attempts.challenges.max_score | integer |
max_score |
|
pontuação
|
attempts.challenges.score | integer |
pontuação |
|
status
|
attempts.challenges.locate.status | string |
status |
|
status
|
attempts.challenges.identify.status | string |
status |
|
status
|
attempts.challenges.fix.status | string |
status |
|
Total de Páginas
|
links.total_pages | integer |
O número total de páginas nos resultados. |
|
Resultados por Página
|
links.results_per_page | integer |
O número máximo de resultados em cada página. |
|
Próxima Página
|
links.next_page | integer |
O número da página seguinte (se houver). |
|
Página de pré-desenvolvimento
|
links.prev_page | integer |
O número da página anterior (se houver). |
|
Total de resultados
|
links.total_results | integer |
O número total dos resultados. |
Obter todos os cursos
Esse ponto de extremidade retornará uma lista de objetos Course que contêm um intervalo de pontos de dados relacionados a cursos. Isso inclui IDs de curso, que podem ser usadas em conjunto com os outros pontos de extremidade da API do curso.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
O número de página de resultados |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Cursos
|
courses | array of Course | |
|
total_pages
|
links.total_pages | integer |
O número total de páginas nos resultados |
|
results_per_page
|
links.results_per_page | integer |
O número máximo de resultados em cada página |
|
next_page
|
links.next_page | integer |
O número da página seguinte (se houver) |
|
prev_page
|
links.prev_page | integer |
O número da página anterior (se houver) |
|
total_results
|
links.total_results | integer |
O número total dos resultados |
Obter torneios
Esse ponto de extremidade retorna uma lista de torneios na empresa.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
O número de página de resultados |
|
|
Nome do torneio
|
name | string |
Nome do torneio |
|
|
Data de Início
|
startdate | date-time |
Só retorna torneios que começam em ou após o horário determinado. Formato: YYYY-MM-DDTHH:mm:ss. SSSZ |
|
|
Data de Término
|
enddate | date-time |
Só retorna torneios que terminam antes ou antes do horário determinado. time: YYYY-MM-DDTHH:mm:ss. SSSZ |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Torneios
|
tournaments | array of Tournament | |
|
total_pages
|
links.total_pages | integer |
O número total de páginas nos resultados |
|
results_per_page
|
links.results_per_page | integer |
O número máximo de resultados em cada página |
|
next_page
|
links.next_page | integer |
O número da página seguinte (se houver) |
|
prev_page
|
links.prev_page | integer |
O número da página anterior (se houver) |
|
total_results
|
links.total_results | integer |
O número total dos resultados |
Obter URL do curso
JSON que contém a URL do curso
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Estrutura de Idiomas
|
language_framework | True | string |
Nome da linguagem e da estrutura no formato "Java::Spring" |
|
Curso
|
course | True | string |
Nome, é claro |
|
Módulo
|
module | True | string |
Nome do módulo de curso |
|
Redirecionar
|
redirect | boolean |
Redireciona o usuário para a URL de retorno |
Retornos
URL para cursos de treinamento
- URL do curso
- CourseURL
Obter usuário
Isso é usado para recuperar um único registro de usuário. A resposta pode ser moldada passando um parâmetro de consulta de campos listando os nomes de atributo a serem retornados.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
A ID do recurso do usuário. |
|
Tipo de ID
|
idtype | string |
Usado para classificar o tipo de ID de usuário na URL. |
|
|
Fields
|
fields | string |
Uma matriz de campos. Retorna apenas os atributos especificados no Filtro. Cada atributo deve ser separado por vírgula. |
Retornos
- Dados do usuário
- UserData
Obter usuários
Isso é usado para recuperar todos os registros de usuário. A resposta pode ser moldada passando um parâmetro de consulta de campos listando os nomes de atributo a serem retornados.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Fields
|
fields | string |
Uma matriz de campos. Retorna apenas os atributos fornecidos. Cada atributo deve ser separado por vírgula. |
|
|
Página
|
page | integer |
Retorna o número de página determinado de um conjunto de resultados paginado. Tamanhos de página são 1000 registros. |
Retornos
Lista de UserData
- Lista de Usuários
- UsersList
Pesquisar o progresso do aprendizado
Filtros de descrição de aprendizagem – usuários, equipes e marcas
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
users
|
users | string |
Usuários a serem incluídos no progresso do aprendizado (um ou mais emails de usuário, separados por vírgula) |
|
|
team_names
|
team_names | string |
Nomes de equipe (um ou mais nomes de equipe, separados por vírgula) |
|
|
tags
|
tags | string |
Marcas de usuário (uma ou mais marcas de usuário, separadas por vírgula) |
|
|
página
|
page | integer |
O número de página de resultados |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Desenvolvedores
|
developers | array of ResourceRecord | |
|
total_pages
|
links.total_pages | integer |
O número total de páginas nos resultados |
|
results_per_page
|
links.results_per_page | integer |
O número máximo de resultados em cada página |
|
next_page
|
links.next_page | integer |
O número da página seguinte (se houver) |
|
prev_page
|
links.prev_page | integer |
O número da página anterior (se houver) |
|
total_results
|
links.total_results | integer |
O número total dos resultados |
Pesquisar usuários
Isso é usado para recuperar todos os registros de usuário. A resposta pode ser moldada passando um parâmetro de consulta de campos listando os nomes de atributo a serem retornados. O filtro é obtido passando os critérios de filtro pelo corpo.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Fields
|
fields | string |
Uma matriz de campos. Retorna apenas os atributos fornecidos. Cada atributo deve ser separado por vírgula. |
|
|
Página
|
page | integer |
Retorna o número de página determinado de um conjunto de resultados paginado. Tamanhos de página são 1000 registros. |
|
|
id
|
id | string |
ID do recurso do usuário |
|
|
email
|
string |
O email do usuário |
||
|
função
|
role | string |
A função atribuída ao usuário que é um dos desenvolvedores, gerente de equipe ou administrador da empresa |
|
|
equipe
|
team | string |
A equipe à qual o usuário está associado |
|
|
tags
|
tags | array of string |
Qualquer informação de identificação sobre o usuário. Exemplo: Trimestres principais, Asia-Pacific |
Retornos
Lista de UserData
- Lista de Usuários
- UsersList
Progresso dos desenvolvedores de pesquisa
Esse ponto de extremidade retorna o progresso de treinamento de todos os desenvolvedores dentro da organização, com o progresso atual do realm, do nível e da busca. Isso também lista a alteração no progresso do desenvolvedor durante o período de relatório (que pode ser de 1, 7 ou 30 dias) ou um determinado intervalo de datas. Os resultados podem ser filtrados com base em emails do desenvolvedor, marcas de desenvolvedor e nomes de equipe.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
report_period_in_days
|
report_period_in_days | integer |
O número de dias anteriores para relatar (valores válidos - 1, 7 e 30 dias) |
|
|
startdate
|
startdate | string |
progresso do desenvolvedor concluído em ou após o tempo determinado. Formato: YYYY-MM-DDTHH:mm:ss. SSSZ |
|
|
enddate
|
enddate | string |
progresso do desenvolvedor concluído antes ou antes do horário determinado. Formato: YYYY-MM-DDTHH:mm:ss. SSSZ |
|
|
users
|
users | string |
Usuários a serem incluídos no progresso do desenvolvedor (um ou mais emails de usuário, separados por vírgula) |
|
|
team_names
|
team_names | string |
Nomes de equipe (um ou mais nomes de equipe, separados por vírgula) |
|
|
tags
|
tags | string |
Marcas de usuário (uma ou mais marcas de usuário, separadas por vírgula) |
|
|
página
|
page | integer |
O número de página de resultados |
Retornos
Isso contém o progresso de cada desenvolvedor em cada linguagem, realms, níveis e missões
- Progresso do desenvolvedor
- DevelopersProgress
Progresso dos desenvolvedores do curso de pesquisa
Esse ponto de extremidade retorna o progresso do curso de todos os desenvolvedores dentro da organização.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
O número de página de resultados |
|
|
course_id
|
course_id | array of uuid |
Matriz de ID do curso |
|
|
user_id
|
user_id | array of uuid |
Matriz de ID de recurso do usuário |
|
|
status
|
status | string |
Status do curso |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
dados
|
data | array of object | |
|
user_id
|
data.user_id | string |
ID do recurso do usuário |
|
status
|
data.status | string |
Status do curso |
|
exatidão
|
data.accuracy | integer |
O percentual de tentativas corretas |
|
confiança
|
data.confidence | integer |
A proporção de ocorrências usadas para dicas disponíveis |
|
minutes_spent
|
data.minutes_spent | integer |
O tempo total em mimutos que o usuário gastou no curso |
|
first_completed_date
|
data.first_completed_date | date-time |
A data em que o primeiro idioma do curso foi concluído |
|
first_enrolled_date
|
data.first_enrolled_date | date-time |
A data em que o primeiro idioma do curso foi registrado |
|
progresso
|
data.progress | integer |
O progresso do curso |
|
Idiomas
|
data.languages | array of CourseDeveloperProgressLanguageEntry |
Lista de idiomas para o curso |
|
Convida
|
data.invites | array of CourseDeveloperProgressInviteEntry |
Lista de convites e lembretes |
|
total_pages
|
links.total_pages | integer |
O número total de páginas nos resultados |
|
results_per_page
|
links.results_per_page | integer |
O número máximo de resultados em cada página |
|
next_page
|
links.next_page | integer |
O número da página seguinte (se houver) |
|
prev_page
|
links.prev_page | integer |
O número da página anterior (se houver) |
|
total_results
|
links.total_results | integer |
O número total dos resultados |
Tabela de líderes do desenvolvedor de pesquisa
Esse ponto de extremidade retorna uma lista de todos os desenvolvedores dentro da organização, com suas estatísticas atuais. Isso também lista a alteração nas estatísticas durante o período do relatório (que pode ser de 1, 7 ou 30 dias) ou um determinado intervalo de datas. Os resultados podem ser filtrados com base em emails do desenvolvedor, marcas de desenvolvedor e nomes de equipe.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
report_period_in_days
|
report_period_in_days | integer |
O número de dias anteriores para relatar (valores válidos - 1, 7 e 30 dias) |
|
|
startdate
|
startdate | string |
placar de líderes do desenvolvedor concluído em ou após o horário determinado. Formato: YYYY-MM-DDTHH:mm:ss. SSSZ |
|
|
enddate
|
enddate | string |
placar de líderes do desenvolvedor concluído antes ou antes do horário especificado. Formato: YYYY-MM-DDTHH:mm:ss. SSSZ |
|
|
users
|
users | string |
Usuários a serem incluídos no placar de líderes (um ou mais emails de usuário, separados por vírgula) |
|
|
team_names
|
team_names | string |
Nomes de equipe (um ou mais nomes de equipe, separados por vírgula) |
|
|
tags
|
tags | string |
Marcas de usuário (uma ou mais marcas de usuário, separadas por vírgula) |
|
|
página
|
page | integer |
O número de página de resultados |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
placar de líderes
|
leaderboard | array of object |
placar de líderes |
|
Classificação
|
leaderboard.rank | integer |
A posição final do participante dentro do torneio. |
|
Nome
|
leaderboard.developer.name | string |
O nome do desenvolvedor (primeiro + meio + sobrenome). |
|
Email
|
leaderboard.developer.email | string |
O endereço de email dos desenvolvedores |
|
Membro desde
|
leaderboard.developer.member_since | string |
A data em que o desenvolvedor se tornou membro. |
|
Última entrada
|
leaderboard.developer.last_logged_in | string |
A data em que o desenvolvedor fez logon pela última vez. |
|
Situação
|
leaderboard.developer.status | string |
O status atual da conta de desenvolvedor. |
|
Empresa
|
leaderboard.developer.company | string |
O nome da empresa da qual o desenvolvedor faz parte. |
|
Equipe
|
leaderboard.developer.team | string |
O nome da equipe do qual o desenvolvedor faz parte. |
|
tags
|
leaderboard.developer.tags | array of string |
tags |
|
funções
|
leaderboard.developer.roles | array of string |
funções |
|
Blocked
|
leaderboard.blocked | boolean |
Se este participante foi bloqueado do torneio. |
|
Minutos Gastos
|
leaderboard.minutes_spent | integer |
Quanto tempo o desenvolvedor gastou respondendo (em minutos). |
|
Linguagem
|
leaderboard.language | string |
A linguagem/estrutura usada pelo participante. |
|
Pontos Máximos
|
leaderboard.max_points | integer |
A quantidade máxima de pontos disponíveis no torneio. |
|
Pontos
|
leaderboard.points | integer |
A quantidade de pontos que o participante ganhou. |
|
Dicas usadas
|
leaderboard.hints_used | integer |
Número de dicas usadas pelo participante. |
|
Vidas Perdidas
|
leaderboard.lives_lost | integer |
O número de vidas que o participante perdeu durante o torneio. |
|
níveis
|
leaderboard.levels | array of object |
níveis |
|
nome
|
leaderboard.levels.name | string |
nome |
|
Desafios
|
leaderboard.levels.challenges | array of object |
Desafios |
|
número
|
leaderboard.levels.challenges.number | integer |
número |
|
categoria
|
leaderboard.levels.challenges.category | string |
categoria |
|
subcategory
|
leaderboard.levels.challenges.subcategory | string |
subcategory |
|
dificuldade
|
leaderboard.levels.challenges.difficulty | string |
dificuldade |
|
status
|
leaderboard.levels.challenges.status | string |
status |
|
max_points
|
leaderboard.levels.challenges.max_points | integer |
max_points |
|
Pontos
|
leaderboard.levels.challenges.points | integer |
Pontos |
|
codebase_size
|
leaderboard.levels.challenges.codebase_size | string |
codebase_size |
|
minutes_spent
|
leaderboard.levels.challenges.minutes_spent | integer |
minutes_spent |
|
fases
|
leaderboard.levels.challenges.stages | array of object |
fases |
|
número
|
leaderboard.levels.challenges.stages.number | integer |
número |
|
nome
|
leaderboard.levels.challenges.stages.name | string |
nome |
|
status
|
leaderboard.levels.challenges.stages.status | string |
status |
|
Pontos
|
leaderboard.levels.challenges.stages.points | integer |
Pontos |
|
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 |
|
Total de Páginas
|
links.total_pages | integer |
O número total de páginas nos resultados. |
|
Resultados por Página
|
links.results_per_page | integer |
O número máximo de resultados em cada página. |
|
Próxima Página
|
links.next_page | integer |
O número da página seguinte (se houver). |
|
Página Anterior
|
links.prev_page | integer |
O número da página anterior (se houver). |
|
Total de resultados
|
links.total_results | integer |
O número total dos resultados. |
Tabela de líderes do torneio de pesquisa
Esse ponto de extremidade retorna a tabela de classificação para um único torneio. Isso inclui todos os níveis, desafios e estágios dos quais o desenvolvedor participou, com métricas detalhadas de cada um. Esse ponto de extremidade também pode retornar o placar de líderes durante um período de relatório (que pode ser de 1, 7 ou 30 dias) ou um determinado intervalo de datas. Os resultados podem ser filtrados com base em emails do desenvolvedor, marcas de desenvolvedor e nomes de equipe.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do torneio
|
tournament_id | True | string |
A ID do torneio |
|
report_period_in_days
|
report_period_in_days | integer |
O número de dias anteriores para relatar (valores válidos - 1, 7 e 30 dias) |
|
|
startdate
|
startdate | string |
placar de líderes do desenvolvedor concluído em ou após o horário determinado. Formato: YYYY-MM-DDTHH:mm:ss. SSSZ |
|
|
enddate
|
enddate | string |
placar de líderes do desenvolvedor concluído antes ou antes do horário especificado. Formato: YYYY-MM-DDTHH:mm:ss. SSSZ |
|
|
users
|
users | string |
Usuários a serem incluídos no placar de líderes (um ou mais emails de usuário, separados por vírgula) |
|
|
team_names
|
team_names | string |
Nomes de equipe (um ou mais nomes de equipe, separados por vírgula) |
|
|
tags
|
tags | string |
Marcas de usuário (uma ou mais marcas de usuário, separadas por vírgula) |
|
|
página
|
page | integer |
O número de página de resultados |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
placar de líderes
|
leaderboard | array of TournamentParticipant | |
|
total_pages
|
links.total_pages | integer |
O número total de páginas nos resultados |
|
results_per_page
|
links.results_per_page | integer |
O número máximo de resultados em cada página |
|
next_page
|
links.next_page | integer |
O número da página seguinte (se houver) |
|
prev_page
|
links.prev_page | integer |
O número da página anterior (se houver) |
|
total_results
|
links.total_results | integer |
O número total dos resultados |
Tentativas de avaliação de pesquisa
Esse ponto de extremidade retorna um relatório detalhado para todos os desenvolvedores que fizeram a Avaliação com a ID fornecida. O escopo do relatório pode ser filtrado de várias maneiras. Você pode filtrar os resultados para determinados desenvolvedores fornecendo seus endereços de email com a consulta. Se um status for fornecido, somente as tentativas de avaliação com o status especificado serão incluídas. Se os nomes da equipe forem fornecidos, somente as tentativas de avaliação de usuários dentro dessas equipes serão incluídas. Se as marcas forem fornecidas, somente as tentativas de avaliação de usuários com essas marcas serão incluídas. Se um pass_status for fornecido, somente as tentativas de avaliação com pass_status especificadas serão incluídas. Isso inclui todos os dados no relatório de resumo, além de detalhes sobre todos os desafios que fazem parte da avaliação.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
assessment_id
|
assessment_id | string |
A ID da avaliação |
|
|
nome
|
name | string |
O nome da avaliação |
|
|
users
|
users | string |
Usuários que tentam a avaliação (um ou mais emails de usuário, separados por vírgula) |
|
|
status
|
status | string |
Status da tentativa de avaliação |
|
|
team_names
|
team_names | string |
Nomes de equipe (um ou mais nomes de equipe, separados por vírgula) |
|
|
tags
|
tags | string |
Marcas de usuário (uma ou mais marcas de usuário, separadas por vírgula) |
|
|
pass_status
|
pass_status | string |
Status de aprovação da tentativa de avaliação |
|
|
página
|
page | integer |
O número de página de resultados |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Tentativas
|
attempts | array of object |
Tentativas |
|
ID
|
attempts._id | string |
A ID da tentativa de avaliação |
|
Assessment
|
attempts._assessment | string |
A avaliação à qual pertence |
|
Nome da avaliação
|
attempts.name | string |
O nome da avaliação |
|
Nome
|
attempts.developer.name | string |
O nome do desenvolvedor (primeiro + meio + sobrenome). |
|
Email
|
attempts.developer.email | string |
O endereço de email do desenvolvedor. |
|
Membro desde
|
attempts.developer.member_since | string |
A data em que o desenvolvedor se tornou membro. |
|
Última entrada
|
attempts.developer.last_logged_in | string |
A data em que o desenvolvedor fez logon pela última vez. |
|
Situação
|
attempts.developer.status | string |
O status atual da conta de desenvolvedor. |
|
Empresa
|
attempts.developer.company | string |
O nome da empresa da qual o desenvolvedor faz parte. |
|
Equipe
|
attempts.developer.team | string |
O nome da equipe do qual o desenvolvedor faz parte. |
|
tags
|
attempts.developer.tags | array of string |
tags |
|
funções
|
attempts.developer.roles | array of string |
funções |
|
Situação
|
attempts.status | string |
Indica o status de um desafio/avaliação que pode estar pendente, em andamento, feita ou "fora de alcance". |
|
Linguagem
|
attempts.language | string |
O idioma/estrutura da avaliação. nulo = idioma/estrutura não selecionado para avaliação que dá suporte a mais de um idioma. |
|
Iniciado
|
attempts.started | string |
A data/hora em que a avaliação foi iniciada. |
|
Concluído
|
attempts.completed | string |
A data/hora em que a avaliação foi concluída |
|
Data limite
|
attempts.deadline | string |
A data/hora do prazo de avaliação. Se uma avaliação não tiver um limite de tempo, o prazo será nulo. |
|
Score
|
attempts.score | integer |
Pontuação de avaliação em %. |
|
Concluído em
|
attempts.completed_in | string |
O tempo necessário para concluir a tentativa de avaliação. |
|
Nota de aprovação
|
attempts.passing_grade | integer |
O percentual necessário para passar na avaliação. |
|
Status de Passagem
|
attempts.pass_status | string |
O status de aprovação da avaliação. |
|
Correto
|
attempts.progress.correct | integer |
O número de desafios corretos. |
|
Incorreto
|
attempts.progress.incorrect | integer |
O número de desafios incorretos. |
|
Número de desafios
|
attempts.progress.number_of_challenges | integer |
O número total de desafios. |
|
Concluído
|
attempts.progress.completed | integer |
A data/hora em que a avaliação foi concluída. |
|
Localizado
|
attempts.accuracy.located | integer |
O % de vulnerabilidades localizadas |
|
Identificado
|
attempts.accuracy.identified | integer |
O % de vulnerabilidades identificadas |
|
Correção
|
attempts.accuracy.fixed | integer |
O % de vulnerabilidades corrigido |
|
Desafios
|
attempts.challenges | array of object |
Desafios |
|
número
|
attempts.challenges.number | integer |
número |
|
categoria
|
attempts.challenges.category | string |
categoria |
|
subcategory
|
attempts.challenges.subcategory | string |
subcategory |
|
dificuldade
|
attempts.challenges.difficulty | string |
dificuldade |
|
status
|
attempts.challenges.status | string |
status |
|
max_score
|
attempts.challenges.max_score | integer |
max_score |
|
pontuação
|
attempts.challenges.score | integer |
pontuação |
|
status
|
attempts.challenges.locate.status | string |
status |
|
status
|
attempts.challenges.identify.status | string |
status |
|
status
|
attempts.challenges.fix.status | string |
status |
|
Total de Páginas
|
links.total_pages | integer |
O número total de páginas nos resultados. |
|
Resultados por Página
|
links.results_per_page | integer |
O número máximo de resultados em cada página. |
|
Próxima Página
|
links.next_page | integer |
O número da página seguinte (se houver). |
|
Página de pré-desenvolvimento
|
links.prev_page | integer |
O número da página anterior (se houver). |
|
Total de resultados
|
links.total_results | integer |
O número total dos resultados. |
Definições
Torneio
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
_id
|
_id | string |
A ID do torneio |
|
nome
|
name | string |
O nome do torneio |
|
descrição
|
description | string |
A descrição do torneio |
|
hora de início
|
start_time | date-time |
A hora em que o torneio começa |
|
end_time
|
end_time | date-time |
A hora em que o torneio termina |
|
timezone
|
timezone | string |
O fuso horário em que o torneio está sendo realizado |
TournamentParticipant
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
classificar
|
rank | integer |
A posição final do participante dentro do torneio |
|
Desenvolvedor
|
developer | Developer |
Informações sobre um desenvolvedor individual |
|
bloqueado
|
blocked | boolean |
Se este participante foi bloqueado do tournnament |
|
minutes_spent
|
minutes_spent | integer |
Quanto tempo o desenvolvedor gastou respondendo (em minutos) |
|
linguagem
|
language | string |
A linguagem/estrutura usada pelo participante |
|
max_points
|
max_points | integer |
A quantidade máxima de pontos disponíveis no torneio |
|
Pontos
|
points | integer |
A quantidade de pontos que o participante ganhou |
|
hints_used
|
hints_used | integer |
Número de dicas que o participante usou |
|
lives_lost
|
lives_lost | integer |
O número de vidas que o participante perdeu durante o torneio |
|
níveis
|
levels | array of Level |
Os níveis do desafio |
Level
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string |
O nome do nível |
|
Desafios
|
challenges | array of object | |
|
número
|
challenges.number | integer |
O número do desafio (começa em 1) |
|
categoria
|
challenges.category | string |
A categoria de desafio |
|
subcategory
|
challenges.subcategory | string |
A subcategoria de desafio |
|
dificuldade
|
challenges.difficulty | string | |
|
Situação
|
challenges.status | Status |
Indica o status de um desafio/avaliação que pode estar pendente, em andamento, feita ou "fora de alcance" |
|
max_points
|
challenges.max_points | integer |
Os pontos máximos disponíveis para este desafio |
|
Pontos
|
challenges.points | integer |
Os pontos obtidos para este desafio |
|
codebase_size
|
challenges.codebase_size | string | |
|
minutes_spent
|
challenges.minutes_spent | integer |
Quanto tempo o desenvolvedor gastou respondendo (em minutos) |
|
fases
|
challenges.stages | array of Stage |
Etapa
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
número
|
number | integer |
O número do estágio |
|
nome
|
name | string |
O nome do estágio |
|
status
|
status | string |
O status da tentativa neste estágio |
|
Pontos
|
points | integer |
Pontos ganhos neste estágio |
|
max_points
|
max_points | integer |
Máximo de pontos disponíveis neste estágio |
|
minutes_spent
|
minutes_spent | integer |
Quanto tempo o desenvolvedor gastou respondendo (em minutos) |
|
lives_lost
|
lives_lost | integer |
O número de vidas perdidas neste estágio |
|
hints_used
|
hints_used | integer |
O número de dicas usadas neste estágio |
Assessment
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
_id
|
_id | string |
A ID da avaliação |
|
status
|
status | string |
O status da avaliação |
|
nome
|
name | string |
O nome da avaliação |
|
descrição
|
description | string |
A descrição da avaliação |
|
supported_languages
|
supported_languages | array of string |
Lista de idiomas/estruturas disponíveis para a avaliação |
|
dificuldade
|
difficulty | string |
A dificuldade da avaliação |
|
success_ratio
|
success_ratio | integer |
O percentual necessário para passar na avaliação |
|
emits_certificate
|
emits_certificate | boolean |
A avaliação está vinculada a um certificado? |
|
time_limit
|
time_limit | integer |
O limite de tempo da avaliação em milissegundos. nulo = sem limite de tempo |
|
start_date
|
start_date | date-time |
A data em que a avaliação é iniciada |
|
end_date
|
end_date | date-time |
A data em que a avaliação termina |
|
timezone
|
timezone | string |
O fuso horário da avaliação |
|
number_of_challenges
|
number_of_challenges | integer |
O número de desafios na avaliação |
|
self_assess
|
self_assess | boolean |
A avaliação é uma avaliação pública? |
|
retries_allowed
|
retries_allowed | boolean |
As novas tentativas são permitidas para esta avaliação? |
Situação
Indica o status de um desafio/avaliação que pode estar pendente, em andamento, feita ou "fora de alcance"
Indica o status de um desafio/avaliação que pode estar pendente, em andamento, feita ou "fora de alcance"
- Situação
- string
preferredDevLanguage
Preferência de idioma de desenvolvimento
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
_id
|
_id | string |
ID do idioma |
|
_estrutura
|
_framework | string |
Estrutura de Idiomas |
AssessmentAssignResponse
Resposta à avaliação atribuir solicitação POST
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
usuário
|
user | string |
ID de email do usuário |
|
inviteEmailSent
|
inviteEmailSent | boolean |
O email de convite foi enviado? |
|
inviteUrl
|
inviteUrl | string |
URL de convite de avaliação |
TeamLeaderboard
O placar de líderes da equipe contém todas as entradas do placar de líderes da equipe válidas durante o período de relatório determinado
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
report_period_in_days
|
report_period_in_days | integer |
O número de dias no passado para relatar |
|
placar de líderes
|
leaderboard | array of TeamLeaderboardEntry | |
|
total_pages
|
links.total_pages | integer |
O número total de páginas nos resultados |
|
results_per_page
|
links.results_per_page | integer |
O número máximo de resultados em cada página |
|
next_page
|
links.next_page | integer |
O número da página seguinte (se houver) |
|
prev_page
|
links.prev_page | integer |
O número da página anterior (se houver) |
|
total_results
|
links.total_results | integer |
O número total dos resultados |
TeamLeaderboardEntry
Uma entrada no placar de líderes da equipe
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
classificar
|
rank | integer |
A classificação da equipe no placar de líderes. |
|
nome
|
name | string |
O nome da equipe |
|
Desenvolvedores
|
developers | integer |
O número de desenvolvedores na equipe |
|
points_average
|
points_average | integer |
Os pontos médios da equipe |
|
points_total
|
points_total | integer |
O total de pontos da equipe |
|
exatidão
|
accuracy | integer |
Precisão da equipe (em %) |
|
confidence_level
|
confidence_level | integer |
Nível de confiança da equipe (em %) |
|
time_spent
|
time_spent | integer |
O total de minutos gastos pela equipe em desafios |
|
installed_sensei
|
installed_sensei | integer |
O número de desenvolvedores na equipe que instalaram o sensei |
|
Estatísticas durante o período de relatório
|
stats_over_report_period | StatsOverReportPeriod |
As estatísticas computadas para o período de relatório especificado |
MostEngagedTeams
Equipes mais engajadas na empresa
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
equipes
|
teams | array of TeamEntry |
Detalhes da equipe |
|
total_pages
|
links.total_pages | integer |
O número total de páginas nos resultados |
|
results_per_page
|
links.results_per_page | integer |
O número máximo de resultados em cada página |
|
next_page
|
links.next_page | integer |
O número da página seguinte (se houver) |
|
prev_page
|
links.prev_page | integer |
O número da página anterior (se houver) |
|
total_results
|
links.total_results | integer |
O número total dos resultados |
TeamEntry
Este objeto representa os detalhes da equipe
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string |
Nome da equipe |
|
status
|
status | string |
Status da equipe |
|
timeSpent
|
timeSpent | integer |
Tempo de equipe gasto |
MostEngagedUsers
Usuários mais engajados na empresa
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
users
|
users | array of UserEntry |
Detalhes do utilizador |
|
total_pages
|
links.total_pages | integer |
O número total de páginas nos resultados |
|
results_per_page
|
links.results_per_page | integer |
O número máximo de resultados em cada página |
|
next_page
|
links.next_page | integer |
O número da página seguinte (se houver) |
|
prev_page
|
links.prev_page | integer |
O número da página anterior (se houver) |
|
total_results
|
links.total_results | integer |
O número total dos resultados |
UserEntry
Este objeto representa os detalhes do usuário
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string |
Nome do utilizador |
|
status
|
status | string |
Status do usuário |
|
timeSpent
|
timeSpent | integer |
Tempo gasto pelo usuário |
StatsOverReportPeriod
As estatísticas computadas para o período de relatório especificado
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
points_gained
|
points_gained | integer |
O número de pontos que o desenvolvedor ganhou |
|
accuracy_change
|
accuracy_change | integer |
A alteração na precisão durante o período de relatório |
|
confidence_level_change
|
confidence_level_change | integer |
A alteração no nível de confiança durante o período de relatório |
|
minutes_spent
|
minutes_spent | integer |
Os minutos gastos pela equipe em desafios |
|
challenges_correct
|
challenges_correct | integer |
O número de desafios corretos |
|
challenges_incorrect
|
challenges_incorrect | integer |
O número de desafios incorretos |
Desenvolvedor
Informações sobre um desenvolvedor individual
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string |
O nome do desenvolvedor (primeiro + meio + sobrenome) |
|
email
|
string |
O endereço de email dos desenvolvedores |
|
|
member_since
|
member_since | date-time |
A data em que o desenvolvedor se tornou membro |
|
last_logged_in
|
last_logged_in | date-time |
A data em que o desenvolvedor fez logon pela última vez |
|
status
|
status | string |
O status atual da conta de desenvolvedor |
|
empresa
|
company | string |
O nome da empresa do qual o desenvolvedor faz parte |
|
equipe
|
team | string |
O nome da equipe do qual o desenvolvedor faz parte |
|
tags
|
tags | array of string |
As marcas associadas a esse desenvolvedor |
|
funções
|
roles | string |
As funções que esse desenvolvedor tem |
DevelopersProgress
Isso contém o progresso de cada desenvolvedor em cada linguagem, realms, níveis e missões
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Desenvolvedores
|
developers | array of DeveloperProgressEntry |
Lista de desenvolvedores que fizeram uma tentativa de treinamento |
|
total_pages
|
links.total_pages | integer |
O número total de páginas nos resultados |
|
results_per_page
|
links.results_per_page | integer |
O número máximo de resultados em cada página |
|
next_page
|
links.next_page | integer |
O número da página seguinte (se houver) |
|
prev_page
|
links.prev_page | integer |
O número da página anterior (se houver) |
|
total_results
|
links.total_results | integer |
O número total dos resultados |
DeveloperProgressEntry
Essa entrada representa um objeto no progresso de treinamento dos desenvolvedores que contém informações do desenvolvedor e o progresso de suas tentativas no modo de treinamento
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Desenvolvedor
|
developer | Developer |
Informações sobre um desenvolvedor individual |
|
Idiomas
|
languages | array of TrainingProgressEntry |
Lista de idiomas tentados pelo desenvolvedor no modo de treinamento |
TrainingProgressEntry
Entrada com progresso de conclusão em idiomas e lista de realms
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string |
Nome da estrutura de linguagem |
|
language_progress
|
language_progress | integer |
Porcentagem do idioma concluído |
|
Reinos
|
realms | array of object |
Lista de realms para cada idioma |
|
nome
|
realms.name | string |
Nome do realm |
|
realm_progress
|
realms.realm_progress | integer |
Porcentagem do realm concluído |
|
níveis
|
realms.levels | array of object |
Lista de níveis para cada realm |
|
nome
|
realms.levels.name | string |
Nome do nível |
|
level_progress
|
realms.levels.level_progress | integer |
Porcentagem do nível concluído |
|
Quests
|
realms.levels.quests | array of object |
Lista de missões para cada nível |
|
nome
|
realms.levels.quests.name | string |
Nome da busca |
|
quest_progress
|
realms.levels.quests.quest_progress | integer |
percentual de busca concluída |
DevelopersActivity
Log detalhado de desafios para um determinado período de tempo
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
activities
|
activities | array of ActivityEntry |
Lista de desenvolvedores que contêm uma lista de idiomas que contêm tentativas de desafio |
|
total_pages
|
links.total_pages | integer |
O número total de páginas nos resultados |
|
results_per_page
|
links.results_per_page | integer |
O número máximo de resultados em cada página |
|
next_page
|
links.next_page | integer |
O número da página seguinte (se houver) |
|
prev_page
|
links.prev_page | integer |
O número da página anterior (se houver) |
|
total_results
|
links.total_results | integer |
O número total dos resultados |
ActivityEntry
Esse objeto representa o desenvolvedor e suas tentativas de desafio
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Desenvolvedor
|
developer | Developer |
Informações sobre um desenvolvedor individual |
|
Tentativa de desafio
|
challenge | ChallengeAttempt |
Tentativa feita por deverloper no modo de treinamento |
ChallengeAttempt
Tentativa feita por deverloper no modo de treinamento
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
linguagem
|
language | string |
Nome da estrutura de linguagem |
|
reino
|
realm | string |
Nome do realm |
|
nível
|
level | string |
Nome do nível |
|
busca
|
quest | string |
Nome da busca |
|
categoria
|
category | string |
Nome da categoria do desafio |
|
subcategory
|
subcategory | string |
Nome da subcategoria do desafio |
|
dificuldade
|
difficulty | string |
Nível de dificuldade para o desafio |
|
iniciado
|
started | date-time |
O desafio de tempo foi iniciado |
|
concluído
|
completed | date-time |
Os desafios de tempo foram concluídos |
|
duration
|
duration | integer |
Tempo em segundos necessário para que o desafio fosse concluído |
|
status
|
status | string |
Status do desafio, com status incorreto em desafio com 1 ou mais estágios incorretos |
|
hints_used
|
hints_used | integer |
Número total de dicas dos estágios de desafio usados pelo desenvolvedor |
|
pontuação
|
score | integer |
Pontos adquiridos |
|
max_score
|
max_score | string |
Pontos máximos alcançáveis para o desafio |
|
Selecionar Vulnerabilidade
|
select_vulnerability | SelectVulnerability |
Natureza do desafio |
|
Localizar Vulnerabilidade
|
locate_vulnerability | LocateVulnerability |
Natureza do desafio |
|
Identificar solução
|
identify_solution | IdentifySolution |
Natureza do desafio |
SelectVulnerability
Natureza do desafio
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
attempt_index
|
attempt_index | integer |
Número de vezes que o desenvolvedor tentou o estágio |
|
status
|
status | string |
Resultado do desafio, out_of_reach status descreve um estágio ainda não tentado pelo desenvolvedor |
|
max_score
|
max_score | integer |
Máximo de pontos alcançáveis para selecionar a vulnerabilidade |
|
pontuação
|
score | integer |
Pontos adquiridos para selecionar a vulnerabilidade |
|
ignorada
|
skipped | boolean |
Quando definido como true, o estágio foi ignorado. Se o status for falso, o estágio foi concluído ou ainda não foi tentado |
Localizaçãovulnerabilidade
Natureza do desafio
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
attempt_index
|
attempt_index | integer |
Número de vezes que o desenvolvedor tentou o estágio |
|
status
|
status | string |
Resultado do desafio |
|
max_score
|
max_score | integer |
Pontos máximos alcançáveis para localizar a vulnerabilidade |
|
pontuação
|
score | integer |
Pontos adquiridos para localizar a vulnerabilidade |
IdentifySolution
Natureza do desafio
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
attempt_index
|
attempt_index | integer |
Número de vezes que o desenvolvedor tentou o estágio |
|
status
|
status | string |
Resultado do desafio |
|
max_score
|
max_score | integer |
Pontos máximos alcançáveis para identificar a solução |
|
pontuação
|
score | integer |
Pontos adquiridos para identificar a solução |
ResourceItem
Detalhes do item de recurso
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
nome
|
name | string |
Resource
Detalhes do recurso
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
nome
|
name | string | |
|
items
|
items | array of ResourceItem |
CompletedResource
Detalhes de um recurso de aprendizado concluído
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
recurso
|
resource | array of string |
Uma lista ordenada da categorização e do nome do recurso concluído |
|
time_completed
|
time_completed | date-time |
Quando o recurso de aprendizagem foi concluído |
Registro de recursos
Um registro dos recursos de aprendizagem concluídos de um desenvolvedor
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Desenvolvedor
|
profile | Developer |
Informações sobre um desenvolvedor individual |
|
concluído
|
completed | array of CompletedResource |
Todos os recursos de aprendizagem concluídos pelo usuário |
CourseURL
URL para cursos de treinamento
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
url
|
url | string |
URL para curso |
TeamData
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string |
Nome da equipe |
Dados do Usuário
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
A ID do recurso do usuário |
|
email
|
string |
O email do usuário |
|
|
função
|
role | string |
A função atribuída ao usuário que é um dos desenvolvedores, gerente de equipe ou administrador da empresa |
|
primeiro
|
name.first |
Nome |
|
|
meio
|
name.middle |
Nome do meio |
|
|
último
|
name.last |
Sobrenome |
|
|
status
|
status | string |
Status do usuário |
|
data do convite
|
invite-date | date-time |
Hora de quando o usuário foi convidado pela última vez |
|
data de último logon
|
last-login-date | date-time |
Última vez que o usuário fez logon |
|
Dados da equipe
|
team | TeamData | |
|
tags
|
tags | array of string |
Qualquer informação de identificação sobre o usuário. Exemplo: Trimestres principais, Asia-Pacific |
|
preferredDevLanguages
|
preferredDevLanguages | array of preferredDevLanguage |
Preferência de idiomas de desenvolvimento |
UserUpdated
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
código de status
|
statusCode | integer |
Código de status da mensagem de resposta de êxito |
|
mensagem
|
message | string |
Descrição da mensagem de resposta de êxito |
|
codificar
|
code | string |
Código guerreiro de código seguro |
UserCreated
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
Identificador de recurso do Secure Code Warrior |
|
código de status
|
statusCode | integer |
Código de status da mensagem de resposta de êxito |
|
mensagem
|
message | string |
Descrição da mensagem de resposta de êxito |
|
codificar
|
code | string |
Código guerreiro de código seguro |
UserDeleted
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
código de status
|
statusCode | integer |
Código de status da mensagem de resposta de êxito |
|
mensagem
|
message | string |
Descrição da mensagem de resposta de êxito |
|
codificar
|
code | string |
Código guerreiro de código seguro |
UsersList
Lista de UserData
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
users
|
users | array of UserData |
TopPerformers
Lista dos principais artistas
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
report_period_in_days
|
report_period_in_days | integer |
O número de dias no passado para relatar |
|
top_performers
|
top_performers | array of TopPerformer | |
|
total_pages
|
links.total_pages | integer |
O número total de páginas nos resultados |
|
results_per_page
|
links.results_per_page | integer |
O número máximo de resultados em cada página |
|
next_page
|
links.next_page | integer |
O número da página seguinte (se houver) |
|
prev_page
|
links.prev_page | integer |
O número da página anterior (se houver) |
|
total_results
|
links.total_results | integer |
O número total dos resultados |
TopPerformer
Usuário com melhor desempenho
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Pontos
|
points | integer |
Total de pontos ganhos em um período de tempo |
|
id
|
id | string |
ID do usuário no formato UUID |
|
email
|
string |
Email do usuário |
|
|
primeiro
|
name.first | string |
Nome do usuário |
|
meio
|
name.middle | string |
Nome do meio do usuário |
|
último
|
name.last | string |
Sobrenome do usuário |
|
tags
|
tags | array of string |
Marcas de usuário |
|
status
|
status | string |
Status do usuário |
|
Dados da equipe
|
team | TeamData |
UsersTimeSpent
Entrada mostrando a atividade dos usuários.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
ID do usuário no formato UUID |
|
email
|
string |
Email do usuário |
|
|
primeiro
|
name.first | string |
Nome do usuário |
|
meio
|
name.middle | string |
Nome do meio do usuário |
|
último
|
name.last | string |
Sobrenome do usuário |
|
tags
|
tags | array of string |
Marcas de usuário |
|
status
|
status | string |
Status do usuário |
|
Dados da equipe
|
team | TeamData | |
|
tempo gasto
|
time-spent | array of object |
Matriz de datas com o detalhamento do tempo gasto/atividade em um dia |
|
date
|
time-spent.date | date |
Data em UTC |
|
Avaliações
|
time-spent.activity.Assessments | integer |
Tempo gasto em Avaliações |
|
Aprendizado
|
time-spent.activity.Learning | integer |
Tempo gasto em Aprendizado |
|
Torneios
|
time-spent.activity.Tournaments | integer |
Tempo gasto em torneios |
|
Training
|
time-spent.activity.Training | integer |
Tempo gasto no treinamento |
StrengthsAndWeaknesses
Objeto de pontos fortes e fracos médios
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
auth
|
auth | AverageStrengthsAndWeaknessesEntry |
Esse objeto representa cada categoria de gerenciamento individual |
|
data_handling
|
data_handling | AverageStrengthsAndWeaknessesEntry |
Esse objeto representa cada categoria de gerenciamento individual |
|
configuração incorreta
|
misconfig | AverageStrengthsAndWeaknessesEntry |
Esse objeto representa cada categoria de gerenciamento individual |
|
Práticas
|
practices | AverageStrengthsAndWeaknessesEntry |
Esse objeto representa cada categoria de gerenciamento individual |
|
sensitive_data
|
sensitive_data | AverageStrengthsAndWeaknessesEntry |
Esse objeto representa cada categoria de gerenciamento individual |
|
outro
|
other | AverageStrengthsAndWeaknessesEntry |
Esse objeto representa cada categoria de gerenciamento individual |
AverageStrengthsAndWeaknessesEntry
Esse objeto representa cada categoria de gerenciamento individual
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Desafios
|
challenges | ChallengesEntry |
Dados de desafios |
|
Dicas
|
hints | HintsEntry |
Dados de dicas |
|
Pontos
|
points | integer |
Pontos |
|
timeSpent
|
timeSpent | integer |
Tempo gasto |
ChallengesEntry
Dados de desafios
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
tentou
|
attempted | integer |
Desafios tentados |
|
correto
|
correct | integer |
Correto da tentativa |
|
incorreto
|
incorrect | integer |
Incorreto da tentativa |
|
percentageCorrect
|
percentageCorrect | integer |
Porcentagem correta |
|
ratioCorrect
|
ratioCorrect | number |
Razão correta |
HintsEntry
Dados de dicas
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
nível de confiança
|
confidenceLevel | integer |
Nível de Confiança |
|
total
|
total | integer |
Total |
|
usados
|
used | integer |
Usado |
TeamDetails
Detalhes da equipe
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
ID da equipe |
|
nome
|
name | string |
Nome da equipe |
|
tags
|
tags | array of string |
Qualquer informação de identificação sobre a equipe. Exemplo: Head Quarters, Ásia-Pacífico, Engenharia |
|
onboardingMessage
|
onboardingMessage | string |
Na mensagem de embarque para a equipe |
|
status
|
status | string |
Status da equipe |
|
memberJoinToken
|
memberJoinToken | string |
Token de junção de membro |
|
CompanyName
|
companyName | string |
Nome da empresa |
|
Idiomas
|
languages | array of string |
Idiomas de equipe |
TeamDeleteResponse
Resposta de exclusão de equipe
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
deleteStatus
|
deleteStatus | string |
Status da operação de exclusão |
Curso
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
_id
|
_id | string |
A ID do curso |
|
nome
|
name | string |
O nome do curso |
|
descrição
|
description | string |
A descrição do curso |
|
status
|
status | string |
O status do curso |
|
supported_languages
|
supported_languages | array of string |
Lista de idiomas/estruturas disponíveis para o curso |
|
prazo
|
deadline | date-time |
A data em que o curso termina |
|
created_by
|
created_by | string |
A ResourceId do autor do curso |
CourseDeveloperProgressEntry
Esta entrada representa um progresso do curso do desenvolvedor
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
user_id
|
user_id | string |
ID do recurso do usuário |
|
status
|
status | string |
Status do curso |
|
exatidão
|
accuracy | integer |
O percentual de tentativas corretas |
|
confiança
|
confidence | integer |
A proporção de ocorrências usadas para dicas disponíveis |
|
minutes_spent
|
minutes_spent | integer |
O tempo total em mimutos que o usuário gastou no curso |
|
first_completed_date
|
first_completed_date | date-time |
A data em que o primeiro idioma do curso foi concluído |
|
first_enrolled_date
|
first_enrolled_date | date-time |
A data em que o primeiro idioma do curso foi registrado |
|
progresso
|
progress | integer |
O progresso do curso |
|
Idiomas
|
languages | array of CourseDeveloperProgressLanguageEntry |
Lista de idiomas para o curso |
|
Convida
|
invites | array of CourseDeveloperProgressInviteEntry |
Lista de convites e lembretes |
CourseDeveloperProgressInviteEntry
Essa entrada representa convites e lembretes de progresso do curso do desenvolvedor.
Essa entrada representa convites e lembretes de progresso do curso do desenvolvedor.
CourseDeveloperProgressLanguageEntry
Esta entrada representa um progresso do curso do desenvolvedor para um único idioma
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
linguagem
|
language | string |
A linguagem de programação |
|
status
|
status | string |
O status do idioma do curso |
|
exatidão
|
accuracy | integer |
O percentual de tentativas corretas para o idioma |
|
confiança
|
confidence | integer |
A proporção de ocorrências usadas para dicas disponíveis para o idioma |
|
minutes_spent
|
minutes_spent | integer |
O tempo total em mimutos que o usuário gastou no curso para o idioma |
|
progresso
|
progress | integer |
O progresso do curso para o idioma |
|
videos_watched
|
videos_watched | integer |
A quantidade de vídeos que o usuário assistiu para o idioma |