01. VISÃO GERAL
Este documento apresenta os parâmetros de entrada e o retorno da API de GET de vagas.
02. ENDPOINT E PARÂMETROS DE ENTRADA
Endpoint da API que será utilizado para inserir e atualizar dados:
| URL base | Endpoint |
|---|---|
| https://api-centraldorecrutador.totvs.app/recruitment-integration | {URL base}/api/v1/job-opportunity/get-all |
2.1 - DADOS ENVIADOS
Não é necessário realizar o envio de nenhum dado.
Retorno:
| Campos | Descrição | Possíveis valores* | ||
|---|---|---|---|---|
| code | Código interno da vaga | número (long) | ||
| title | Título da vaga | texto (string) | ||
position | name | Nome do Cargo | texto (string) | |
| integrationId | ID único de integração | texto (string) | ||
positionLevel | Nível do cargo | Enum de inteiros 0 - Estágio | ||
isActive | Se é um cargo que esta ativo no sistema (não excluído) | true ou false (boolean) | ||
facility | name | Nome da Unidade | texto (string) | |
integrationId | ID único de integração | texto (string) | ||
cnpj | CNPJ da unidade | texto (string) | ||
isActive | Se é um cargo que esta ativo no sistema (não excluído) | true ou false (boolean) | ||
department | name | Nome da área | texto (string) | |
integrationId | ID único de integração | texto (string) | ||
isActive | Se é um cargo que esta ativo no sistema (não excluído) | true ou false (boolean) | ||
| registrationUser | Nome do usuário que criou a vaga | texto (string) | ||
| address | cityName | Cidade | texto (string) | |
| stateName | Estado | texto (string) | ||
| numberOfOpenings | Número de posições | número (int) | ||
status | Status atual da vaga | Enum de inteiros 0 - Rascunho | ||
isApplicationPaused | Vaga esta com as candidaturas pausadas | true ou false (boolean) | ||
| requisitionCode | Código da requisição | texto (string) | ||
| requisitionReason | Motivo da requisição | Enum de inteiros 0 - Nenhuma opção de requisição | ||
| requisitionJustification | Justificação da requisição | texto (string) | ||
| registrationDate | Data de criação | data (Date) | ||
| publicationDate | Data de publicação | data (Date) | ||
| hiringLimitDate | Contrata até | data (Date) | ||
| pausedInformation (Lista) | startDate | Data inicio da pausa | data (Date) | |
| endDate | Data fim da pausa | data (Date) | ||
| totalTimeInDays | Total de dias pausado (arredondado para baixo) | número (long) | ||
| finishedDate | Data de Finalização | data (Date) | ||
| frozenInfo (Lista) | startDate | Data inicio do congelamento | data (Date) | |
| endDate | Data fim do congelamento | data (Date) | ||
| totalTimeInDays | Total de dias congelado (arredondado para baixo) | número (long) | ||
| statusHistory (Lista) | changeDate | Data da mudança para o status | data (Date) | |
| status | Status de mudança | Enum de inteiros 1 - Publicada | ||
| comment | Comentário da mudança de status | texto (string) | ||
| slaInformation | slaValue | SLA real da vaga1 | número (long) | |
| slaUpToHiringLimitDate | SLA até a data de Contratar até2 | número (long) | ||
| slaWithoutFrozenDays | SLA real removendo os dias congelados3 | número (long) | ||
| currentStep | Última etapa em que um candidato passou | texto (string) | ||
| currentPhase | Última fase em que um candidato passou | Enum de inteiros 1 - Candidatura | ||
| | Quantidade de candidatos que tiveram o CV aberto dentro da vaga | número(long) | |
| | Quantidade de candidatos do sexo feminino | número(long) | |
| Quantidade de candidatos do sexo masculino | número(long) | ||
| Quantidade de candidatos que não informaram o sexo | número(long) | ||
| | Quantidade de candidatos do pronome Ela/Dela | número(long) | |
| Quantidade de candidatos do pronome Ele/Dele | número(long) | ||
| Quantidade de candidatos que não informaram o pronome | número(long) | ||
| | Quantidade de candidatos do gênero Cisgênero | número(long) | |
| Quantidade de candidatos do gênero Transgênero | número(long) | ||
| Quantidade de candidatos do gênero: Não-binário | número(long) | ||
| Quantidade de candidatos do gênero Agênero | número(long) | ||
| Quantidade de candidatos que não informaram o gênero | número(long) | ||
| | Quantidade de candidatos da cor/raça/etnia Branco | número(long) | |
| Quantidade de candidatos da cor/raça/etnia Amarelo | número(long) | ||
| Quantidade de candidatos da Cor/Raça/Etnia: Preto | número(long) | ||
| Quantidade de candidatos da Cor/Raça/Etnia: Pardo | número(long) | ||
| Quantidade de candidatos da Cor/Raça/Etnia: Indígena | número(long) | ||
| Quantidade de candidatos que não informaram a Cor/Raça/Etnia | número(long) | ||
| | Quantidade de candidatos da orientação sexual Heterossexual | número(long) | |
| Quantidade de candidatos da orientação sexual Bissexual | número(long) | ||
| Quantidade de candidatos da orientação sexual Homossexual | número(long) | ||
| Quantidade de candidatos da orientação sexual Assexual | número(long) | ||
| Quantidade de candidatos que não informaram a orientação sexuall | número(long) | ||
| | Quantidade de candidatos PCD | número(long) | |
| Quantidade de candidatos que não possuem defiência | número(long) | ||
| Quantidade de candidatos que possuem deficiência física | número(long) | ||
| Quantidade de candidatos que possuem deficiência visual | número(long) | ||
| Quantidade de candidatos que possuem deficiência auditiva | número(long) | ||
| Quantidade de candidatos que possuem deficiência intelectual | número(long) | ||
| Quantidade de candidatos que possuem deficiência múltipla | número(long) | ||
| Quantidade de candidatos que possuem deficiência transtorno de espectro autista | número(long) | ||
| | Título da etapa | texto (string) | |
| Quantidade de candidatos que estão atualmente na etapa | número(long) | ||
| Data do primeiro candidato que entrou na etapa | data (Date) | ||
| Data do primeiro candidato que entrou vs a data do ultimo que saiu. | número(long) | ||
| | Nome do candidato que está na etapa de contratação | texto (string) | |
| Data da contratação | data (Date) | ||
IMPORTANTE
* Todos os campos podem retornar com o valor null, o que significa que o mesmo ainda não possui valor.
1 - Calculo: Data de fechamento da vaga - data de publicação (somente vagas finalizadas, canceladas e congeladas) ou Data atual - Data de abertura (para as vagas que estão abertas)(retorna null para vagas em rascunho)
2 - Calculo: Contratar até - data atual (somente para vagas publicadas, outros status retorna null) Obs: só é apresentada data quando o status for publicada
3 - Calculo: slaValue - total de dias congelados (retorna null para vagas em rascunho) Obs: O valor pode ficar menor do que o esperado ao somar o total de dias do campo frozenInfo pois o total de dias individuais são arredondados para baixo para serem apresentados, mas para fazer o calculo é considerado o valor real e depois que é feito o arredondamento. Exemplo: Caso existissem 2 períodos de congelamento um que durou 1,4 e outro que durou 1,6 dias a API irá retornar 1 dia para ambos os períodos mas para fazer a some ao invés de 2 seria 3.
4 - Calculo: stepDurationInDays Data do primeiro candidato que entrou vs. a data do ultimo que saiu. No cenário de ainda ter candidatos dentro da etapa vamos manter a data atual.
5 - Os totalizadores de cada etapa os indicadores de D&I considera somente candidatos ativos, ignorando candidatos manuais com convite que não estejam ativos, que seriam o convite recusado ou aguardando o aceite.
6 - Data da primeira candidatura pode sofrer uma mudança caso tenha uma inclusão manual que ainda não está ativa e posteriormente se torne ativa, a data caso seja menor que as demais candidaturas pode ser tornar a data da primeira candidatura.
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas