Secure Code Warrior (Editora Independente) (Visualização)
Este conector 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 a nossa principal Plataforma de Aprendizagem, guiamos cada programador ao longo do seu próprio caminho de aprendizagem preferido, para que os programadores qualificados em segurança se tornem os super-heróis do dia-a-dia do nosso mundo conectado.
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | Premium | Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Automatize o poder | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Troia Taylor |
| URL | https://www.hitachisolutions.com |
| ttaylor@hitachisolutions.com |
| Metadados do conector | |
|---|---|
| Editora | Soluções Hitachi |
| Saiba mais sobre o Secure Code Warrior | https://docs.microsoft.com/connectors/securecodewarrior |
| Sítio Web | https://www.securecodewarrior.com/ |
| Política de privacidade | https://www.securecodewarrior.com/trust/privacy-policy |
| Categorias | Operações de TI |
A criar uma ligação
O conector suporta os seguintes tipos de autenticação:
| Predefinição | 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.
Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Chave de API | securestring | O token da API para esta api | Verdade |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Atribuir avaliações |
Este ponto de extremidade atribuirá a avaliação dada aos usuários/equipes especificados. Retorna uma lista de usuários que foram atribuídos à avaliação com seu e-mail, inviteUrl e status indicando se o e-mail de convite foi enviado. |
| Atualizar detalhes da equipa |
Isso é usado para atualizar os detalhes de uma equipe. |
| Atualizar usuário |
Atualiza um usuário com os dados fornecidos. As tags 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 usados em conjunto com os outros pontos de extremidade da API de avaliações. Os resultados podem ser filtrados com base no status, nome, idioma suportado e dificuldade. |
| Criar um utilizador |
Cria um usuário. |
| Criar uma equipa |
Isso é usado para criar uma equipe. |
| Excluir equipe |
Isso é usado para excluir uma equipe. |
| Excluir usuário |
Exclui o usuário referenciado pelo ID fornecido. |
| Faça com que a atividade dos usuários seja mais engajada |
Este ponto de extremidade retorna os principais 'N' usuários mais engajados. |
| Mostra recursos de aprendizagem que foram concluídos, lidos ou assistidos |
Descrição da aprendizagem |
| Obtenha a atividade da equipe mais engajada |
Este endpoint devolve as 'N' equipas mais envolvidas. |
| Obtenha equipas |
Esse ponto de extremidade retornará uma lista de objetos Team que contêm um intervalo de pontos de dados relacionados a equipes. Isso inclui IDs de equipe, que podem ser usados em conjunto com os outros pontos de extremidade da API da equipe. |
| Obtenha o Developer Leaderboard |
Este 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 do relatório (que pode ser de 1, 7 ou 30 dias). |
| Obtenha o progresso de todos os desenvolvedores para o curso |
Este ponto de extremidade retornará o progresso de todos os desenvolvedores para o curso especificado. |
| Obtenha o progresso do desenvolvedor |
Este endpoint retorna o progresso do treinamento de todos os desenvolvedores dentro da organização, com o realm, o nível e o progresso da missão atuais. |
| Obtenha os melhores desempenhos da atividade |
Isso é usado para recuperar a lista de usuários com melhor desempenho. |
| Obtenha tempo gasto |
Tempo gasto na plataforma em Avaliações, Aprendizagem, Torneios e Treinamento. |
| Obter atividade do desenvolvedor |
Este endpoint retorna o log de desafio detalhado de todos os desenvolvedores dentro da organização, com pontuação de desafio, dificuldade e resultado de 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 usados em conjunto com os outros pontos de extremidade da API de avaliações. |
| Obter detalhes da equipa |
Isso é usado para obter detalhes de uma equipe. |
| 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 recursos |
Lista de recursos de aprendizagem |
| Obter Tabela de Líderes de Equipas |
Este endpoint retorna uma lista de todas as equipes dentro da organização, com suas estatísticas atuais, bem como a mudança nas estatísticas durante o período do relatório (que pode ser de 1, 7 ou 30 dias). |
| Obter Tabela de Líderes de Torneios |
Este ponto final devolve a tabela de classificação de um único torneio. Isso inclui todos os níveis, desafios e estágios em que o desenvolvedor participou, com métricas detalhadas de cada um. |
| Obter tentativas de avaliação |
Este ponto de extremidade retorna um relatório detalhado para todos os desenvolvedores que fizeram a Avaliação com a ID fornecida. O âmbito do relatório pode ser filtrado de várias formas. Você pode filtrar os resultados para um determinado desenvolvedor, fornecendo seu endereço de e-mail com a consulta. Se uma data de início for fornecida, apenas as tentativas iniciadas ou concluídas após (e incluindo) essa data serão incluídas. Se uma data de término for fornecida, apenas os desafios iniciados ou concluídos antes dessa data serão incluídos. O fornecimento de ambos indica um intervalo de datas para filtrar. Isso inclui todos os dados do relatório de síntese, 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 do curso que contêm uma variedade de pontos de dados relacionados aos cursos. Isso inclui IDs de curso, que podem ser usadas em conjunto com os outros pontos de extremidade da API do curso. |
| Obter Torneios |
Este endpoint devolve uma lista de torneios na empresa. |
| Obter URL do curso |
JSON contendo 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 atributos a serem retornados. |
| Obter usuários |
Isso é usado para recuperar todos os registros do usuário. A resposta pode ser moldada passando um parâmetro de consulta de campos listando os nomes de atributos a serem retornados. |
| Pesquisar atividade de desenvolvedores |
Este endpoint retorna o log de desafio detalhado de todos os desenvolvedores dentro da organização, com pontuação de desafio, dificuldade e resultado de desafio do desenvolvedor. Isso também lista o log de desafios 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 e-mails de desenvolvedores, tags de desenvolvedores e nomes de equipes. |
| Pesquisar o progresso dos desenvolvedores |
Este endpoint retorna o progresso do treinamento de todos os desenvolvedores dentro da organização, com o realm, o nível e o progresso da missão atuais. Isso também lista a alteração no progresso do desenvolvedor 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 e-mails de desenvolvedores, tags de desenvolvedores e nomes de equipes. |
| Pesquisar o progresso dos desenvolvedores de cursos |
Este ponto de extremidade retorna o progresso do curso de todos os desenvolvedores dentro da organização. |
| Pesquisar Progresso de Aprendizagem |
Descrição de aprendizagem Filtros - utilizadores, equipas e etiquetas |
| Pesquisar Tabela de Líderes de Torneios |
Este ponto final devolve a tabela de classificação de um único torneio. Isso inclui todos os níveis, desafios e estágios em que o desenvolvedor participou, com métricas detalhadas de cada um. Esse ponto de extremidade também pode retornar a tabela de classificação 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 e-mails de desenvolvedores, tags de desenvolvedores e nomes de equipes. |
| Pesquisar Utilizadores |
Isso é usado para recuperar todos os registros do usuário. A resposta pode ser moldada passando um parâmetro de consulta de campos listando os nomes de atributos a serem retornados. O filtro é obtido passando os critérios de filtro através do corpo. |
| Tabela de Líderes do Desenvolvedor de Pesquisa |
Este ponto de extremidade retorna uma lista de todos os desenvolvedores dentro da organização, com suas estatísticas atuais. Isso também lista a mudança 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 e-mails de desenvolvedores, tags de desenvolvedores e nomes de equipes. |
| Tentativas de avaliação de pesquisa |
Este ponto de extremidade retorna um relatório detalhado para todos os desenvolvedores que fizeram a Avaliação com a ID fornecida. O âmbito do relatório pode ser filtrado de várias formas. Você pode filtrar os resultados para determinado desenvolvedor(es) fornecendo o(s) seu(s) endereço(s) de e-mail com a consulta. Se um status for fornecido, somente as tentativas de avaliação com status especificado serão incluídas. Se o(s) nome(s) da equipe fornecido(s), apenas as tentativas de avaliação dos usuários dentro da(s) equipe(s) serão incluídas. Se a(s) tag(s) for fornecida(s), apenas as tentativas de avaliação dos usuários com essa(s) tag(s) serão incluídas. Se um pass_status for fornecido, apenas as tentativas de avaliação com pass_status especificadas serão incluídas. Isso inclui todos os dados do relatório de síntese, além de detalhes sobre todos os desafios que fazem parte da avaliação. |
Atribuir avaliações
Este ponto de extremidade atribuirá a avaliação dada aos usuários/equipes especificados. Retorna uma lista de usuários que foram atribuídos à avaliação com seu e-mail, inviteUrl e status indicando se o e-mail de convite foi enviado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da avaliação
|
assessment_id | True | string |
O ID da avaliação |
|
users
|
users | array of string |
Lista de usuários aos quais atribuir a avaliação |
|
|
Equipas
|
teams | array of string |
Lista de equipas às quais atribuir a avaliação |
|
|
enviar e-mail
|
sendEmail | boolean |
Sinalizar para indicar se a avaliação convida e-mail enviado na atribuição de avaliação (Padrão: true) |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
avaliaçãoConvites
|
assessmentInvitations | array of AssessmentAssignResponse |
Atualizar detalhes da equipa
Isso é usado para atualizar os detalhes de uma equipe.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da Equipa
|
team_id | True | string |
ID da Equipa |
|
nome
|
name | string |
Nome da Equipa |
|
|
tags
|
tags | array of string |
Qualquer informação de identificação sobre a equipa. Exemplo: Sede, Ásia-Pacífico, Engenharia |
|
|
estado
|
status | string |
Estado da Equipa |
|
|
onboardingmensagem
|
onboardingmessage | string |
Mensagem de Integração da Equipa |
|
|
Idiomas
|
languages | array of string |
Lista de idiomas da equipe, _id e _framework separados por dois pontos duplos (::) e separados por vírgulas (,) |
Devoluções
Detalhes da Equipa
- Body
- TeamDetails
Atualizar usuário
Atualiza um usuário com os dados fornecidos. As tags serão substituídas.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
O ID do recurso do usuário. |
|
Ignorar notificação se SSO
|
skipNotifyIfSso | boolean |
Usado para desativar a alteração da notificação por e-mail enviada ao usuário. |
|
|
e-mail
|
O endereço de e-mail do usuário |
|||
|
enabled
|
enabled | boolean |
Estado dos utilizadores na plataforma |
|
|
função
|
role | string |
A função atribuída ao usuário que é um dos desenvolvedores, gerentes de equipe ou administradores da empresa |
|
|
equipa
|
team | string |
A equipa à qual o utilizador está associado |
|
|
tags
|
tags | array of string |
Qualquer informação de identificação sobre o utilizador. Exemplo: Sedes, Asia-Pacific |
|
|
_id
|
_id | string |
ID do idioma |
|
|
_framework
|
_framework | string |
Quadro linguístico |
Devoluções
- 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 usados em conjunto com os outros pontos de extremidade da API de avaliações. Os resultados podem ser filtrados com base no status, nome, idioma suportado e dificuldade.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
estado
|
status | string |
Estado da avaliação |
|
|
nome
|
name | string |
Nome de avaliação |
|
|
_id
|
_id | string |
ID do idioma |
|
|
_framework
|
_framework | string |
Quadro linguístico |
|
|
dificuldade
|
difficulty | string |
Dificuldade de avaliação |
|
|
página
|
page | integer |
O número de página dos resultados |
Devoluções
| Name | 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 existir) |
|
prev_page
|
links.prev_page | integer |
O número da página anterior (se existir) |
|
total_results
|
links.total_results | integer |
O número total dos resultados |
Criar um utilizador
Cria um usuário.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Enviar convite
|
sendInvite | boolean |
Sinalizar para desativar o convite do usuário e lembretes de convite. |
|
|
enabled
|
enabled | boolean |
Estado dos utilizadores na plataforma |
|
|
e-mail
|
True | string |
O e-mail 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 é opcional |
|
|
primeiro
|
first | string |
Nome do usuário. Obrigatório se 'isProfileComplete' estiver definido como true |
|
|
médio
|
middle | string |
Nome do meio do usuário |
|
|
último
|
last | string |
Apelido do utilizador. Obrigatório se 'isProfileComplete' estiver definido como true |
|
|
função
|
role | True | string |
A função atribuída ao usuário que é um dos desenvolvedores, gerentes de equipe ou administradores da empresa |
|
equipa
|
team | string |
A equipa à qual o utilizador está associado |
|
|
tags
|
tags | array of string |
Qualquer informação de identificação sobre o utilizador. Exemplo: Sedes, Asia-Pacific |
|
|
_id
|
_id | string |
ID do idioma |
|
|
_framework
|
_framework | string |
Quadro linguístico |
Devoluções
- Usuário criado
- UserCreated
Criar uma equipa
Isso é usado para criar uma equipe.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
nome
|
name | string |
Nome da Equipa |
|
|
tags
|
tags | array of string |
Qualquer informação de identificação sobre a equipa. Exemplo: Sede, Ásia-Pacífico, Engenharia |
|
|
ativoDe
|
activeFrom | string |
equipe ativa de. Formato: AAAA-MM-DDTHH:mm:ss. SSSZ |
|
|
ativoAté
|
activeUntil | string |
Equipa ativa até. Formato: AAAA-MM-DDTHH:mm:ss. SSSZ |
|
|
Idiomas
|
languages | array of string |
Lista de idiomas da equipe, _id e _framework separados por dois pontos duplos (::) e separados por vírgulas (,) |
|
|
onboardingmensagem
|
onboardingmessage | string |
Mensagem de Integração da Equipa |
|
|
tipo
|
type | string |
Tipo de licença |
|
|
concedido
|
granted | integer |
Licenças concedidas (válidas apenas se o tipo de licença estiver definido para uso) |
Devoluções
Detalhes da Equipa
- Body
- TeamDetails
Excluir equipe
Isso é usado para excluir uma equipe.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da Equipa
|
team_id | True | string |
ID da Equipa |
Devoluções
Resposta de exclusão da equipe
- Body
- TeamDeleteResponse
Excluir usuário
Exclui o usuário referenciado pelo ID fornecido.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
O ID do recurso do usuário. |
Devoluções
- Usuário excluído
- UserDeleted
Faça com que a atividade dos usuários seja mais engajada
Este ponto de extremidade retorna os principais 'N' usuários mais engajados.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Período do relatório
|
report_period | integer |
O número de dias durante os quais ver a maioria dos utilizadores envolvidos (report_period deve ser especificado sozinho ou com data de fim) |
|
|
Data de início
|
startdate | string |
Data de início do intervalo de datas (não deve ser especificada com report_period). Formato: AAAA-MM-DDTHH:mm:ss. SSSZ |
|
|
Data de fim
|
enddate | string |
Data de término do intervalo de datas (deve ser maior que a data de início). Formato: AAAA-MM-DDTHH:mm:ss. SSSZ |
|
|
Número de utilizadores
|
number_of_users | integer |
Top 'N' número de usuários |
|
|
Nome da Equipa
|
team_name | string |
Nome da Equipa |
|
|
Etiquetas
|
tags | string |
Tags de usuário |
|
|
Página
|
page | integer |
O número de página dos resultados |
Devoluções
Usuários mais engajados na empresa
- Body
- MostEngagedUsers
Mostra recursos de aprendizagem que foram concluídos, lidos ou assistidos
Descrição da aprendizagem
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
O número de página dos resultados |
Devoluções
| Name | 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 existir) |
|
prev_page
|
links.prev_page | integer |
O número da página anterior (se existir) |
|
total_results
|
links.total_results | integer |
O número total dos resultados |
Obtenha a atividade da equipe mais engajada
Este endpoint devolve as 'N' equipas mais envolvidas.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Período do relatório
|
report_period | integer |
O número de dias durante os quais ver a maioria das equipas envolvidas (report_period deve ser especificado sozinho ou com data de fim) |
|
|
Data de início
|
startdate | string |
Data de início do intervalo de datas (não deve ser especificada com report_period). Formato: AAAA-MM-DDTHH:mm:ss. SSSZ |
|
|
Data de fim
|
enddate | string |
Data de término do intervalo de datas (deve ser maior que a data de início). Formato: AAAA-MM-DDTHH:mm:ss. SSSZ |
|
|
Número de Equipas
|
number_of_teams | integer |
Top 'N' número de equipas |
|
|
Etiquetas
|
tags | string |
Tags de usuário |
|
|
Página
|
page | integer |
O número de página dos resultados |
Devoluções
Equipas mais empenhadas na empresa
- Body
- MostEngagedTeams
Obtenha equipas
Esse ponto de extremidade retornará uma lista de objetos Team que contêm um intervalo de pontos de dados relacionados a equipes. Isso inclui IDs de equipe, que podem ser usados em conjunto com os outros pontos de extremidade da API da equipe.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
O número de página dos resultados |
|
|
Nome da Equipa
|
name | string |
Nome da equipa |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Equipas
|
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 existir) |
|
prev_page
|
links.prev_page | integer |
O número da página anterior (se existir) |
|
total_results
|
links.total_results | integer |
O número total dos resultados |
Obtenha o Developer Leaderboard
Este 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 do relatório (que pode ser de 1, 7 ou 30 dias).
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Período do relatório
|
report_period | integer |
O número de dias durante os quais visualizar as alterações nas estatísticas |
|
|
Página
|
page | integer |
O número de página dos resultados |
|
|
Data de início
|
startdate | date-time |
Inclua o progresso da tabela de classificação concluída no tempo determinado ou após ele. Formato: AAAA-MM-DDTHH:mm:ss. SSSZ |
|
|
Data de fim
|
enddate | date-time |
Inclua o progresso da tabela de classificação concluída no tempo determinado ou antes dele. Formato: AAAA-MM-DDTHH:mm:ss. SSSZ |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Tabela de classificação
|
leaderboard | array of object |
Tabela de classificação |
|
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 e-mail do desenvolvedor. |
|
Membro desde
|
leaderboard.developer.member_since | string |
A data em que o desenvolvedor se tornou membro. |
|
Último Login
|
leaderboard.developer.last_logged_in | string |
A data em que o desenvolvedor fez login 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 |
|
Equipa
|
leaderboard.developer.team | string |
O nome da equipe da qual o desenvolvedor faz parte. |
|
tags
|
leaderboard.developer.tags | array of string |
tags |
|
roles
|
leaderboard.developer.roles | array of string |
roles |
|
Bloqueado
|
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 utilizada 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 que o participante usou. |
|
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 |
|
Subcategoria
|
leaderboard.levels.challenges.subcategory | string |
Subcategoria |
|
dificuldade
|
leaderboard.levels.challenges.difficulty | string |
dificuldade |
|
estado
|
leaderboard.levels.challenges.status | string |
estado |
|
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 |
|
stages
|
leaderboard.levels.challenges.stages | array of object |
stages |
|
número
|
leaderboard.levels.challenges.stages.number | integer |
número |
|
nome
|
leaderboard.levels.challenges.stages.name | string |
nome |
|
estado
|
leaderboard.levels.challenges.stages.status | string |
estado |
|
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. |
|
Página Seguinte
|
links.next_page | integer |
O número da página seguinte (se existir). |
|
Página Anterior
|
links.prev_page | integer |
O número da página anterior (se existir). |
|
Resultados totais
|
links.total_results | integer |
O número total dos resultados. |
Obtenha o progresso de todos os desenvolvedores para o curso
Este ponto de extremidade retornará o progresso de todos os desenvolvedores para o curso especificado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do curso
|
course_id | True | string |
ID do curso |
|
Página
|
page | integer |
O número de página dos resultados |
Devoluções
| Name | 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 existir) |
|
prev_page
|
links.prev_page | integer |
O número da página anterior (se existir) |
|
total_results
|
links.total_results | integer |
O número total dos resultados |
Obtenha o progresso do desenvolvedor
Este endpoint retorna o progresso do treinamento de todos os desenvolvedores dentro da organização, com o realm, o nível e o progresso da missão atuais.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
O número de página dos resultados |
Devoluções
Isso contém o progresso de cada desenvolvedor em cada uma das linguagens, reinos, níveis e missões
- Progresso do desenvolvedor
- DevelopersProgress
Obtenha os melhores desempenhos da atividade
Isso é usado para recuperar a lista de usuários com melhor desempenho.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Período do relatório
|
report_period | integer |
O número de dias durante os quais visualizar as alterações nas estatísticas |
|
|
Número de Utilizadores
|
num_users | integer |
O número de melhores desempenhos a serem devolvidos |
|
|
Página
|
page | integer |
O número de página dos resultados |
|
|
Etiquetas
|
tags | string |
Filtre os resultados para mostrar os principais peformers para as tags especificadas. As tags especificadas são separadas por vírgulas e usam a lógica OR para filtrar os resultados. |
|
|
Equipa
|
team | string |
Filtrar resultados para mostrar os melhores desempenhos para uma determinada equipa |
|
|
Hora de Início
|
starttime | date-time |
Inclui pontos do progresso concluído no ou após o tempo dado. Formato: AAAA-MM-DDTHH:mm:ss. SSSZ |
|
|
Hora de Término
|
endtime | date-time |
Inclua pontos do progresso concluído no tempo determinado ou antes dele. Formato: AAAA-MM-DDTHH:mm:ss. SSSZ |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
esquema
|
schema | TopPerformers |
Lista dos melhores desempenhos |
Obtenha tempo gasto
Tempo gasto na plataforma em Avaliações, Aprendizagem, Torneios e Treinamento.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
O número de página dos resultados |
|
|
ID
|
id | string |
Filtrar resultados com base no ID do usuário no formato UUID |
|
|
Email
|
string |
Filtrar resultados com base no e-mail |
||
|
Etiquetas
|
tags | string |
Filtre a base de resultados para mostrar aos usuários as tags. As tags especificadas são separadas por vírgulas e usam a lógica OR para filtrar os resultados. |
|
|
Equipa
|
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 «AAAA-MM-DD». Em UTC |
|
|
Data de fim
|
enddate | date-time |
Filtre os resultados para incluir todos os resultados até o final do dia. Formato de data «AAAA-MM-DD». Em UTC |
Devoluções
| Name | 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 existir) |
|
prev_page
|
links.prev_page | integer |
O número da página anterior (se existir) |
|
total_results
|
links.total_results | integer |
O número total dos resultados |
Obter atividade do desenvolvedor
Este endpoint retorna o log de desafio detalhado de todos os desenvolvedores dentro da organização, com pontuação de desafio, dificuldade e resultado de desafio do desenvolvedor.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
O número de página dos resultados |
Devoluções
Registro 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 usados em conjunto com os outros pontos de extremidade da API de avaliações.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
O número de página dos resultados |
|
|
Data de início
|
startdate | date-time |
Apenas as avaliações de regresso tiveram início na data fixada e após essa data. Formato: AAAA-MM-DDTHH:mm:ss. SSSZ |
|
|
Data de fim
|
enddate | date-time |
Apenas as avaliações de retorno iniciadas ou concluídas antes da data determinada. Formato: AAAA-MM-DDTHH:mm:ss. SSSZ |
Devoluções
| Name | 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 existir) |
|
prev_page
|
links.prev_page | integer |
O número da página anterior (se existir) |
|
total_results
|
links.total_results | integer |
O número total dos resultados |
Obter detalhes da equipa
Isso é usado para obter detalhes de uma equipe.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da Equipa
|
team_id | True | string |
ID da Equipa |
Devoluções
Detalhes da Equipa
- Body
- TeamDetails
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
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Tipo de destino
|
targetType | string |
Tipo de alvo. Padrões dependendo do escopo da chave da API. Reporte os principais padrões para a empresa. O padrão da chave de equipe é a equipe. |
|
|
Identificador de destino
|
targetIdentifier | string |
Identificador de Destino (Nome da Equipa, E-mail do Utilizador ou ID de Utilizador) |
|
|
ID do idioma
|
languageId | string |
ID do idioma |
|
|
Quadro linguístico
|
languageFramework | string |
Quadro linguístico |
|
|
Página
|
page | integer |
O número de página dos resultados |
Devoluções
Objeto de forças e fraquezas médias
Obter recursos
Lista de recursos de aprendizagem
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
resources
|
resources | array of Resource |
Obter Tabela de Líderes de Equipas
Este endpoint retorna uma lista de todas as equipes dentro da organização, com suas estatísticas atuais, bem como a mudança nas estatísticas durante o período do relatório (que pode ser de 1, 7 ou 30 dias).
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Período do relatório
|
report_period | integer |
O número de dias durante os quais visualizar 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 dos resultados |
|
|
Data de início
|
startdate | date-time |
Inclua o progresso da tabela de classificação concluída no tempo determinado ou após ele. Formato: AAAA-MM-DDTHH:mm:ss. SSSZ |
|
|
Data de fim
|
enddate | date-time |
Inclua o progresso da tabela de classificação concluída no tempo determinado ou antes dele. Formato: AAAA-MM-DDTHH:mm:ss. SSSZ |
Devoluções
- response
- array of TeamLeaderboard
Obter Tabela de Líderes de Torneios
Este ponto final devolve a tabela de classificação de um único torneio. Isso inclui todos os níveis, desafios e estágios em que o desenvolvedor participou, com métricas detalhadas de cada um.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Torneio
|
tournament_id | True | string |
O ID do torneio |
|
Página
|
page | integer |
O número de página dos resultados |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Tabela de classificação
|
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 existir) |
|
prev_page
|
links.prev_page | integer |
O número da página anterior (se existir) |
|
total_results
|
links.total_results | integer |
O número total dos resultados |
Obter tentativas de avaliação
Este ponto de extremidade retorna um relatório detalhado para todos os desenvolvedores que fizeram a Avaliação com a ID fornecida. O âmbito do relatório pode ser filtrado de várias formas. Você pode filtrar os resultados para um determinado desenvolvedor, fornecendo seu endereço de e-mail com a consulta. Se uma data de início for fornecida, apenas as tentativas iniciadas ou concluídas após (e incluindo) essa data serão incluídas. Se uma data de término for fornecida, apenas os desafios iniciados ou concluídos antes dessa data serão incluídos. O fornecimento de ambos indica um intervalo de datas para filtrar. Isso inclui todos os dados do relatório de síntese, além de detalhes sobre todos os desafios que fazem parte da avaliação.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da avaliação
|
assessment_id | True | string |
O ID da avaliação |
|
Página
|
page | integer |
O número de página dos resultados |
|
|
E-mail do desenvolvedor
|
developer | string |
O endereço de e-mail do desenvolvedor para filtrar |
|
|
Data de início
|
startdate | date-time |
Apenas as tentativas de devolução começaram na data indicada e após essa data. Formato: AAAA-MM-DDTHH:mm:ss. SSSZ |
|
|
Data de fim
|
enddate | date-time |
Apenas as tentativas de devolução iniciadas ou concluídas antes da data indicada. Formato: AAAA-MM-DDTHH:mm:ss. SSSZ |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tentativas
|
attempts | array of object |
tentativas |
|
ID
|
attempts._id | string |
O ID da tentativa de avaliação |
|
Assessment
|
attempts._assessment | string |
A avaliação a que 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 e-mail do desenvolvedor. |
|
Membro desde
|
attempts.developer.member_since | string |
A data em que o desenvolvedor se tornou membro. |
|
Último Login
|
attempts.developer.last_logged_in | string |
A data em que o desenvolvedor fez login 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. |
|
Equipa
|
attempts.developer.team | string |
O nome da equipe da qual o desenvolvedor faz parte. |
|
tags
|
attempts.developer.tags | array of string |
tags |
|
roles
|
attempts.developer.roles | array of string |
roles |
|
Situação
|
attempts.status | string |
Indica o estado de um desafio/avaliação que pode estar pendente, em curso, concluído ou «fora de alcance». |
|
Linguagem
|
attempts.language | string |
A linguagem/enquadramento da avaliação. null = linguagem/estrutura não selecionada para avaliação que suporte mais de uma língua. |
|
Started
|
attempts.started | string |
A data/hora em que a avaliação foi iniciada. |
|
Concluído
|
attempts.completed | string |
Data/hora em que a avaliação foi concluída |
|
Deadline
|
attempts.deadline | string |
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 da avaliação em %. |
|
Concluído em
|
attempts.completed_in | string |
O tempo necessário para concluir a tentativa de avaliação. |
|
Grau de aprovação
|
attempts.passing_grade | integer |
A percentagem necessária para passar na avaliação. |
|
Estado do Passe
|
attempts.pass_status | string |
O status de aprovação da avaliação. |
|
Corrigir
|
attempts.progress.correct | integer |
O número de desafios corretos. |
|
Incorreto
|
attempts.progress.incorrect | integer |
O número de impugnações incorretas. |
|
Número de desafios
|
attempts.progress.number_of_challenges | integer |
O número total de desafios. |
|
Concluído
|
attempts.progress.completed | integer |
Data/hora em que a avaliação foi concluída. |
|
Localizada
|
attempts.accuracy.located | integer |
A % de vulnerabilidades localizadas |
|
Identificado
|
attempts.accuracy.identified | integer |
O % de vulnerabilidades identificadas |
|
Fixo
|
attempts.accuracy.fixed | integer |
O % de vulnerabilidades corrigidas |
|
desafios
|
attempts.challenges | array of object |
desafios |
|
número
|
attempts.challenges.number | integer |
número |
|
categoria
|
attempts.challenges.category | string |
categoria |
|
Subcategoria
|
attempts.challenges.subcategory | string |
Subcategoria |
|
dificuldade
|
attempts.challenges.difficulty | string |
dificuldade |
|
estado
|
attempts.challenges.status | string |
estado |
|
max_score
|
attempts.challenges.max_score | integer |
max_score |
|
classificação
|
attempts.challenges.score | integer |
classificação |
|
estado
|
attempts.challenges.locate.status | string |
estado |
|
estado
|
attempts.challenges.identify.status | string |
estado |
|
estado
|
attempts.challenges.fix.status | string |
estado |
|
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. |
|
Página Seguinte
|
links.next_page | integer |
O número da página seguinte (se existir). |
|
Página Prev
|
links.prev_page | integer |
O número da página anterior (se existir). |
|
Resultados totais
|
links.total_results | integer |
O número total dos resultados. |
Obter todos os cursos
Esse ponto de extremidade retornará uma lista de objetos do curso que contêm uma variedade de pontos de dados relacionados aos cursos. Isso inclui IDs de curso, que podem ser usadas em conjunto com os outros pontos de extremidade da API do curso.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
O número de página dos resultados |
Devoluções
| Name | 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 existir) |
|
prev_page
|
links.prev_page | integer |
O número da página anterior (se existir) |
|
total_results
|
links.total_results | integer |
O número total dos resultados |
Obter Torneios
Este endpoint devolve uma lista de torneios na empresa.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
O número de página dos resultados |
|
|
Nome do Torneio
|
name | string |
Nome do torneio |
|
|
Data de início
|
startdate | date-time |
Só regressam torneios que comecem no ou após o tempo dado. Formato: AAAA-MM-DDTHH:mm:ss. SSSZ |
|
|
Data de fim
|
enddate | date-time |
Apenas retorne torneios que terminem no tempo determinado ou antes dele. tempo: AAAA-MM-DDTHH:mm:ss. SSSZ |
Devoluções
| Name | 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 existir) |
|
prev_page
|
links.prev_page | integer |
O número da página anterior (se existir) |
|
total_results
|
links.total_results | integer |
O número total dos resultados |
Obter URL do curso
JSON contendo URL do curso
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Quadro linguístico
|
language_framework | True | string |
Nome da linguagem e framework no formato "Java::Spring" |
|
Course
|
course | True | string |
Nome do curso |
|
Módulo
|
module | True | string |
Nome do módulo do curso |
|
Redirecionamento
|
redirect | boolean |
Redireciona o usuário para a URL de retorno |
Devoluções
URL para cursos de formação
- 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 atributos a serem retornados.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | string |
O ID do recurso do usuário. |
|
Tipo de ID
|
idtype | string |
Usado para classificar o tipo de ID de usuário na URL. |
|
|
Campos
|
fields | string |
Uma matriz de campos. Retorna apenas os atributos especificados no filtro. Cada atributo deve ser separado por vírgula. |
Devoluções
- Dados do Utilizador
- UserData
Obter usuários
Isso é usado para recuperar todos os registros do usuário. A resposta pode ser moldada passando um parâmetro de consulta de campos listando os nomes de atributos a serem retornados.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Campos
|
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 fornecido de um conjunto de resultados paginado. Os tamanhos das páginas são de 1000 registros. |
Devoluções
Lista de UserData
- Lista de Utilizadores
- UsersList
Pesquisar atividade de desenvolvedores
Este endpoint retorna o log de desafio detalhado de todos os desenvolvedores dentro da organização, com pontuação de desafio, dificuldade e resultado de desafio do desenvolvedor. Isso também lista o log de desafios 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 e-mails de desenvolvedores, tags de desenvolvedores e nomes de equipes.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
report_period_in_days
|
report_period_in_days | integer |
O número de dias no passado para relatar (valores válidos - 1, 7 e 30 dias) |
|
|
data de início
|
startdate | string |
logs de desafio do desenvolvedor concluídos em ou após o tempo dado. Formato: AAAA-MM-DDTHH:mm:ss. SSSZ |
|
|
Data de fim
|
enddate | string |
Logs de desafio do desenvolvedor concluídos em ou antes do tempo determinado. Formato: AAAA-MM-DDTHH:mm:ss. SSSZ |
|
|
users
|
users | string |
Usuários para incluir nos logs de desafio (um ou mais e-mails de usuário, separados por vírgula) |
|
|
team_names
|
team_names | string |
Nomes de equipas (um ou mais nomes de equipas, separados por vírgula) |
|
|
tags
|
tags | string |
Tags de usuário (uma ou mais tags de usuário, separadas por vírgula) |
|
|
página
|
page | integer |
O número de página dos resultados |
Devoluções
Registro detalhado de desafios para um determinado período de tempo
- Atividade do desenvolvedor
- DevelopersActivity
Pesquisar o progresso dos desenvolvedores
Este endpoint retorna o progresso do treinamento de todos os desenvolvedores dentro da organização, com o realm, o nível e o progresso da missão atuais. Isso também lista a alteração no progresso do desenvolvedor 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 e-mails de desenvolvedores, tags de desenvolvedores e nomes de equipes.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
report_period_in_days
|
report_period_in_days | integer |
O número de dias no passado para relatar (valores válidos - 1, 7 e 30 dias) |
|
|
data de início
|
startdate | string |
progresso do desenvolvedor concluído em ou após o tempo dado. Formato: AAAA-MM-DDTHH:mm:ss. SSSZ |
|
|
Data de fim
|
enddate | string |
progresso do desenvolvedor concluído em ou antes do tempo dado. Formato: AAAA-MM-DDTHH:mm:ss. SSSZ |
|
|
users
|
users | string |
Usuários para incluir no progresso do desenvolvedor (um ou mais e-mails de usuário, separados por vírgula) |
|
|
team_names
|
team_names | string |
Nomes de equipas (um ou mais nomes de equipas, separados por vírgula) |
|
|
tags
|
tags | string |
Tags de usuário (uma ou mais tags de usuário, separadas por vírgula) |
|
|
página
|
page | integer |
O número de página dos resultados |
Devoluções
Isso contém o progresso de cada desenvolvedor em cada uma das linguagens, reinos, níveis e missões
- Progresso do desenvolvedor
- DevelopersProgress
Pesquisar o progresso dos desenvolvedores de cursos
Este ponto de extremidade retorna o progresso do curso de todos os desenvolvedores dentro da organização.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Página
|
page | integer |
O número de página dos 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 |
|
|
estado
|
status | string |
Estado do curso |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
dados
|
data | array of object | |
|
user_id
|
data.user_id | string |
ID de recurso do usuário |
|
estado
|
data.status | string |
Estado do curso |
|
precisão
|
data.accuracy | integer |
A percentagem de tentativas corretas |
|
confiança
|
data.confidence | integer |
A proporção de acertos usados para dicas disponíveis |
|
minutes_spent
|
data.minutes_spent | integer |
O tempo total em mimnutes que o usuário gastou no curso |
|
first_completed_date
|
data.first_completed_date | date-time |
A data de conclusão da primeira língua do curso |
|
first_enrolled_date
|
data.first_enrolled_date | date-time |
A data em que a primeira língua do curso foi inscrita |
|
Progressos
|
data.progress | integer |
O progresso do curso |
|
Idiomas
|
data.languages | array of CourseDeveloperProgressLanguageEntry |
Lista de línguas 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 existir) |
|
prev_page
|
links.prev_page | integer |
O número da página anterior (se existir) |
|
total_results
|
links.total_results | integer |
O número total dos resultados |
Pesquisar Progresso de Aprendizagem
Descrição de aprendizagem Filtros - utilizadores, equipas e etiquetas
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
users
|
users | string |
Usuários para incluir no progresso da aprendizagem (um ou mais e-mails do usuário, separados por vírgula) |
|
|
team_names
|
team_names | string |
Nomes de equipas (um ou mais nomes de equipas, separados por vírgula) |
|
|
tags
|
tags | string |
Tags de usuário (uma ou mais tags de usuário, separadas por vírgula) |
|
|
página
|
page | integer |
O número de página dos resultados |
Devoluções
| Name | 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 existir) |
|
prev_page
|
links.prev_page | integer |
O número da página anterior (se existir) |
|
total_results
|
links.total_results | integer |
O número total dos resultados |
Pesquisar Tabela de Líderes de Torneios
Este ponto final devolve a tabela de classificação de um único torneio. Isso inclui todos os níveis, desafios e estágios em que o desenvolvedor participou, com métricas detalhadas de cada um. Esse ponto de extremidade também pode retornar a tabela de classificação 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 e-mails de desenvolvedores, tags de desenvolvedores e nomes de equipes.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Torneio
|
tournament_id | True | string |
O ID do torneio |
|
report_period_in_days
|
report_period_in_days | integer |
O número de dias no passado para relatar (valores válidos - 1, 7 e 30 dias) |
|
|
data de início
|
startdate | string |
Tabela de classificação do desenvolvedor concluída no tempo determinado ou após ele. Formato: AAAA-MM-DDTHH:mm:ss. SSSZ |
|
|
Data de fim
|
enddate | string |
Tabela de classificação do desenvolvedor concluída no ou antes do tempo dado. Formato: AAAA-MM-DDTHH:mm:ss. SSSZ |
|
|
users
|
users | string |
Usuários para incluir na tabela de classificação (um ou mais e-mails de usuário, separados por vírgula) |
|
|
team_names
|
team_names | string |
Nomes de equipas (um ou mais nomes de equipas, separados por vírgula) |
|
|
tags
|
tags | string |
Tags de usuário (uma ou mais tags de usuário, separadas por vírgula) |
|
|
página
|
page | integer |
O número de página dos resultados |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Tabela de classificação
|
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 existir) |
|
prev_page
|
links.prev_page | integer |
O número da página anterior (se existir) |
|
total_results
|
links.total_results | integer |
O número total dos resultados |
Pesquisar Utilizadores
Isso é usado para recuperar todos os registros do usuário. A resposta pode ser moldada passando um parâmetro de consulta de campos listando os nomes de atributos a serem retornados. O filtro é obtido passando os critérios de filtro através do corpo.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Campos
|
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 fornecido de um conjunto de resultados paginado. Os tamanhos das páginas são de 1000 registros. |
|
|
id
|
id | string |
ID de recurso do usuário |
|
|
e-mail
|
string |
O e-mail do usuário |
||
|
função
|
role | string |
A função atribuída ao usuário que é um dos desenvolvedores, gerentes de equipe ou administradores da empresa |
|
|
equipa
|
team | string |
A equipa à qual o utilizador está associado |
|
|
tags
|
tags | array of string |
Qualquer informação de identificação sobre o utilizador. Exemplo: Sedes, Asia-Pacific |
Devoluções
Lista de UserData
- Lista de Utilizadores
- UsersList
Tabela de Líderes do Desenvolvedor de Pesquisa
Este ponto de extremidade retorna uma lista de todos os desenvolvedores dentro da organização, com suas estatísticas atuais. Isso também lista a mudança 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 e-mails de desenvolvedores, tags de desenvolvedores e nomes de equipes.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
report_period_in_days
|
report_period_in_days | integer |
O número de dias no passado para relatar (valores válidos - 1, 7 e 30 dias) |
|
|
data de início
|
startdate | string |
Tabela de classificação do desenvolvedor concluída no tempo determinado ou após ele. Formato: AAAA-MM-DDTHH:mm:ss. SSSZ |
|
|
Data de fim
|
enddate | string |
Tabela de classificação do desenvolvedor concluída no ou antes do tempo dado. Formato: AAAA-MM-DDTHH:mm:ss. SSSZ |
|
|
users
|
users | string |
Usuários para incluir na tabela de classificação (um ou mais e-mails de usuário, separados por vírgula) |
|
|
team_names
|
team_names | string |
Nomes de equipas (um ou mais nomes de equipas, separados por vírgula) |
|
|
tags
|
tags | string |
Tags de usuário (uma ou mais tags de usuário, separadas por vírgula) |
|
|
página
|
page | integer |
O número de página dos resultados |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Tabela de classificação
|
leaderboard | array of object |
Tabela de classificação |
|
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 e-mail dos desenvolvedores |
|
Membro desde
|
leaderboard.developer.member_since | string |
A data em que o desenvolvedor se tornou membro. |
|
Último Login
|
leaderboard.developer.last_logged_in | string |
A data em que o desenvolvedor fez login 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. |
|
Equipa
|
leaderboard.developer.team | string |
O nome da equipe da qual o desenvolvedor faz parte. |
|
tags
|
leaderboard.developer.tags | array of string |
tags |
|
roles
|
leaderboard.developer.roles | array of string |
roles |
|
Bloqueado
|
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/enquadramento utilizado 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 que o participante usou. |
|
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 |
|
Subcategoria
|
leaderboard.levels.challenges.subcategory | string |
Subcategoria |
|
dificuldade
|
leaderboard.levels.challenges.difficulty | string |
dificuldade |
|
estado
|
leaderboard.levels.challenges.status | string |
estado |
|
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 |
|
stages
|
leaderboard.levels.challenges.stages | array of object |
stages |
|
número
|
leaderboard.levels.challenges.stages.number | integer |
número |
|
nome
|
leaderboard.levels.challenges.stages.name | string |
nome |
|
estado
|
leaderboard.levels.challenges.stages.status | string |
estado |
|
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. |
|
Página Seguinte
|
links.next_page | integer |
O número da página seguinte (se existir). |
|
Página Anterior
|
links.prev_page | integer |
O número da página anterior (se existir). |
|
Resultados totais
|
links.total_results | integer |
O número total dos resultados. |
Tentativas de avaliação de pesquisa
Este ponto de extremidade retorna um relatório detalhado para todos os desenvolvedores que fizeram a Avaliação com a ID fornecida. O âmbito do relatório pode ser filtrado de várias formas. Você pode filtrar os resultados para determinado desenvolvedor(es) fornecendo o(s) seu(s) endereço(s) de e-mail com a consulta. Se um status for fornecido, somente as tentativas de avaliação com status especificado serão incluídas. Se o(s) nome(s) da equipe fornecido(s), apenas as tentativas de avaliação dos usuários dentro da(s) equipe(s) serão incluídas. Se a(s) tag(s) for fornecida(s), apenas as tentativas de avaliação dos usuários com essa(s) tag(s) serão incluídas. Se um pass_status for fornecido, apenas as tentativas de avaliação com pass_status especificadas serão incluídas. Isso inclui todos os dados do relatório de síntese, além de detalhes sobre todos os desafios que fazem parte da avaliação.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
assessment_id
|
assessment_id | string |
O ID da avaliação |
|
|
nome
|
name | string |
O nome da avaliação |
|
|
users
|
users | string |
Usuários tentando a avaliação (um ou mais e-mails de usuário, separados por vírgula) |
|
|
estado
|
status | string |
Estado da tentativa de avaliação |
|
|
team_names
|
team_names | string |
Nomes de equipas (um ou mais nomes de equipas, separados por vírgula) |
|
|
tags
|
tags | string |
Tags de usuário (uma ou mais tags de usuário, separadas por vírgula) |
|
|
pass_status
|
pass_status | string |
Status de aprovação na tentativa de avaliação |
|
|
página
|
page | integer |
O número de página dos resultados |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tentativas
|
attempts | array of object |
tentativas |
|
ID
|
attempts._id | string |
O ID da tentativa de avaliação |
|
Assessment
|
attempts._assessment | string |
A avaliação a que 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 e-mail do desenvolvedor. |
|
Membro desde
|
attempts.developer.member_since | string |
A data em que o desenvolvedor se tornou membro. |
|
Último Login
|
attempts.developer.last_logged_in | string |
A data em que o desenvolvedor fez login 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. |
|
Equipa
|
attempts.developer.team | string |
O nome da equipe da qual o desenvolvedor faz parte. |
|
tags
|
attempts.developer.tags | array of string |
tags |
|
roles
|
attempts.developer.roles | array of string |
roles |
|
Situação
|
attempts.status | string |
Indica o estado de um desafio/avaliação que pode estar pendente, em curso, concluído ou «fora de alcance». |
|
Linguagem
|
attempts.language | string |
A linguagem/enquadramento da avaliação. null = linguagem/estrutura não selecionada para avaliação que suporte mais de uma língua. |
|
Started
|
attempts.started | string |
A data/hora em que a avaliação foi iniciada. |
|
Concluído
|
attempts.completed | string |
Data/hora em que a avaliação foi concluída |
|
Deadline
|
attempts.deadline | string |
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 da avaliação em %. |
|
Concluído em
|
attempts.completed_in | string |
O tempo necessário para concluir a tentativa de avaliação. |
|
Grau de aprovação
|
attempts.passing_grade | integer |
A percentagem necessária para passar na avaliação. |
|
Estado do Passe
|
attempts.pass_status | string |
O status de aprovação da avaliação. |
|
Corrigir
|
attempts.progress.correct | integer |
O número de desafios corretos. |
|
Incorreto
|
attempts.progress.incorrect | integer |
O número de impugnações incorretas. |
|
Número de desafios
|
attempts.progress.number_of_challenges | integer |
O número total de desafios. |
|
Concluído
|
attempts.progress.completed | integer |
Data/hora em que a avaliação foi concluída. |
|
Localizada
|
attempts.accuracy.located | integer |
A % de vulnerabilidades localizadas |
|
Identificado
|
attempts.accuracy.identified | integer |
O % de vulnerabilidades identificadas |
|
Fixo
|
attempts.accuracy.fixed | integer |
O % de vulnerabilidades corrigidas |
|
desafios
|
attempts.challenges | array of object |
desafios |
|
número
|
attempts.challenges.number | integer |
número |
|
categoria
|
attempts.challenges.category | string |
categoria |
|
Subcategoria
|
attempts.challenges.subcategory | string |
Subcategoria |
|
dificuldade
|
attempts.challenges.difficulty | string |
dificuldade |
|
estado
|
attempts.challenges.status | string |
estado |
|
max_score
|
attempts.challenges.max_score | integer |
max_score |
|
classificação
|
attempts.challenges.score | integer |
classificação |
|
estado
|
attempts.challenges.locate.status | string |
estado |
|
estado
|
attempts.challenges.identify.status | string |
estado |
|
estado
|
attempts.challenges.fix.status | string |
estado |
|
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. |
|
Página Seguinte
|
links.next_page | integer |
O número da página seguinte (se existir). |
|
Página Prev
|
links.prev_page | integer |
O número da página anterior (se existir). |
|
Resultados totais
|
links.total_results | integer |
O número total dos resultados. |
Definições
Torneio
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
_id
|
_id | string |
O 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 |
|
hora de fim
|
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 |
TorneioParticipante
| Name | 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/enquadramento que o participante utilizou |
|
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 utilizou |
|
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 |
Nível
| Name | 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 |
|
Subcategoria
|
challenges.subcategory | string |
A subcategoria do desafio |
|
dificuldade
|
challenges.difficulty | string | |
|
Situação
|
challenges.status | Status |
Indica o estado de um desafio/avaliação que pode estar pendente, em curso, concluído ou «fora de alcance» |
|
max_points
|
challenges.max_points | integer |
O máximo de pontos 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) |
|
stages
|
challenges.stages | array of Stage |
Fase
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
número
|
number | integer |
O número do estágio |
|
nome
|
name | string |
O nome do palco |
|
estado
|
status | string |
O estado da tentativa nesta fase |
|
pontos
|
points | integer |
Pontos ganhos nesta fase |
|
max_points
|
max_points | integer |
Máximo de pontos disponíveis nesta etapa |
|
minutes_spent
|
minutes_spent | integer |
Quanto tempo o desenvolvedor gastou respondendo (em minutos) |
|
lives_lost
|
lives_lost | integer |
O número de vidas perdidas nesta fase |
|
hints_used
|
hints_used | integer |
O número de dicas usadas nesta etapa |
Assessment
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
_id
|
_id | string |
O ID da avaliação |
|
estado
|
status | string |
Situação da avaliação |
|
nome
|
name | string |
O nome da avaliação |
|
descrição
|
description | string |
Descrição da avaliação |
|
supported_languages
|
supported_languages | array of string |
Lista de línguas/quadros disponíveis para a avaliação |
|
dificuldade
|
difficulty | string |
A dificuldade da avaliação |
|
success_ratio
|
success_ratio | integer |
A percentagem necessária para passar na avaliação |
|
emits_certificate
|
emits_certificate | boolean |
A avaliação está ligada a um certificado? |
|
time_limit
|
time_limit | integer |
O limite de tempo da avaliação em milissegundos. null = sem limite de tempo |
|
start_date
|
start_date | date-time |
A data de início da avaliação |
|
end_date
|
end_date | date-time |
Data de conclusão da avaliação |
|
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 |
São permitidas novas tentativas para esta avaliação? |
Situação
Indica o estado de um desafio/avaliação que pode estar pendente, em curso, concluído ou «fora de alcance»
Indica o estado de um desafio/avaliação que pode estar pendente, em curso, concluído ou «fora de alcance»
- Situação
- string
preferredDevLanguage
Preferência de idioma de desenvolvimento
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
_id
|
_id | string |
ID do idioma |
|
_framework
|
_framework | string |
Quadro linguístico |
AvaliaçãoAtribuirResposta
Resposta à avaliação atribuir solicitação POST
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
utilizador
|
user | string |
ID de e-mail do usuário |
|
inviteEmailSent
|
inviteEmailSent | boolean |
Foi enviado um e-mail de convite? |
|
inviteUrl
|
inviteUrl | string |
URL do convite de avaliação |
Tabela de Líderes da Equipa
A tabela de classificação da equipe contém todas as entradas da tabela de classificação da equipe válidas durante o período de relatório dado
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
report_period_in_days
|
report_period_in_days | integer |
O número de dias no passado para informar sobre |
|
Tabela de classificação
|
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 existir) |
|
prev_page
|
links.prev_page | integer |
O número da página anterior (se existir) |
|
total_results
|
links.total_results | integer |
O número total dos resultados |
TeamLeaderboardEntry
Uma entrada na tabela de líderes da equipa
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
classificar
|
rank | integer |
A classificação da equipe na tabela de classificação. |
|
nome
|
name | string |
O nome da equipa |
|
desenvolvedores
|
developers | integer |
O número de desenvolvedores na equipe |
|
points_average
|
points_average | integer |
Média de pontos da equipa |
|
points_total
|
points_total | integer |
Total de pontos da equipa |
|
precisão
|
accuracy | integer |
A precisão da equipa (em %) |
|
confidence_level
|
confidence_level | integer |
O nível de confiança da equipa (em %) |
|
time_spent
|
time_spent | integer |
O total de minutos gastos pela equipa em desafios |
|
installed_sensei
|
installed_sensei | integer |
O número de desenvolvedores na equipe que instalaram o sensei |
|
Estatísticas ao longo do período do relatório
|
stats_over_report_period | StatsOverReportPeriod |
As estatísticas calculadas para o período de referência em causa |
MostEngagedTeams
Equipas mais empenhadas na empresa
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Equipas
|
teams | array of TeamEntry |
Detalhes da equipa |
|
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 existir) |
|
prev_page
|
links.prev_page | integer |
O número da página anterior (se existir) |
|
total_results
|
links.total_results | integer |
O número total dos resultados |
Entrada de Equipa
Este objeto representa os detalhes da equipe
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string |
Nome da equipa |
|
estado
|
status | string |
Estatuto da equipa |
|
tempoGasto
|
timeSpent | integer |
Tempo despendido em equipa |
MostEngagedUsers
Usuários mais engajados na empresa
| Name | 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 existir) |
|
prev_page
|
links.prev_page | integer |
O número da página anterior (se existir) |
|
total_results
|
links.total_results | integer |
O número total dos resultados |
UserEntry
Este objeto representa os detalhes do usuário
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string |
Nome do utilizador |
|
estado
|
status | string |
Estatuto do utilizador |
|
tempoGasto
|
timeSpent | integer |
Tempo gasto pelo utilizador |
StatsOverReportPeriod
As estatísticas calculadas para o período de referência em causa
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
points_gained
|
points_gained | integer |
O número de pontos que o desenvolvedor ganhou |
|
accuracy_change
|
accuracy_change | integer |
A mudança na precisão durante o período de relatório |
|
confidence_level_change
|
confidence_level_change | integer |
A mudança no nível de confiança ao longo do período de referência |
|
minutes_spent
|
minutes_spent | integer |
Os minutos gastos pela equipa em desafios |
|
challenges_correct
|
challenges_correct | integer |
O número de desafios corretos |
|
challenges_incorrect
|
challenges_incorrect | integer |
O número de impugnações incorretas |
Desenvolvedor
Informações sobre um desenvolvedor individual
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string |
O nome do desenvolvedor (primeiro + meio + sobrenome) |
|
e-mail
|
string |
O endereço de e-mail 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 login pela última vez |
|
estado
|
status | string |
O status atual da conta de desenvolvedor |
|
Companhia
|
company | string |
O nome da empresa da qual o desenvolvedor faz parte |
|
equipa
|
team | string |
O nome da equipe da qual o desenvolvedor faz parte |
|
tags
|
tags | array of string |
As tags associadas a este desenvolvedor |
|
roles
|
roles | string |
As funções que este desenvolvedor tem |
DesenvolvedoresProgresso
Isso contém o progresso de cada desenvolvedor em cada uma das linguagens, reinos, níveis e missões
| Name | 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 existir) |
|
prev_page
|
links.prev_page | integer |
O número da página anterior (se existir) |
|
total_results
|
links.total_results | integer |
O número total dos resultados |
DeveloperProgressEntry
Esta entrada representa um objeto no progresso de treinamento de desenvolvedores contendo informações do desenvolvedor e o progresso de suas tentativas no modo de treinamento
| Name | 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 |
FormaçãoProgressEntry
Entrada com progresso de conclusão em idiomas e lista de reinos
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string |
Nome do quadro linguístico |
|
language_progress
|
language_progress | integer |
Percentagem da língua preenchida |
|
Reinos
|
realms | array of object |
Lista de reinos para cada idioma |
|
nome
|
realms.name | string |
Nome do reino |
|
realm_progress
|
realms.realm_progress | integer |
Porcentagem do domínio concluído |
|
níveis
|
realms.levels | array of object |
Lista de níveis para cada reino |
|
nome
|
realms.levels.name | string |
Nome do nível |
|
level_progress
|
realms.levels.level_progress | integer |
Percentagem do nível concluído |
|
missões
|
realms.levels.quests | array of object |
Lista de missões para cada nível |
|
nome
|
realms.levels.quests.name | string |
Nome da missão |
|
quest_progress
|
realms.levels.quests.quest_progress | integer |
Percentagem de missões concluídas |
DevelopersActivity
Registro detalhado de desafios para um determinado período de tempo
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
activities
|
activities | array of ActivityEntry |
Lista de desenvolvedores contendo com lista de idiomas contendo 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 existir) |
|
prev_page
|
links.prev_page | integer |
O número da página anterior (se existir) |
|
total_results
|
links.total_results | integer |
O número total dos resultados |
ActivityEntry
Este objeto representa o desenvolvedor e suas tentativas de desafio
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Desenvolvedor
|
developer | Developer |
Informações sobre um desenvolvedor individual |
|
Tentativa de desafio
|
challenge | ChallengeAttempt |
Tentativa feita por deverloper no modo de treino |
DesafioTentativa
Tentativa feita por deverloper no modo de treino
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
linguagem
|
language | string |
Nome do quadro linguístico |
|
reino
|
realm | string |
Nome do reino |
|
nível
|
level | string |
Nome do nível |
|
Missão
|
quest | string |
Nome da missão |
|
categoria
|
category | string |
Nome da categoria do desafio |
|
Subcategoria
|
subcategory | string |
Nome da subcategoria do desafio |
|
dificuldade
|
difficulty | string |
Nível de dificuldade para o desafio |
|
começado
|
started | date-time |
O desafio do tempo foi iniciado |
|
concluída
|
completed | date-time |
Os desafios de tempo foram concluídos |
|
duration
|
duration | integer |
Tempo em segundos que levou para o desafio ser concluído |
|
estado
|
status | string |
Status do desafio, com status incorreto no 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 |
|
classificação
|
score | integer |
Pontos adquiridos |
|
max_score
|
max_score | string |
Máximo de pontos 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
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
attempt_index
|
attempt_index | integer |
Número de vezes que o desenvolvedor tentou o estágio |
|
estado
|
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 |
|
classificação
|
score | integer |
Pontos adquiridos para selecionar a vulnerabilidade |
|
ignorado
|
skipped | boolean |
Quando definido como true, o palco foi ignorado. Se o status for falso, o estágio foi concluído ou ainda não foi tentado |
LocalizarVulnerabilidade
Natureza do desafio
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
attempt_index
|
attempt_index | integer |
Número de vezes que o desenvolvedor tentou o estágio |
|
estado
|
status | string |
Resultado do desafio |
|
max_score
|
max_score | integer |
Máximo de pontos alcançáveis para localizar a vulnerabilidade |
|
classificação
|
score | integer |
Pontos adquiridos para localizar a vulnerabilidade |
IdentifySolution
Natureza do desafio
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
attempt_index
|
attempt_index | integer |
Número de vezes que o desenvolvedor tentou o estágio |
|
estado
|
status | string |
Resultado do desafio |
|
max_score
|
max_score | integer |
Máximo de pontos alcançáveis para identificar a solução |
|
classificação
|
score | integer |
Pontos adquiridos para identificar a solução |
ResourceItem
Detalhes do item de recurso
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
nome
|
name | string |
Resource
Detalhes do recurso
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
nome
|
name | string | |
|
items
|
items | array of ResourceItem |
CompletedResource
Detalhes de um recurso de aprendizagem completo
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
recurso
|
resource | array of string |
Uma lista ordenada da categorização e nome do recurso concluído |
|
time_completed
|
time_completed | date-time |
Quando o recurso de aprendizagem foi concluído |
ResourceRecord
Um registro dos recursos de aprendizagem concluídos de um desenvolvedor
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Desenvolvedor
|
profile | Developer |
Informações sobre um desenvolvedor individual |
|
concluída
|
completed | array of CompletedResource |
Todos os recursos de aprendizagem completados pelo utilizador |
URL do curso
URL para cursos de formação
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
URL
|
url | string |
URL para o curso |
Dados da Equipa
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string |
Nome da equipa |
Dados do Utilizador
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
A ID do recurso do usuário |
|
e-mail
|
string |
O e-mail do usuário |
|
|
função
|
role | string |
A função atribuída ao usuário que é um dos desenvolvedores, gerentes de equipe ou administradores da empresa |
|
primeiro
|
name.first |
Nome próprio |
|
|
médio
|
name.middle |
Nome do meio |
|
|
último
|
name.last |
Apelido |
|
|
estado
|
status | string |
Estado do utilizador |
|
data de convite
|
invite-date | date-time |
Hora de quando o usuário foi convidado pela última vez |
|
data-do-último login
|
last-login-date | date-time |
Última vez que o utilizador iniciou sessão |
|
Dados da Equipa
|
team | TeamData | |
|
tags
|
tags | array of string |
Qualquer informação de identificação sobre o utilizador. Exemplo: Sedes, Asia-Pacific |
|
preferredDevLanguages
|
preferredDevLanguages | array of preferredDevLanguage |
Preferência de idiomas de desenvolvimento |
UserUpdated
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
código de estado
|
statusCode | integer |
Código de status da mensagem de resposta bem-sucedida |
|
mensagem
|
message | string |
Descrição da mensagem de resposta bem-sucedida |
|
código
|
code | string |
Código Guerreiro de Código Seguro |
UserCreated
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
Identificador de recurso do Secure Code Warrior |
|
código de estado
|
statusCode | integer |
Código de status da mensagem de resposta bem-sucedida |
|
mensagem
|
message | string |
Descrição da mensagem de resposta bem-sucedida |
|
código
|
code | string |
Código Guerreiro de Código Seguro |
UserDeleted
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
código de estado
|
statusCode | integer |
Código de status da mensagem de resposta bem-sucedida |
|
mensagem
|
message | string |
Descrição da mensagem de resposta bem-sucedida |
|
código
|
code | string |
Código Guerreiro de Código Seguro |
Lista de Utilizadores
Lista de UserData
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
users
|
users | array of UserData |
TopPerformers
Lista dos melhores desempenhos
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
report_period_in_days
|
report_period_in_days | integer |
O número de dias no passado para comunicar informações |
|
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 existir) |
|
prev_page
|
links.prev_page | integer |
O número da página anterior (se existir) |
|
total_results
|
links.total_results | integer |
O número total dos resultados |
TopPerformer
Usuário com melhor desempenho
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
pontos
|
points | integer |
Total de pontos ganhos dentro de um período de tempo |
|
id
|
id | string |
ID do usuário no formato UUID |
|
e-mail
|
string |
E-mail do usuário |
|
|
primeiro
|
name.first | string |
Nome do utilizador |
|
médio
|
name.middle | string |
Nome do meio do usuário |
|
último
|
name.last | string |
Apelido do utilizador |
|
tags
|
tags | array of string |
Tags de usuário |
|
estado
|
status | string |
Estado do utilizador |
|
Dados da Equipa
|
team | TeamData |
UsersTimeSpent
Entrada mostrando a atividade dos usuários.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
ID do usuário no formato UUID |
|
e-mail
|
string |
E-mail do usuário |
|
|
primeiro
|
name.first | string |
Nome do utilizador |
|
médio
|
name.middle | string |
Nome do meio do usuário |
|
último
|
name.last | string |
Apelido do utilizador |
|
tags
|
tags | array of string |
Tags de usuário |
|
estado
|
status | string |
Estado do utilizador |
|
Dados da Equipa
|
team | TeamData | |
|
tempo-despendido
|
time-spent | array of object |
Matriz de datas com a discriminação 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 |
|
Aprendizagem
|
time-spent.activity.Learning | integer |
Tempo gasto na aprendizagem |
|
Torneios
|
time-spent.activity.Tournaments | integer |
Tempo gasto em Torneios |
|
Formação
|
time-spent.activity.Training | integer |
Tempo gasto em Formação |
Pontos Fortes e Fracos
Objeto de forças e fraquezas médias
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
auth
|
auth | AverageStrengthsAndWeaknessesEntry |
Este objeto representa cada categoria de gerenciamento individual |
|
data_handling
|
data_handling | AverageStrengthsAndWeaknessesEntry |
Este objeto representa cada categoria de gerenciamento individual |
|
configuração incorreta
|
misconfig | AverageStrengthsAndWeaknessesEntry |
Este objeto representa cada categoria de gerenciamento individual |
|
práticas
|
practices | AverageStrengthsAndWeaknessesEntry |
Este objeto representa cada categoria de gerenciamento individual |
|
sensitive_data
|
sensitive_data | AverageStrengthsAndWeaknessesEntry |
Este objeto representa cada categoria de gerenciamento individual |
|
other
|
other | AverageStrengthsAndWeaknessesEntry |
Este objeto representa cada categoria de gerenciamento individual |
MédiaForçasEFraquezasEntrada
Este objeto representa cada categoria de gerenciamento individual
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
desafios
|
challenges | ChallengesEntry |
Dados de desafios |
|
Dicas
|
hints | HintsEntry |
Dados de dicas |
|
pontos
|
points | integer |
Pontos |
|
tempoGasto
|
timeSpent | integer |
Tempo gasto |
DesafiosEntrada
Dados de desafios
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
tentativa
|
attempted | integer |
Tentativas de contestação |
|
Corrigir
|
correct | integer |
Correção da tentativa |
|
incorreto
|
incorrect | integer |
Tentativa incorreta |
|
percentagemCorreto
|
percentageCorrect | integer |
Percentagem correta |
|
ratioCorreto
|
ratioCorrect | number |
Rácio correto |
DicasEntry
Dados de dicas
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Nível de confiança
|
confidenceLevel | integer |
Nível de Confiança |
|
total
|
total | integer |
Total |
|
used
|
used | integer |
Usado |
Detalhes da Equipa
Detalhes da Equipa
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string |
ID da Equipa |
|
nome
|
name | string |
Nome da equipa |
|
tags
|
tags | array of string |
Qualquer informação de identificação sobre a equipa. Exemplo: Sede, Ásia-Pacífico, Engenharia |
|
onboardingMensagem
|
onboardingMessage | string |
Mensagem de embarque para a equipa |
|
estado
|
status | string |
Estado da equipa |
|
membroJoinToken
|
memberJoinToken | string |
Token de Adesão de Membro |
|
companyName
|
companyName | string |
Nome da empresa |
|
Idiomas
|
languages | array of string |
Línguas da equipa |
TeamDeleteResponse
Resposta de exclusão da equipe
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
deleteStatus
|
deleteStatus | string |
Status da operação de exclusão |
Course
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
_id
|
_id | string |
O ID do curso |
|
nome
|
name | string |
O nome do curso |
|
descrição
|
description | string |
A descrição do curso |
|
estado
|
status | string |
O estado do curso |
|
supported_languages
|
supported_languages | array of string |
Lista de linguagens/frameworks disponíveis para o curso |
|
Prazo
|
deadline | date-time |
A data de término do curso |
|
criado_por
|
created_by | string |
O ResourceId do autor do curso |
CourseDeveloperProgressEntry
Esta entrada representa um progresso do curso de desenvolvedor
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
user_id
|
user_id | string |
ID de recurso do usuário |
|
estado
|
status | string |
Estado do curso |
|
precisão
|
accuracy | integer |
A percentagem de tentativas corretas |
|
confiança
|
confidence | integer |
A proporção de acertos usados para dicas disponíveis |
|
minutes_spent
|
minutes_spent | integer |
O tempo total em mimnutes que o usuário gastou no curso |
|
first_completed_date
|
first_completed_date | date-time |
A data de conclusão da primeira língua do curso |
|
first_enrolled_date
|
first_enrolled_date | date-time |
A data em que a primeira língua do curso foi inscrita |
|
Progressos
|
progress | integer |
O progresso do curso |
|
Idiomas
|
languages | array of CourseDeveloperProgressLanguageEntry |
Lista de línguas para o curso |
|
convida
|
invites | array of CourseDeveloperProgressInviteEntry |
Lista de convites e lembretes |
CourseDeveloperProgressInviteEntry
Esta entrada representa um progresso do curso de desenvolvedor, convites e lembretes.
Esta entrada representa um progresso do curso de desenvolvedor, convites e lembretes.
CursoDesenvolvedorProgressoIdiomaEntry
Esta entrada representa um progresso do curso de desenvolvedor para um único idioma
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
linguagem
|
language | string |
A linguagem de programação |
|
estado
|
status | string |
O status do idioma do curso |
|
precisão
|
accuracy | integer |
A porcentagem de tentativas corretas para o idioma |
|
confiança
|
confidence | integer |
A proporção de acertos usados para dicas disponíveis para o idioma |
|
minutes_spent
|
minutes_spent | integer |
O tempo total em mimnutes que o usuário gastou no curso para o idioma |
|
Progressos
|
progress | integer |
O progresso do curso para a língua |
|
videos_watched
|
videos_watched | integer |
A quantidade de vídeos que o usuário assistiu para o idioma |