2.0info: 3.17.1 Indexação de Candidatos description: Indexação de Candidatos x-senior-domain: Gestão de Pessoas x-senior-domain-path: hcm x-senior-service-path: candidateindex contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/hcmsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /candidateindex/queries/healthcheck: post: description: HealthCheck Plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/heathcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: HealthCheck Plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/heathcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/queries/whoIsRunning: post: description: Retorna o ip e hostname que recebeu a requisição. tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – ip – hostname properties: ip: type: string description: Ip hostname: type: string description: Hostname 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o ip e hostname que recebeu a requisição. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – ip – hostname properties: ip: type: string description: Ip hostname: type: string description: Hostname 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/actions/deleteAllDocuments: post: description: Exclui todos os candidatos do índice. tags: – Actions x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/actions/deleteCandidatesById: post: description: Exclui um ou mais candidatos do índice de acordo com o seu identificador. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: candidatesId: type: array items: type: string description: Lista de identificadores de candidatos. responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/actions/indexCandidates: post: description: Indexa a lista de candidatos. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – candidates properties: candidates: type: array items: type: object allOf: – #/definitions/candidate minimum: 1 description: Candidatos a serem indexados responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/actions/indexAddresses: post: description: Indexa endereços de candidatos. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – addresses properties: addresses: type: array items: type: object allOf: – #/definitions/candidateAddress minimum: 1 description: Endereços a serem indexados responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/actions/indexCompetencies: post: description: Indexa competências de candidatos. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – competencies properties: competencies: type: array items: type: object allOf: – #/definitions/candidateCompetency minimum: 1 description: Competências a serem indexados responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/actions/indexEmail: post: description: Indexa e-mails de candidatos. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – emails properties: emails: type: array items: type: object allOf: – #/definitions/candidateEmail minimum: 1 description: E-mails a serem indexados responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/actions/indexUpdatedDate: post: description: Indexa a data de atualização dos candidatos. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – updatedDate – candidateIds properties: updatedDate: type: string format: date-time description: Data de atualização. candidateIds: type: array items: type: string minimum: 1 description: Identificadores dos candidatos responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/actions/removeCompetencies: post: description: Remove as competências de candidatos. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – candidateCompetencyId – competencyType properties: candidateCompetencyId: type: array items: type: string minimum: 1 description: Identificador das competências de candidatos. competencyType: type: string allOf: – #/definitions/competencyType description: Tipo de competência responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/actions/indexPositionsSought: post: description: Indexa cargos desejados de candidatos. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – positionsSought properties: positionsSought: type: array items: type: object allOf: – #/definitions/candidatePositionSought minimum: 1 description: Cargos desejados a serem indexados responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/actions/removePositionsSought: post: description: Remove cargos desejados de candidatos. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – candidatePositionSoughtId properties: candidatePositionSoughtId: type: array items: type: string minimum: 1 description: Identificador dos cargos desejados de candidatos responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/actions/indexProfessionalExperiences: post: description: Indexa as experiências profissionais de candidatos. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – positions – companies properties: positions: type: array items: type: object allOf: – #/definitions/candidateJobPosition minimum: 1 description: Cargos a serem indexados companies: type: array items: type: object allOf: – #/definitions/candidateCompany minimum: 1 description: Empresas a serem indexadas responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/actions/removeProfessionalExperiences: post: description: Remove as experiências profissionais de candidatos. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – candidateProfessionalExperienceId properties: candidateProfessionalExperienceId: type: array items: type: string minimum: 1 description: Identificador das experiências profissionais de candidatos. responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/actions/indexJobPositions: post: description: Indexa os cargos de candidatos. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – positions properties: positions: type: array items: type: object allOf: – #/definitions/candidateJobPosition minimum: 1 description: Cargos a serem indexados responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/actions/indexCompanies: post: description: Indexa as empresas de candidatos. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – companies properties: companies: type: array items: type: object allOf: – #/definitions/candidateCompany minimum: 1 description: Empresas a serem indexadas responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/actions/indexVacancies: post: description: Reindexa no documento do candidato todas as suas vagas e a sua situação em cada uma. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – candidatesVacancies properties: candidatesVacancies: type: array items: type: object allOf: – #/definitions/candidateVacanciesSituation minimum: 1 description: Lista de candidatos e suas vagas para reindexação. responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/actions/indexInterests: post: description: Indexa os interesses de candidatos. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – interests properties: interests: type: array items: type: object allOf: – #/definitions/candidateInterest minimum: 1 description: Interesses a serem indexados responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/actions/removeInterests: post: description: Remove os interesses pessoais de candidatos. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – candidateInterestId properties: candidateInterestId: type: array items: type: string minimum: 1 description: Identificador dos interesses pessoais de candidatos. responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/actions/indexLanguages: post: description: Indexa os idiomas de candidatos. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – languages properties: languages: type: array items: type: object allOf: – #/definitions/candidateLanguage minimum: 1 description: Idiomas a serem indexados responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/actions/removeLanguages: post: description: Remove os idiomas de candidatos. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – candidateLanguageId properties: candidateLanguageId: type: array items: type: string minimum: 1 description: Identificador dos idiomas de candidatos. responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/actions/indexEducations: post: description: Indexa as formações acadêmicas de candidatos. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – educations properties: educations: type: array items: type: object allOf: – #/definitions/candidateEducation minimum: 1 description: Formações a serem indexadas responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/actions/removeEducations: post: description: Remove as formações acadêmicas de candidatos. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – candidateEducationId properties: candidateEducationId: type: array items: type: string minimum: 1 description: Identificador das formações acadêmicas de candidatos. responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/actions/indexDisabilities: post: description: Indexa as deficiências de candidatos. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – disabilities properties: disabilities: type: array items: type: object allOf: – #/definitions/candidateDisability minimum: 1 description: Deficiências a serem indexadas responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/actions/indexHasMessages: post: description: Indexa se o candidato possui mensagens tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – candidateHasMessages properties: candidateHasMessages: type: array items: type: object allOf: – #/definitions/candidateHasMessages minimum: 1 description: Se o candidato possui mensagens responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/actions/indexGrantedDataAccess: post: description: Indexa se o candidato permitiu acesso aos seus dados. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – candidateGrantedDataAccess properties: candidateGrantedDataAccess: type: array items: type: object allOf: – #/definitions/candidateGrantedDataAccess minimum: 1 description: Indicativos se o candidato permitiu acesso aos seus dados. responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/actions/indexCurrentCompany: post: description: Indexa as informações da empresa e filial do candidato interno. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – candidateCurrentCompany properties: candidateCurrentCompany: type: array items: type: object allOf: – #/definitions/candidateCurrentCompany minimum: 1 description: As informações da empresa e filial do candidato interno. responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/actions/recreateDisabilities: post: description: Reindexa as deficiências de candidatos. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – disabilities properties: disabilities: type: array items: type: object allOf: – #/definitions/candidateDisability minimum: 1 description: Deficiências a serem indexadas responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/actions/removeDisabilities: post: description: Remove as deficiências de candidatos. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – candidateDisabilityId properties: candidateDisabilityId: type: array items: type: string minimum: 1 description: Identificador das deficiências de candidatos. responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/actions/addSubscribedVacancies: post: description: Adiciona N ids de vagas em N candidatos inscritos. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – vacancies properties: vacancies: type: array items: type: object allOf: – #/definitions/candidateVacancy minimum: 1 description: Vagas com os candidatos responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/actions/removeSubscribedVacancies: post: description: Remove N ids de vagas de N candidatos inscritos. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – vacancies properties: vacancies: type: array items: type: object allOf: – #/definitions/candidateVacancy minimum: 1 description: Vagas com os candidatos responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/actions/addSelectedVacancies: post: description: Adiciona N ids de vagas em N candidatos selecionados. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – vacancies properties: vacancies: type: array items: type: object allOf: – #/definitions/candidateVacancy minimum: 1 description: Vagas com os candidatos responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/actions/removeSelectedVacancies: post: description: Remove N ids de vagas de N candidatos selecionados. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – vacancies properties: vacancies: type: array items: type: object allOf: – #/definitions/candidateVacancy minimum: 1 description: Vagas com os candidatos responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/actions/addEliminatedVacancies: post: description: Adiciona N ids de vagas em N candidatos eliminados. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – vacancies properties: vacancies: type: array items: type: object allOf: – #/definitions/candidateVacancy minimum: 1 description: Vagas com os candidatos responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/actions/removeEliminatedVacancies: post: description: Remove N ids de vagas de N candidatos eliminados. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – vacancies properties: vacancies: type: array items: type: object allOf: – #/definitions/candidateVacancy minimum: 1 description: Vagas com os candidatos responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/actions/addMessagesVacancies: post: description: Adiciona N ids de vagas em N candidatos eliminados. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – vacancies properties: vacancies: type: array items: type: object allOf: – #/definitions/candidateVacancy minimum: 1 description: Vagas com os candidatos responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/actions/removeMessagesVacancies: post: description: Remove N ids de vagas de N candidatos eliminados. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – vacancies properties: vacancies: type: array items: type: object allOf: – #/definitions/candidateVacancy minimum: 1 description: Vagas com os candidatos responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/actions/candidateViewed: post: description: Define que um usuário visualizou o candidate em determinada vaga. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – candidateId – vacancyId properties: candidateId: type: string description: Identificador do candidato. vacancyId: type: string description: Identificador do vaga. responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/actions/removeCandidateViews: post: description: Remove todas as visualizações dos candidatos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – candidateIds properties: candidateIds: type: array items: type: string minimum: 1 description: Lista de identificadores de candidatos. responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/actions/hasAnnotations: post: description: Indica que os candidatos informados possuem ou não comentários tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – candidateIds – hasAnnotations properties: candidateIds: type: array items: type: string minimum: 1 description: Lista de identificadores de candidatos. hasAnnotations: type: boolean description: Indica se possui comentário. responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/actions/setHasMessages: post: description: Informa se os candidatos possuem ou não mensagens tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – candidateIds – hasMessages properties: candidateIds: type: array items: type: string minimum: 1 description: Lista de identificadores de candidatos. hasMessages: type: boolean description: Indica se possui comentário. responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/actions/indexCandidateTestResults: post: description: Indexa os resultados dos testes do candidato tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – testResults properties: testResults: type: array items: type: object allOf: – #/definitions/candidateTestResult minimum: 1 description: Resultados a serem indexados responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/actions/indexCandidateIndications: post: description: Indexa a inclusão de indicações do candidato. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: indications: type: array items: type: object allOf: – #/definitions/candidateIndication description: Lista das indicações do candidato. responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/actions/removeCandidateIndications: post: description: Remover as indicações dos candidatos. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – candidateIndicationId properties: candidateIndicationId: type: array items: type: string minimum: 1 description: Lista dos identificadores únicos de candidatos. responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/actions/indexCandidateHasIndication: post: description: Indexa a informação se o candidato possui indicação. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – candidateHasIndications properties: candidateHasIndications: type: array items: type: object allOf: – #/definitions/candidateHasIndication minimum: 1 description: Lista do candidato e suas respectivas informações. responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /candidateindex/signals/deleteCandidate: post: description: Exclui um candidato do índice de acordo com o seu identificador. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – candidateId properties: candidateId: type: string description: Identificador do candidato. responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /candidateindex/signals/deleteCandidates: post: description: Exclui um ou mais candidatos do índice de acordo com o seu identificador. tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: candidatesId: type: array items: type: string description: Lista de identificadores de candidatos. responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /candidateindex/signals/indexCandidatesRetry: post: description: Tenta novamente indexar a lista de candidatos, com o máximo de 10 tentativas. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – candidates – attempt properties: candidates: type: array items: type: object allOf: – #/definitions/candidate minimum: 1 description: Candidatos a serem indexados attempt: type: integer format: int64 description: Tentativa responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /candidateindex/signals/reindexCandidates: post: description: Reindexa a lista de candidatos. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – candidates properties: candidates: type: array items: type: object allOf: – #/definitions/candidate minimum: 1 description: Candidatos a serem indexados responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /candidateindex/events/indexedCandidates: post: description: Evento que notifica que foi realizada a indexação dos candidatos. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – candidates properties: candidates: type: array items: type: object allOf: – #/definitions/candidate minimum: 1 description: Identificadores dos candidatos. responses: 200: description: OK default: description: Error response schema: #/definitions/genericErrordefinitions: heathcheckDTO: description: Status do healthcheck type: string enum: – UP – DOWN educationStatusType: description: Situações da formação acadêmica type: string enum: – IN_PROGRESS – SUSPENDED – CANCELED – FINALIZED competencyType: description: Tipos de competências type: string enum: – KNOWLEDGE – ABILITY genderType: description: Gêneros type: string enum: – FEMALE – MALE – LGPD_EXCLUSION candidateSituation: description: Situação do candidato. type: string enum: – SUBSCRIBED – SELECTED – ELIMINATED userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT checkDTO: description: Retorno status usados de retorno type: object required: – name – status properties: name: type: string description: Nome do status status: type: string allOf: – #/definitions/heathcheckDTO description: Status vacanciesSituation: description: Vaga e a situação do candidato na mesma. type: object required: – vacancy – situation properties: vacancy: type: string description: Identificador da vaga situation: type: string allOf: – #/definitions/candidateSituation description: Situação do candidato na vaga candidateVacanciesSituation: description: Candidato e suas N situações nas vagas type: object required: – candidateId properties: candidateId: type: string description: Identificador da vaga. vacancies: type: array items: type: object allOf: – #/definitions/vacanciesSituation description: Identificadores dos candidatos candidateVacancy: description: Vagas e seus candidatos. type: object required: – vacancyId – candidateIds properties: vacancyId: type: string description: Identificador da vaga. candidateIds: type: array items: type: string minimum: 1 description: Identificadores dos candidatos candidateInterest: description: Interesse. type: object required: – id – candidateId properties: id: type: string description: Identificador. interest: type: string description: Interesse. candidateId: type: string description: Id do candidato candidateJobPosition: description: Cargo. type: object required: – id – candidateId properties: id: type: string description: Identificador. name: type: string description: Nome. candidateId: type: string description: Id do candidato candidateAddress: description: Endereço. type: object required: – candidateId properties: candidateId: type: string description: Id do candidato state: type: string description: Estado. stateAbbreviation: type: string description: Sigla do estado. city: type: string description: Cidade. country: type: string description: País. neighborhood: type: string description: Bairro. postalCode: type: string description: Código postal. candidateEducation: description: Formação acadêmica. type: object required: – id – candidateId properties: id: type: string description: Identificador. course: type: string description: Curso. institution: type: string description: Instituição. level: type: string description: Nível typeSituation: type: string allOf: – #/definitions/educationStatusType description: Situação da formação acadêmica candidateId: type: string description: Id do candidato candidateLanguage: description: Idioma. type: object required: – id – candidateId properties: id: type: string description: Identificador. name: type: string description: Nome. level: type: string description: Nível candidateId: type: string description: Id do candidato candidateCompetency: description: Competências. type: object required: – id – candidateId properties: id: type: string description: Identificador. name: type: string description: Nome. candidateId: type: string description: Id do candidato candidateEmail: description: Email do candidato. type: object required: – email – candidateId properties: email: type: string description: E-mail. candidateId: type: string description: Id do candidato candidatePositionSought: description: Cargo/área desejado. type: object required: – id – candidateId properties: id: type: string description: Identificador. job: type: string description: Cargo. area: type: string description: Área candidateId: type: string description: Id do candidato candidateDisability: description: Deficiência. type: object required: – id – candidateId properties: id: type: string description: Identificador. name: type: string description: Nome. candidateId: type: string description: Id do candidato candidateCompany: description: Empresa. type: object required: – id – candidateId properties: id: type: string description: Identificador. name: type: string description: Estabelecimento. candidateId: type: string description: Id do candidato candidateSummary: description: Dados básicos do candidato. discriminator: _discriminator type: object required: – id – _discriminator properties: id: type: string description: Identificador único. externalId: type: string description: Identificador único HCM. name: type: string description: Nome. birthday: type: string format: date description: Data de nascimento. attachment: type: string description: Anexo. photoAttachment: type: string description: Foto. photoThumbnailLink: type: string description: Url do thumbnail da foto. salaryExpectation: type: number format: double description: Salário desejado. disabilities: type: array items: type: object allOf: – #/definitions/candidateDisability description: Deficiências. candidateType: type: string description: Tipo do candidato subscribedVacancies: type: array items: type: string description: Quantidade de vagas em que o candidato está inscrito. state: type: string description: Estado. stateAbbreviation: type: string description: Sigla do estado. city: type: string description: Cidade. selected: type: boolean description: Indica se o candidato foi selecionado. eliminated: type: boolean description: Indica se o candidato foi eliminado. hasMessagesVacancy: type: boolean description: Indica se o candidato recebeu mensagem na vaga do contexto. hasMessages: type: boolean description: Indica se o candidato recebeu alguma mensagem. hasIndications: type: boolean description: Indica se o candidato possui indicações. adherence: type: number format: double description: Aderência. visualized: type: boolean description: Indica se foi visualizado pelo usuário atual na vaga atual. selectedVacancies: type: array items: type: string description: Vagas em que o candidato foi selecionado. eliminatedVacancies: type: array items: type: string description: Vagas em que o candidato foi eliminado. receivedMessagesVacancies: type: array items: type: string description: Vagas em que o candidato recebeu mensagens. dismissed: type: boolean description: Ex-colaborador. hasAnnotations: type: boolean description: Possui comentários gender: type: string allOf: – #/definitions/genderType description: Gênero do candidato vacancies: type: array items: type: object allOf: – #/definitions/vacanciesSituation description: Vagas que o candidato concorre grantedDataAccess: type: boolean description: Indica se o candidato concedeu acesso aos dados.\nEste campo irá armazenar a última ação efetuada pelo candidato no sentido de indicar se o acesso\nestá liberado ou não. Caso o candidato faça o aceite e revogação várias vezes, o histórico ficará\narmazenado, porém, aqui, só estará a última ação.\n _discriminator: type: string description: candidate: description: Dados do candidato. allOf: – #/definitions/candidateSummary – type: object properties: email: type: string description: E-mail travelPossibility: type: boolean description: Disponibilidade para viagens. realocationPossibility: type: boolean description: Disponibilidade de mudança. competencies: type: array items: type: object allOf: – #/definitions/candidateCompetency description: Habilidades e Conhecimentos. interests: type: array items: type: object allOf: – #/definitions/candidateInterest description: Interesses. languages: type: array items: type: object allOf: – #/definitions/candidateLanguage description: Idiomas. positionsSought: type: array items: type: object allOf: – #/definitions/candidatePositionSought description: Cargos e áreas pretendidas. educations: type: array items: type: object allOf: – #/definitions/candidateEducation description: Graduações. country: type: string description: País. neighborhood: type: string description: Bairro. postalCode: type: string description: Código postal. companies: type: array items: type: object allOf: – #/definitions/candidateCompany description: Histórico profissional de empresas. jobPositions: type: array items: type: object allOf: – #/definitions/candidateJobPosition description: Histórico profissional de cargos. updatedDate: type: string format: date-time description: Data da última atualização. professionalSummary: type: string description: Resumo profissional. professionalGoal: type: string description: Objetivo profissional. indications: type: array items: type: object allOf: – #/definitions/candidateIndication description: Lista das indicações de candidatos. headOffice: type: string description: Empresa do candidato interno branchOffice: type: string description: Filial do candidato interno candidateHasMessages: description: Registro com informações do candidato e se ele possui mensagens. type: object required: – candidateId – hasMessages properties: candidateId: type: string description: Identificador do candidato. hasMessages: type: boolean description: Se o candidato possui mensagens candidateTestResult: description: Resultados dos testes do candidato type: object required: – testResultId – candidateId – testId – score properties: testResultId: type: string description: Identificador do resultado do teste candidateId: type: string description: Identificador do candidato testId: type: string description: Identificador do teste functionId: type: string description: Identificador da função score: type: number format: double description: Nota candidateGrantedDataAccess: description: Registro com informações do candidato e se ele permitiu acesso aos seus dados. type: object required: – candidateId – grantedDataAccess properties: candidateId: type: string description: Identificador do candidato. grantedDataAccess: type: boolean description: Indicativo se o candidato permitiu acesso aos seus dados. candidateIndication: description: Indexa as indicações de candidatos. type: object required: – id – candidateId properties: id: type: string description: Identificador da indicação. indication: type: string description: Nome da pessoa que realizou a indicação. candidateId: type: string description: Identificador do colaborador. candidateHasIndication: description: Indexa a informação se o candidato possui indicações. type: object required: – candidateId – hasIndications properties: candidateId: type: string description: Identificador do candidato. hasIndications: type: boolean description: Se o candidato possui indicações. candidateCurrentCompany: description: Registro com informações da empresa e da filial do candidato. type: object required: – candidateId properties: candidateId: type: string description: Identificador do candidato. headOffice: type: string description: Empresa branchOffice: type: string description: Filial notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE