Tempo aproximado para leitura: 6 minutos01. VISÃO GERAL
Este documento apresenta os parâmetros de entrada e o retorno da API de GET de vagas.
IMPORTANTE
- A implementação das integrações via API deve ser realizada pelo cliente, que será responsável pelos custos e pelo desenvolvimento envolvidos.
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 - PARAMETROS OPCIONAIS DA CONSULTA
- Page: Número da página a ser buscada
- Valor padrão quando não presente na consulta é 1
- PageSize: Tamanho da página de registros a serem buscadas
- Valor padrão quando não presente na consulta é 5
Exemplo de URL com ambos os parâmetros:
IMPORTANTE
Tamanho máximo de uma pagina é de 50. Se for enviado um valor maior será enviado somente 50 registros.
2.2 - 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 está 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 é uma unidade que está ativa 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 é uma área que está ativa 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 está com as candidaturas pausadas | true ou false (boolean) | ||
erpRequisitionIntegrationId | Código de requisição vinculada a vaga (integrada com ERP) | texto (string) | ||
| 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) | ||
| puclicationUser | Usuário que publicou | texto (string) | ||
| hiringLimitDate | Contrata até | data (Date) | ||
| pausedInformation (Lista) | startDate | Data início 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 início 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 | ||
jobApplicationMetrics | totalResumeVisualizationHistoric | Quantidade de candidatos que tiveram o CV aberto dentro da vaga | número (long) | |
totalGender | female | Quantidade de candidatos do sexo feminino | número (long) | |
male | Quantidade de candidatos do sexo masculino | número (long) | ||
ratherNotAnswer | Quantidade de candidatos que não informaram o sexo | número (long) | ||
totalPronoun | sheHer | Quantidade de candidatos do pronome Ela/Dela | número (long) | |
heHim | Quantidade de candidatos do pronome Ele/Dele | número (long) | ||
ratherNotAnswer | Quantidade de candidatos que não informaram o pronome | número (long) | ||
totalGenderIdentity | cisgender | Quantidade de candidatos do gênero Cisgênero | número (long) | |
transgender | Quantidade de candidatos do gênero Transgênero | número (long) | ||
nonBinary | Quantidade de candidatos do gênero: Não-binário | número (long) | ||
agender | Quantidade de candidatos do gênero Agênero | número (long) | ||
ratherNotAnswer | Quantidade de candidatos que não informaram o gênero | número (long) | ||
totalColorOrEthnicity | white | Quantidade de candidatos da Cor/Raça/Etnia: Branco | número (long) | |
yellow | Quantidade de candidatos da Cor/Raça/Etnia: Amarelo | número (long) | ||
black | Quantidade de candidatos da Cor/Raça/Etnia: Preto | número (long) | ||
brown | Quantidade de candidatos da Cor/Raça/Etnia: Pardo | número (long) | ||
indigenous | Quantidade de candidatos da Cor/Raça/Etnia: Indígena | número (long) | ||
ratherNotAnswer | Quantidade de candidatos que não informaram a Cor/Raça/Etnia | número (long) | ||
totalSexualOrientation | heterosexual | Quantidade de candidatos da orientação sexual Heterossexual | número (long) | |
bisexual | Quantidade de candidatos da orientação sexual Bissexual | número (long) | ||
homosexual | Quantidade de candidatos da orientação sexual Homossexual | número (long) | ||
asexual | Quantidade de candidatos da orientação sexual Assexual | número (long) | ||
ratherNotAnswer | Quantidade de candidatos que não informaram a orientação sexual | número (long) | ||
totalDisability | totalDisability | Quantidade de candidatos PCD | número (long) | |
noDisability | Quantidade de candidatos que não possuem deficiência | número (long) | ||
physical | Quantidade de candidatos que possuem deficiência física | número (long) | ||
visual | Quantidade de candidatos que possuem deficiência visual | número (long) | ||
auditory | Quantidade de candidatos que possuem deficiência auditiva | número (long) | ||
intellectual | Quantidade de candidatos que possuem deficiência intelectual | número (long) | ||
multiple | Quantidade de candidatos que possuem deficiência múltipla | número (long) | ||
autismSpectrum | Quantidade de candidatos que possuem deficiência transtorno de espectro autista | número (long) | ||
steps | name | Título da etapa | texto (string) | |
totalCurrentApplicants | Quantidade de candidatos que estão atualmente na etapa | número (long) | ||
firstApplicantInDate | Data do primeiro candidato que entrou na etapa | data (Date) | ||
stepDurationInDays | Data do primeiro candidato que entrou vs a data do último que saiu. | número (long) | ||
hiredApplicants | fullName | Nome do candidato que está na etapa de contratação | texto (string) | |
hiredDate | Data da contratação | data (Date) | ||
isInternal | Se é uma vaga interna | true ou false (boolean) | ||
detailsUrl | Url da vaga publicada | texto (string) | ||
involvedUsers | Usuários envolvidos | texto (string) | ||
salaryMinimum | Valor mínimo para a faixa salarial da vaga | número (double) | ||
salaryMaximum | Valor máximo para a faixa salarial da vaga | número (double) | ||
canPublishSalaryRange | Se a faixa salarial deve ser divulgada | true ou false (boolean) | ||
IMPORTANTE
* Todos os campos podem retornar com o valor null, o que significa que o mesmo ainda não possui valor.
1 - Cálculo: 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 - Cálculo: Contratar até - data atual (somente para vagas publicadas, outros status retorna null). Obs.: só é apresentada data quando o status for publicada.
3 - Cálculo: 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 cálculo é 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 - Cálculo: stepDurationInDays - data do primeiro candidato que entrou vs. a data do último que saiu. No cenário de ainda ter candidatos dentro da etapa vamos manter a data atual.
5 - Os totalizadores de cada etapa considera somente candidatos ativos (incluindo reprovados e contratados), ignorando candidatos manuais com convite que não estejam ativos, que seriam o convite recusado ou aguardando 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.
7 - Se a faixa salarial da vaga não for informada, a API retornará null nos campos salaryMinimum e salaryMaximum, e o valor de canPublishSalaryRange será false.
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas