2.0info: 3.3.0 HCM – Careers Candidature description: HCM – Careers Candidature x-senior-domain: HCM x-senior-domain-path: hcm x-senior-service-path: careerscandidature 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: /careerscandidature/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/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: HealthCheck Plataforma 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 /careerscandidature/queries/getCandidature: post: description: Realiza a consulta de uma candidatura tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idCandidature properties: idCandidature: type: string description: Identificador de candidatura responses: 200: description: Ok schema: type: object required: – candidature properties: candidature: type: object allOf: – #/definitions/getCandidatureDTO description: Informações persistidas da candidatura, vaga e perfil relacionados a candidatura 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Realiza a consulta de uma candidatura tags: – Queries x-senior-visibility: PRIVATE parameters: – name: idCandidature description: Identificador de candidatura in: query required: true type: string responses: 200: description: Ok schema: type: object required: – candidature properties: candidature: type: object allOf: – #/definitions/getCandidatureDTO description: Informações persistidas da candidatura, vaga e perfil relacionados a candidatura 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careerscandidature/queries/getVacancy: post: description: Busca informações da vaga e do anunciante da vaga tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – code properties: code: type: string description: Código da vaga no GRS responses: 200: description: Ok schema: type: object required: – vacancy properties: vacancy: type: object allOf: – #/definitions/getVacancyDTO description: Informações da vaga e perfil da empresa anunciante 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca informações da vaga e do anunciante da vaga tags: – Queries x-senior-visibility: PRIVATE parameters: – name: code description: Código da vaga no GRS in: query required: true type: string responses: 200: description: Ok schema: type: object required: – vacancy properties: vacancy: type: object allOf: – #/definitions/getVacancyDTO description: Informações da vaga e perfil da empresa anunciante 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careerscandidature/queries/getProfileByCode: post: description: Busca informações de um perfil de empresa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – code properties: code: type: string description: Código do perfil da empresa responses: 200: description: Ok schema: type: object required: – profile properties: profile: type: object allOf: – #/definitions/profileDTO description: Informações do perfil da empresa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca informações de um perfil de empresa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: code description: Código do perfil da empresa in: query required: true type: string responses: 200: description: Ok schema: type: object required: – profile properties: profile: type: object allOf: – #/definitions/profileDTO description: Informações do perfil da empresa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careerscandidature/queries/getCandidatureByVacancyAndCandidate: post: description: Realiza a consulta da candidatura de um candidato em uma vaga tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idCandidate – code properties: idCandidate: type: string description: Identificador do candidato code: type: string description: Identificador da vaga responses: 200: description: Ok schema: type: object required: – candidature properties: candidature: type: object allOf: – #/definitions/getCandidatureDTO description: Informações persistidas da candidatura 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Realiza a consulta da candidatura de um candidato em uma vaga tags: – Queries x-senior-visibility: PRIVATE parameters: – name: idCandidate description: Identificador do candidato in: query required: true type: string – name: code description: Identificador da vaga in: query required: true type: string responses: 200: description: Ok schema: type: object required: – candidature properties: candidature: type: object allOf: – #/definitions/getCandidatureDTO description: Informações persistidas da candidatura 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careerscandidature/queries/getCandidatures: post: description: Busca lista de candidaturas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idCandidate properties: idCandidate: type: string description: Identificador do candidato page: type: integer format: int64 description: Número da página minimum: 0 default: 0 size: type: integer format: int64 description: Tamanho da página minimum: 1 maximum: 200 default: 10 responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Quantidade de páginas totalElements: type: integer format: int64 description: Quantidade de elementos contents: type: array items: type: object allOf: – #/definitions/candidatureListItemDTO minimum: 1 description: Dados da candidatura 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca lista de candidaturas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: idCandidate description: Identificador do candidato in: query required: true type: string – name: page description: Número da página in: query type: integer format: int64 – name: size description: Tamanho da página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Quantidade de páginas totalElements: type: integer format: int64 description: Quantidade de elementos contents: type: array items: type: object allOf: – #/definitions/candidatureListItemDTO minimum: 1 description: Dados da candidatura 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careerscandidature/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 /careerscandidature/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 /careerscandidature/actions/migrateSchema: post: description: Realiza a migração do schema do banco de dados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careerscandidature/actions/createProfile: post: description: Realiza a criação do perfil da empresa tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – profile properties: profile: type: object allOf: – #/definitions/createProfileDTO description: Informações do perfil da empresa que serão persistidos responses: 200: description: Ok schema: type: object required: – profile properties: profile: type: object allOf: – #/definitions/profileDTO description: Informações persistidas do perfil da empresa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careerscandidature/actions/createVacancy: post: description: Realiza a criação da vaga tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – vacancy properties: vacancy: type: object allOf: – #/definitions/createVacancyDTO description: Informações da vaga para serem persistidos responses: 200: description: Ok schema: type: object required: – vacancy properties: vacancy: type: object allOf: – #/definitions/vacancyDTO description: Informações persistidas da vaga 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careerscandidature/actions/createCandidature: post: description: Realiza a criação da candidatura tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – candidature properties: candidature: type: object allOf: – #/definitions/createCandidatureDTO description: Informações da candidatura que serão persistidas responses: 200: description: Ok schema: type: object required: – candidature properties: candidature: type: object allOf: – #/definitions/candidatureDTO description: Informações persistidas da candidatura 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careerscandidature/actions/updateVacancy: post: description: Atualizar dados da vaga tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – vacancy properties: vacancy: type: object allOf: – #/definitions/updateVacancyDTO description: Informações da vaga que será atualizada responses: 200: description: Ok schema: type: object required: – vacancy properties: vacancy: type: object allOf: – #/definitions/vacancyDTO description: Dados da vaga atualizados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careerscandidature/actions/updateProfile: post: description: Atualizar perfil tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – profile properties: profile: type: object allOf: – #/definitions/profileDTO description: Informações do perfil que será atualizado responses: 200: description: Ok schema: type: object required: – profile properties: profile: type: object allOf: – #/definitions/profileDTO description: Dados do perfil atualizado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careerscandidature/actions/deleteCandidatures: post: description: Remove todas as candidaturas de um candidadto tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idCandidate properties: idCandidate: type: string description: Identificador do candidato responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: healthcheckDTO: description: Status do healthcheck type: string enum: – UP – DOWN status: description: Status da vaga type: string enum: – IN_PROGRESS – CANCELED – CONCLUDED – SUSPENDED 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/healthcheckDTO description: Status createProfileDTO: description: DTO da primitiva createProfile type: object required: – code – company – location – tenant – identificationType – identificationNumber properties: code: type: string description: Código do perfil da empresa no elastic company: type: string description: Company location: type: string description: Localização picture: type: string description: Hash dos dados da imagem de perfil pictureUrl: type: string description: URL da imagem de perfil no Amazon S3 tenant: type: string description: Tenant identificationType: type: string description: Tipo de identificação identificationNumber: type: string description: Número de identificação profileDTO: description: DTO do perfil da empresa type: object required: – id – code – company – location – tenant – identificationType – identificationNumber properties: id: type: string description: Id code: type: string description: Código do perfil da empresa no elastic company: type: string description: Company location: type: string description: Localização picture: type: string description: Hash dos dados da imagem de perfil pictureUrl: type: string description: URL da imagem de perfil no Amazon S3 tenant: type: string description: Tenant identificationType: type: string description: Tipo de identificação identificationNumber: type: string description: Número de identificação createVacancyDTO: description: DTO da primitiva createVacancy type: object required: – idProfile – code – jobCode – title – status properties: idProfile: type: string description: Identificador do perfil da empresa code: type: string description: Código da vaga no GRS jobCode: type: integer format: int64 description: Código da vaga (numérico) no GRS type: string description: Título da vaga status: type: string allOf: – #/definitions/status description: Status da vaga updateVacancyDTO: description: DTO da primitiva updateVacancy type: object required: – id – jobCode – title properties: id: type: string description: ID da vaga jobCode: type: string description: Código da vaga type: string description: Título da vaga status: type: string description: Status da vaga vacancyDTO: description: DTO da vaga type: object required: – id – idProfile – code – jobCode – title – status properties: id: type: string description: Identificador da vaga idProfile: type: string description: Identificador do perfil da empresa code: type: string description: Código da vaga no GRS jobCode: type: integer format: int64 description: Código da vaga (numérico) no GRS type: string description: Título da vaga status: type: string allOf: – #/definitions/status description: Status da vaga createCandidatureDTO: description: DTO da primitiva createCandidature type: object required: – idCandidate – idVacancy properties: idCandidate: type: string description: Identificador do candidato idVacancy: type: string description: Identificador da Vaga idQuestionnaire: type: string description: Identificador do questionário resume: type: string description: Currículo candidatureDTO: description: DTO da primitiva createCandidature type: object required: – id – idCandidate – idVacancy – idQuestionnaire – dateCandidature – resume properties: id: type: string description: Identificador da candidatura idCandidate: type: string description: Identificador do candidato idVacancy: type: string description: Identificador da Vaga idQuestionnaire: type: string description: Identificador do questionário dateCandidature: type: string format: date description: Data da candidatura resume: type: string description: Currículo getCandidatureDTO: description: DTO contendo informações da candidatura, vaga e perfil relacionados a candidatura type: object required: – id – idCandidate – idQuestionnaire – dateCandidature – resume – vacancy properties: id: type: string description: Identificador da candidatura idCandidate: type: string description: Identificador do candidato idQuestionnaire: type: string description: Identificador do questionário dateCandidature: type: string format: date description: Data da candidatura resume: type: string description: Currículo vacancy: type: object allOf: – #/definitions/getVacancyDTO description: Dados da vaga getVacancyDTO: description: Informações da vaga e perfil da empresa anunciante type: object required: – id – profile – code – jobCode – title – status properties: id: type: string description: Identificador da vaga profile: type: object allOf: – #/definitions/profileDTO description: Dados do perfil da empresa code: type: string description: Código da vaga no GRS jobCode: type: integer format: int64 description: Código da vaga (numérico) no GRS type: string description: Título da vaga status: type: string allOf: – #/definitions/status description: Status da vaga candidatureListItemDTO: description: DTO para armazenar dados da candidatura type: object required: – id – idCandidate – dateCandidature – idQuestionnaire – resume – vacancy properties: id: type: string description: Identificador da candidatura idCandidate: type: string description: Identificador do candidato dateCandidature: type: string format: date description: Data de realização da candidatura idQuestionnaire: type: string description: Identificador do questionário resume: type: string description: Hash do Currículo vacancy: type: object allOf: – #/definitions/vacancyListItemDTO description: Informações da vaga vacancyListItemDTO: description: DTO para armazenar dados da vaga type: object required: – id – code – jobCode – title – status – profile properties: id: type: string description: Identificador da vaga code: type: string description: Identificador da vaga no GRS jobCode: type: integer format: int64 description: Código da vaga no GRS type: string description: Título da vaga status: type: string allOf: – #/definitions/status description: Status da vaga profile: type: object allOf: – #/definitions/profileListItemDTO description: Infomações de perfil profileListItemDTO: description: DTO para armazenar dados do perfil da empresa type: object required: – id – company – location – tenant – identificationType – identificationNumber properties: id: type: string description: Identificador do perfil company: type: string description: Noma da empresa location: type: string description: Localização picture: type: string description: Hash da imagem pictureUrl: type: string description: URL da imagem de perfil no Amazon S3 tenant: type: string description: Tenant identificationType: type: string description: Tipo de identificação identificationNumber: type: string description: Número de identificaçã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 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