BFF (Backend For Frontend) – Recrutamento e Seleção (recruitmentbff)

2.0info: 1.2.0 BFF (Backend For Frontend) – Recrutamento e Seleção x-senior-domain: hcm x-senior-domain-path: hcm x-senior-service-path: recruitmentbff 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: /recruitmentbff/queries/healthcheck: post: description: Verifica se o serviço está ativo tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO 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: Verifica se o serviço está ativo tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /recruitmentbff/queries/isUsingFlexibleStageModelGroupJourney: post: description: Verifica se o cliente está utilizando a nova jornada flexível de grupo de modelo de etapass tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Indica se o cliente está usando a nova jornada flexível do grupo de modelo de etapas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verifica se o cliente está utilizando a nova jornada flexível de grupo de modelo de etapass tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Indica se o cliente está usando a nova jornada flexível do grupo de modelo de etapas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /recruitmentbff/queries/searchCompanies: post: description: Retorna uma lista paginada de empresas com base em parâmetros de busca tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: companyId: type: string description: Id da empresa para buscar por headQuarterId queryTerms: type: string description: Filtro de Nome da empresa page: type: integer format: int64 description: Número da página/lote de registros minimum: 0 default: 0 size: type: integer format: int64 description: Número de registros por página minimum: 1 maximum: 100 default: 10 responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – records properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de elementos records: type: array items: type: object allOf: – #/definitions/companyDTO minimum: 1 description: Lista de empresas encontradas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista paginada de empresas com base em parâmetros de busca tags: – Queries x-senior-visibility: PRIVATE parameters: – name: companyId description: Id da empresa para buscar por headQuarterId in: query type: string – name: queryTerms description: Filtro de Nome da empresa in: query type: string – name: page description: Número da página/lote de registros in: query type: integer format: int64 – name: size description: Número de registros por página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – records properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de elementos records: type: array items: type: object allOf: – #/definitions/companyDTO minimum: 1 description: Lista de empresas encontradas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /recruitmentbff/queries/findJobPositionsByCompany: post: description: Retorna uma lista paginada de cargos com base na empresa informada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – companyExternalId properties: companyExternalId: type: string description: ID da empresa na base HCM searchParam: type: string description: Busca por nome do cargo/função page: type: integer format: int64 description: Página da busca minimum: 0 default: 0 size: type: integer format: int64 description: Tamanho de registros por página minimum: 1 maximum: 100 default: 10 responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – records properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de elementos records: type: array items: type: object allOf: – #/definitions/jobPositionDTO minimum: 1 description: Lista de empresas encontradas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista paginada de cargos com base na empresa informada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: companyExternalId description: ID da empresa na base HCM in: query required: true type: string – name: searchParam description: Busca por nome do cargo/função in: query type: string – name: page description: Página da busca in: query type: integer format: int64 – name: size description: Tamanho de registros por página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – records properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de elementos records: type: array items: type: object allOf: – #/definitions/jobPositionDTO minimum: 1 description: Lista de empresas encontradas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /recruitmentbff/queries/findCandidates: post: description: Encontra candidatos com base em parâmetros de busca avançada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parameters properties: parameters: type: object allOf: – #/definitions/filterCandidatesParametersDTO description: Parâmetros de busca avançada page: type: integer format: int64 description: Número da página/lote de registros minimum: 0 default: 0 size: type: integer format: int64 description: Número de registros por página minimum: 1 maximum: 100 default: 10 responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – records – settings properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de elementos records: type: array items: type: object allOf: – #/definitions/findCandidatesContentsDTO minimum: 1 description: Lista de candidatos encontrados settings: type: object allOf: – #/definitions/permissionsDTO description: Ações que o usuário pode executar sobre os registros retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /recruitmentbff/queries/findStageModelGroups: post: description: Busca grupos de modelo de etapas com opções de busca individual por ID ou busca livre paginada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/stageModelGroupRequestDTO responses: 200: description: Ok schema: type: object allOf: – #/definitions/stageModelGroupResponseDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca grupos de modelo de etapas com opções de busca individual por ID ou busca livre paginada tags: – Queries x-senior-visibility: PRIVATE parameters: – name: page description: Número da página in: query type: integer format: int64 – name: size description: Número de registros por página in: query type: integer format: int64 – name: displayFields description: Campos que devem ser incluídos na resposta (opcional, para otimização de payload) in: query type: string – name: sortingField description: Campo para ordenação dos resultados in: query type: string – name: id description: ID do grupo de modelo de etapas (opcional, para busca individual) in: query type: string – name: searchText description: Texto para busca livre por nome do grupo de modelo de etapas (opcional, para busca paginada) in: query type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/stageModelGroupResponseDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /recruitmentbff/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 /recruitmentbff/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 /recruitmentbff/actions/createStageModelGroup: post: description: Cria uma modelo de grupo de etapas tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – name – companyId – jobPositionIds – stageModels properties: id: type: string description: Identificador único do modelo de grupo de etapas name: type: string description: Nome do modelo de grupo de etapas description: type: string description: Descrição do modelo de grupo de etapas companyId: type: string description: Identificador da empresa jobPositionIds: type: array items: type: string minimum: 1 description: Identificador dos cargos stageModels: type: array items: type: object allOf: – #/definitions/settingsStageModel minimum: 1 description: Modelos de etapas associados ao grupo responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /recruitmentbff/signals/activateFlexibleStageModelGroupJourney: post: description: Ativa a nova jornada flexível de grupo de modelo de etapas de forma assíncrona tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericErrordefinitions: healthcheckDTO: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Saudável * `DOWN` – Ruim candidateType: type: string enum: – INTERNAL – EXTERNAL – BOTH description: Tipo de candidato.: * `INTERNAL` – Candidato interno. * `EXTERNAL` – Candidato externo. * `BOTH` – Ambos disabilityType: type: string enum: – PHYSICAL – HEARING – VISUAL – MENTAL – INTELLECTUAL – OTHER description: Tipo de deficiência.: * `PHYSICAL` – Física. * `HEARING` – Auditiva. * `VISUAL` – Visual. * `MENTAL` – Mental. * `INTELLECTUAL` – Intelectual. * `OTHER` – Outras. educationLevel: type: string enum: – ELEMENTARY_SCHOOL_REGULAR – ELEMENTARY_SCHOOL_SUPPLEMENTARY – HIGH_SCHOOL_REGULAR – HIGH_SCHOOL_SUPPLEMENTARY – HIGH_SCHOOL_TECHNICAL – HIGHER_EDUCATION – POST_GRADUATE_SPECIALIZATION – MASTERS_DEGREE – PHD_DEGREE – POST_DOCTORATE – FREE_DOCENCY – ASSISTANT – TITULAR – MBA – LGPD_EXCLUSION – COL_PREESCOLAR – COL_BASICA_PRIMARIA – COL_BASICA_SECUNDARIA – COL_MEDIA_ACADEMICA_O_CLASICA – COL_MEDIA_TECNICA – COL_NORMALISTA – COL_TECNICA_PROFESIONAL – COL_TECNOLOGICA – COL_PROFESIONAL – COL_ESPECIALIZACION – COL_MAESTRIA – COL_DOCTORADO – COL_POST_DOCTORADO – COL_NINGUNO – TECHNOLOGIST – TECHNICAL_EDUCATION description: Nivel de formação: * `ELEMENTARY_SCHOOL_REGULAR` – Ensino fundamental. * `ELEMENTARY_SCHOOL_SUPPLEMENTARY` – Ensino fundamental supletivo. * `HIGH_SCHOOL_REGULAR` – Ensino médio. * `HIGH_SCHOOL_SUPPLEMENTARY` – Ensino médio supletivo. * `HIGH_SCHOOL_TECHNICAL` – Ensino médio técnico. * `HIGHER_EDUCATION` – Superior. * `POST_GRADUATE_SPECIALIZATION` – Especialização. * `MASTERS_DEGREE` – Mestrado. * `PHD_DEGREE` – Ph.D. * `POST_DOCTORATE` – Doutorado. * `FREE_DOCENCY` – Livre docência. * `ASSISTANT` – Adjunto. * `TITULAR` – Titular. * `MBA` – MBA. * `LGPD_EXCLUSION` – Exclusão LGPD. * `COL_PREESCOLAR` – Preescolar * `COL_BASICA_PRIMARIA` – Básica Primaria * `COL_BASICA_SECUNDARIA` – Básica Secundaria * `COL_MEDIA_ACADEMICA_O_CLASICA` – Media académica o clásica * `COL_MEDIA_TECNICA` – Media Técnica * `COL_NORMALISTA` – Normalista * `COL_TECNICA_PROFESIONAL` – Técnica Profesional * `COL_TECNOLOGICA` – Tecnológica * `COL_PROFESIONAL` – Profesional * `COL_ESPECIALIZACION` – Especialización * `COL_MAESTRIA` – Maestría * `COL_DOCTORADO` – Doctorado * `COL_POST_DOCTORADO` – Post – Doctorado * `COL_NINGUNO` – Ninguno * `TECHNOLOGIST` – Técnologo * `TECHNICAL_EDUCATION` – Técnico educationStatusType: type: string enum: – IN_PROGRESS – SUSPENDED – CANCELED – FINALIZED description: Estado da formação acadêmica.: * `IN_PROGRESS` – Em andamento. * `SUSPENDED` – Suspensa. * `CANCELED` – Cancelada. * `FINALIZED` – Concluída. genderTypeFilter: type: string enum: – MALE – FEMALE – LGPD_EXCLUSION – ALL description: Enumeração para filtros de gênero: * `MALE` – Masculino. * `FEMALE` – Feminino. * `LGPD_EXCLUSION` – Exclusão LGPD. * `ALL` – Todos genderType: type: string enum: – MALE – FEMALE – LGPD_EXCLUSION description: Sexo: * `MALE` – Masculino. * `FEMALE` – Feminino. * `LGPD_EXCLUSION` – Exclusão LGPD. assessmentsResultMode: type: string enum: – TALENT_POOL – MANAGEMENT_VACANCY – KANBAN – FUNCTION description: Tipo de pesquisa para resultados dos testes: * `TALENT_POOL` – Banco de talentos * `MANAGEMENT_VACANCY` – Gerenciamento da vaga * `KANBAN` – Kanban * `FUNCTION` – Função stageType: type: string enum: – SORTED – CUSTOM – APPROVATION description: Tipos de etapas.: * `SORTED` – Triagem. * `CUSTOM` – Customizado. * `APPROVATION` – Aprovação userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – 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/healthcheckDTO description: Status filterCandidatesParametersDTO: description: DTO com parâmetros para filtro de candidatos type: object required: – filter properties: filter: type: object allOf: – #/definitions/candidateFilterDTO description: Filtro de candidatos indications: type: array items: type: string description: Indicado por languages: type: array items: type: string description: Filtro de idiomas disabilities: type: array items: type: string allOf: – #/definitions/disabilityType description: Filtro de deficiências jobPositions: type: array items: type: string description: Filtro de cargos/funções companies: type: array items: type: string description: Filtro de empresas location: type: object allOf: – #/definitions/locationFilterDTO description: Filtro de endereços knowledges: type: array items: type: string description: Filtro de conhecimentos/competências educationLevels: type: array items: type: string allOf: – #/definitions/educationLevel description: Filtro de níveis de formação acadêmica educationStatus: type: array items: type: string allOf: – #/definitions/educationStatusType description: Filtro de status de formação acadêmica courses: type: array items: type: string description: Filtro de Cursos positionsSought: type: array items: type: string description: Filtro de cargos desejados personalInterests: type: array items: type: string description: Filtro de interesses pessoais candidateFilterDTO: description: DTO com parâmetros para filtro de candidatos type: object required: – candidateType – gender properties: searchBy: type: string maxLength: 50 description: Texto para pesquisa livre candidateType: type: string allOf: – #/definitions/candidateType description: Tipo de candidato gender: type: string allOf: – #/definitions/genderTypeFilter description: Gênero do candidato settings: type: object allOf: – #/definitions/settingsFilterDTO description: Filtro de opções e configurações adicionais age: type: object allOf: – #/definitions/ageFilterDTO description: Filtro de idade resumeUpdateDate: type: object allOf: – #/definitions/resumeUpdateDateFilterDTO description: Filtro de data de atualização do currículo salaryExpectation: type: object allOf: – #/definitions/salaryExpectationFilterDTO description: Filtro de expectativa salarial settingsFilterDTO: description: DTO com parâmetros de configuração e opções escolhidas para filtro de candidatos type: object properties: hasIndications: type: boolean description: Possui indicações? hasProfessionalExperience: type: boolean description: Possui experiência profissional? hasTravelPossibility: type: boolean description: Posssui disponibilidade para viagem? hasRealocationPossibility: type: boolean description: Possui disponibilidade para mudança? hideFormerEmployees: type: boolean description: Ocultar ex-colaboradores? hideScreenedCandidates: type: boolean description: Ocultar candidatos triados? ageFilterDTO: description: DTO com parâmetros para filtro de idade de candidatos type: object required: – start – end properties: start: type: integer format: int64 description: Idade mínima minimum: 0 end: type: integer format: int64 description: Idade máxima minimum: 0 resumeUpdateDateFilterDTO: description: DTO com parâmetros para filtro de data de atualização do currículo type: object required: – start – end properties: start: type: string format: date description: Data inicial da atualização do currículo end: type: string format: date description: Data final da atualização do currículo salaryExpectationFilterDTO: description: DTO com parâmetros para filtro de expectativa salarial de candidatos type: object required: – start – end properties: start: type: number format: double description: Pretensão salarial inicial minimum: 0.0 end: type: number format: double description: Pretensão salarial final minimum: 0.0 locationFilterDTO: description: DTO com parâmetros para filtro de localização de candidatos type: object properties: countries: type: array items: type: string description: Países provinces: type: array items: type: string description: Estados cities: type: array items: type: string description: Cidades neighborhoods: type: array items: type: string description: Bairros findCandidatesContentsDTO: description: DTO com o conteúdo dos candidatos encontrados type: object required: – candidate – informations – assessments properties: candidate: type: object allOf: – #/definitions/candidateBasicDTO description: Dados do candidato informations: type: object allOf: – #/definitions/candidateInformationDTO description: Informações complementares do candidato assessments: type: object allOf: – #/definitions/candidateAssessmentsDTO description: Avaliações do candidato candidateBasicDTO: description: DTO com os dados básicos do candidato type: object required: – id – name – candidateType – gender – age – localization – hasDisability properties: id: type: string description: ID do candidato name: type: string description: Nome do candidato candidateType: type: string allOf: – #/definitions/candidateType description: Tipo do candidato gender: type: string allOf: – #/definitions/genderType description: Gênero do candidato age: type: integer format: int64 description: Idade localization: type: string description: Endereço hasDisability: type: boolean description: Possui deficiência? expectedSalary: type: number format: double description: Expectativa salarial photo: type: object allOf: – #/definitions/photoAttachmentDTO description: Foto photoAttachmentDTO: description: DTO com informações básicas do anexo de foto do candidato type: object required: – id – fileName – url properties: id: type: string description: ID do arquivo fileName: type: string description: Nome do arquivo url: type: string description: URL do arquivo candidateInformationDTO: description: DTO com informações complementares do candidato type: object required: – totalApplications – hasAttachments – hasAnnotations – hasIndications – hasMessages – hasRevokedAgreement – hasBlocked – hasComment – hasSelectionProcessInProgress – isRecentHire – isFormerEmployee properties: totalApplications: type: integer format: int64 description: Número total de aplicações do candidato hasAttachments: type: boolean description: Possui anexos? hasAnnotations: type: boolean description: Possui anotações? hasIndications: type: boolean description: Possui indicações? hasMessages: type: boolean description: Possui mensagens? hasRevokedAgreement: type: boolean description: Revogou o acordo? hasBlocked: type: boolean description: Esta bloqueado? hasComment: type: boolean description: Possui comentários? hasSelectionProcessInProgress: type: boolean description: Tem processo seletivo ativo? isRecentHire: type: boolean description: Indica se o candidato foi admitido recentemente (Últimos 90 dias) isFormerEmployee: type: boolean description: Indica se o candidato é ex-funcionário candidateAssessmentsDTO: description: DTO com as avaliações do candidato type: object required: – results properties: results: type: array items: type: object allOf: – #/definitions/assessmentResultDTO minimum: 1 description: Resultados assessmentResultDTO: description: DTO de resultado de assessment type: object required: – type – score properties: type: type: string description: ID do resultado score: type: string description: Resultado obtido permissionsDTO: description: DTO com as permissões do Usuário sobre os registros retornados type: object required: – actions – tests properties: actions: type: array items: type: string minimum: 1 description: tests: type: array items: type: object allOf: – #/definitions/testsDTO minimum: 1 description: testsDTO: description: DTO com os dados referentes aos testes type: object required: – type – name – sequence properties: type: type: string description: name: type: string description: sequence: type: integer format: int64 description: stageModelGroupDTO: description: DTO com informações do grupo de modelo de etapas type: object required: – id – name – isActive – isDefault properties: id: type: string description: ID do grupo de modelo de etapas name: type: string description: Nome do grupo description: type: string description: Descrição do grupo isActive: type: boolean description: Indica se está ativo isDefault: type: boolean description: Indica se é o grupo padrão defaultStageModelName: type: string description: Nome do modelo definido como padrão do grupo criteria: type: array items: type: object allOf: – #/definitions/stageModelGroupCriterionDTO description: Critérios do grupo de modelo de etapas stageModelSettings: type: array items: type: object allOf: – #/definitions/stageModelGroupStageModelSettingsDTO description: Configurações dos modelos de etapas do grupo createdBy: type: string description: Usuário que criou o grupo de modelo de etapas createdDate: type: string format: date-time description: Data de criação do grupo de modelo de etapas lastModifiedBy: type: string description: Usuário que atualizou o grupo de modelo de etapas pela última vez lastModifiedDate: type: string format: date-time description: Data da última atualização do grupo de modelo de etapas stageModelGroupStageModelSettingsDTO: description: DTO para configurações dos modelos do grupo type: object required: – id – settingsStageModel properties: id: type: string description: ID da configuração settingsStageModel: type: object allOf: – #/definitions/stageModelGroupSettingsStageModelDTO description: Modelo de etapas do grupo stageModelGroupSettingsStageModelDTO: description: DTO para modelo de etapas type: object required: – id – name – startDate – isReadOnly – isDefault – settingsStages properties: id: type: string description: ID do critério name: type: string description: Nome do modelo startDate: type: string format: date description: Data de início da vigência do modelo isReadOnly: type: boolean description: Indica se é somente leitura isDefault: type: boolean description: Indica se é o modelo padrão settingsStages: type: array items: type: object allOf: – #/definitions/stageModelGroupSettingsStagesDTO minimum: 1 description: Lista de etapas do modelo stageModelGroupSettingsStagesDTO: description: DTO para etapa do modelo type: object required: – id – name – sequence – typeStage – visibleToCandidate properties: id: type: string description: ID do critério name: type: string description: Nome da etapa sequence: type: integer format: int64 description: Ordem de exibição da etapa typeStage: type: string allOf: – #/definitions/stageType description: Tipo da etapa visibleToCandidate: type: boolean description: Indica se a etapa é visível para o candidato stageModelGroupCriterionDTO: description: DTO com informações de critério do grupo de modelo de etapas type: object required: – id – criterionType – criterionOperator – values properties: id: type: string description: ID do critério criterionType: type: string description: Tipo do critério criterionOperator: type: string description: Tipo operação do critério values: type: array items: type: object allOf: – #/definitions/stageModelGroupCriterionValueDTO minimum: 1 description: Valores do critério stageModelGroupCriterionValueDTO: description: DTO com informações de valor do critério do grupo de modelo de etapas type: object required: – valueType – value properties: valueType: type: string description: Tipo do valor do critério value: type: string description: Valor do critério stageModelGroupRequestDTO: description: DTO de requisição para consulta do grupo de modelo de etapas allOf: – #/definitions/pageableRequestDTO – type: object properties: id: type: string description: ID do grupo de modelo de etapas (opcional, para busca individual) searchText: type: string description: Texto para busca livre por nome do grupo de modelo de etapas (opcional, para busca paginada) stageModelGroupResponseDTO: description: DTO de resposta para consulta do grupo de modelo de etapas allOf: – #/definitions/pageableResponseDTO – type: object required: – contents properties: contents: type: array items: type: object allOf: – #/definitions/stageModelGroupDTO minimum: 1 description: Lista de grupos de modelo de etapas encontrados pageableRequestDTO: description: DTO de requisição com informações de paginação e ordenação para consultas paginadas discriminator: _discriminator type: object required: – _discriminator properties: page: type: integer format: int64 description: Número da página minimum: 0 default: 0 size: type: integer format: int64 description: Número de registros por página minimum: 1 maximum: 100 default: 10 displayFields: type: string description: Campos que devem ser incluídos na resposta (opcional, para otimização de payload) sortingField: type: string description: Campo para ordenação dos resultados _discriminator: type: string description: pageableResponseDTO: description: DTO de resposta com informações de paginação para consultas paginadas discriminator: _discriminator type: object required: – totalPages – totalElements – _discriminator properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de elementos _discriminator: type: string description: settingsStageModel: description: Modelo de etapas. type: object required: – name – startDate properties: id: type: string description: Identificador único. name: type: string maxLength: 255 description: Nome. startDate: type: string format: date description: Data de início. isReadOnly: type: boolean description: Somente leitura default: false isActive: type: boolean description: É o modelo ativo default: false isDefault: type: boolean description: Modelo padrão default: false isDefaultInGroup: type: boolean description: Modelo padrão para o grupo default: false settingsStages: type: array items: type: object allOf: – #/definitions/settingsStage description: Etapas. settingsStage: description: Etapa. type: object required: – name – sequence – typeStage properties: id: type: string description: Identificador único. name: type: string maxLength: 255 description: Nome sequence: type: integer format: int64 description: Sequência. typeStage: type: string allOf: – #/definitions/stageType description: Tipo de etapa. settingsStageModel: type: object allOf: – #/definitions/settingsStageModel description: Identificador do modelo de etapas. visibleToCandidate: type: boolean description: Etapa visível para o candidato default: false companyDTO: description: DTO para empresas type: object required: – id – externalId – code – name properties: id: type: string description: ID da empresa externalId: type: string description: ID externo da empresa code: type: integer format: int64 description: Código da empresa name: type: string description: Nome da empresa jobPositionDTO: description: DTO para cargos/funções type: object required: – id – code – name properties: id: type: string description: ID do cargo/função code: type: integer format: int64 description: Código do cargo/função name: type: string description: Nome do cargo/função 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 enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage