HCM – Careers Settings (careerssettings)

2.0info: 2.13.0 HCM – Careers Settings description: Foundation do HCM x-senior-domain: HCM x-senior-domain-path: hcm x-senior-service-path: careerssettings 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: /careerssettings/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 /careerssettings/queries/listEnableCountries: post: description: Listar todos os países homologados tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – countries properties: countries: type: array items: type: object allOf: – #/definitions/countryDTO minimum: 1 description: Lista de países homologados com as suas informações cadastradas default: description: Error response schema: #/definitions/genericError get: description: Listar todos os países homologados tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – countries properties: countries: type: array items: type: object allOf: – #/definitions/countryDTO minimum: 1 description: Lista de países homologados com as suas informações cadastradas default: description: Error response schema: #/definitions/genericError /careerssettings/queries/listUniquesDocumentsByCountry: post: description: Listar todos os documentos definidos como único para o país homologado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – countryAbbreviation properties: countryAbbreviation: type: string description: Abreviação do país homologado responses: 200: description: Ok schema: type: object required: – documents properties: documents: type: array items: type: object allOf: – #/definitions/documentUniqueByCountryDTO minimum: 1 description: Lista dos documentos únicos para o país homologado informado com as suas informações cadastradas default: description: Error response schema: #/definitions/genericError get: description: Listar todos os documentos definidos como único para o país homologado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: countryAbbreviation description: Abreviação do país homologado in: query required: true type: string responses: 200: description: Ok schema: type: object required: – documents properties: documents: type: array items: type: object allOf: – #/definitions/documentUniqueByCountryDTO minimum: 1 description: Lista dos documentos únicos para o país homologado informado com as suas informações cadastradas default: description: Error response schema: #/definitions/genericError /careerssettings/queries/listEnableLanguages: post: description: Listar todos os idiomas habilitados na plataforma tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – languages properties: languages: type: array items: type: object allOf: – #/definitions/languageDTO minimum: 1 description: default: description: Error response schema: #/definitions/genericError get: description: Listar todos os idiomas habilitados na plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – languages properties: languages: type: array items: type: object allOf: – #/definitions/languageDTO minimum: 1 description: default: description: Error response schema: #/definitions/genericError /careerssettings/queries/listGroupResumeByCountry: post: description: Lista os grupos do formulário por país tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – countryAbbreviation properties: countryAbbreviation: type: string description: Abreviação do país homologado responses: 200: description: Ok schema: type: object required: – forms properties: forms: type: array items: type: object allOf: – #/definitions/groupInformationFormDTO minimum: 1 description: Lista de grupos do formulário por país 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os grupos do formulário por país tags: – Queries x-senior-visibility: PRIVATE parameters: – name: countryAbbreviation description: Abreviação do país homologado in: query required: true type: string responses: 200: description: Ok schema: type: object required: – forms properties: forms: type: array items: type: object allOf: – #/definitions/groupInformationFormDTO minimum: 1 description: Lista de grupos do formulário por país 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careerssettings/queries/listFieldsByGroupResume: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – groupInformationFormId properties: groupInformationFormId: type: string description: Identificador do agrupador de dados countryAbbreviation: type: string description: Abreviação do país homologado default: BR locale: type: string description: Idioma default: pt-BR responses: 200: description: Ok schema: type: object required: – groupData properties: groupData: type: object allOf: – #/definitions/dataGroupingDTO description: Grupo de campos do formulário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: groupInformationFormId description: Identificador do agrupador de dados in: query required: true type: string – name: countryAbbreviation description: Abreviação do país homologado in: query type: string – name: locale description: Idioma in: query type: string responses: 200: description: Ok schema: type: object required: – groupData properties: groupData: type: object allOf: – #/definitions/dataGroupingDTO description: Grupo de campos do formulário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careerssettings/queries/listFieldsCanRequiredByCompany: post: description: Lista os campos que podem ser solicitados pela empresa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: countryAbbreviation: type: string description: Abreviação do país homologado default: BR locale: type: string description: Idioma default: pt-BR responses: 200: description: Ok schema: type: object required: – information properties: information: type: object allOf: – #/definitions/settingsInformationDTO description: Lista de grupos (group_information_form) 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os campos que podem ser solicitados pela empresa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: countryAbbreviation description: Abreviação do país homologado in: query type: string – name: locale description: Idioma in: query type: string responses: 200: description: Ok schema: type: object required: – information properties: information: type: object allOf: – #/definitions/settingsInformationDTO description: Lista de grupos (group_information_form) 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careerssettings/queries/listProfileHighlights: post: description: Lista dos itens destacaveis do perfil do candidato tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – countryAbbreviation properties: countryAbbreviation: type: string description: Abreviação do país para pesquisa responses: 200: description: Ok schema: type: object required: – data properties: data: type: array items: type: object allOf: – #/definitions/profileHighlightDTO minimum: 1 description: Lista com os itens destacaveis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista dos itens destacaveis do perfil do candidato tags: – Queries x-senior-visibility: PRIVATE parameters: – name: countryAbbreviation description: Abreviação do país para pesquisa in: query required: true type: string responses: 200: description: Ok schema: type: object required: – data properties: data: type: array items: type: object allOf: – #/definitions/profileHighlightDTO minimum: 1 description: Lista com os itens destacaveis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careerssettings/queries/getFieldsByType: post: description: Lista dos itens destacaveis do perfil do candidato tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – countryAbbreviation – typeField properties: countryAbbreviation: type: string description: Abreviação do país para pesquisa typeField: type: string allOf: – #/definitions/typeField description: Tipo de Campo responses: 200: description: Ok schema: type: object required: – groupData properties: groupData: type: array items: type: object allOf: – #/definitions/dataGroupingDTO minimum: 1 description: Grupo de campos do formulário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careerssettings/queries/listFormConfigurationByProvider: post: description: Dados de parsing do linkedin tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – provider properties: provider: type: string description: Plataforma de onde virão os metadados countryAbbreviation: type: string description: Abreviação do país para pesquisa default: BR locale: type: string description: Idioma default: pt-BR responses: 200: description: Ok schema: type: object required: – groupData properties: groupData: type: array items: type: object allOf: – #/definitions/groupConfigurationByProviderDTO minimum: 1 description: Grupo de campos do formulário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Dados de parsing do linkedin tags: – Queries x-senior-visibility: PRIVATE parameters: – name: provider description: Plataforma de onde virão os metadados in: query required: true type: string – name: countryAbbreviation description: Abreviação do país para pesquisa in: query type: string – name: locale description: Idioma in: query type: string responses: 200: description: Ok schema: type: object required: – groupData properties: groupData: type: array items: type: object allOf: – #/definitions/groupConfigurationByProviderDTO minimum: 1 description: Grupo de campos do formulário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /careerssettings/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 /careerssettings/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/genericErrordefinitions: healthcheckDTO: description: Status do healthcheck type: string enum: – UP – DOWN typeField: description: Tipo de campo type: string enum: – TEXT – DATE – NUMBER – ATTACHMENT – LOCALE – LINK – LIST – BOOLEAN typeSearchLocale: description: Tipo de localizador de localização type: string enum: – CITY – COUNTRY – PROVINCE – POSTAL_CODE recordType: description: Tipo de registro type: string enum: – FLEX – MONO – MULTI validationRule: description: Regra de validação de campos type: string enum: – GREATER_THAN – GREATER_THAN_OR_EQUAL_TO – LESS_THAN – LESS_THAN_OR_EQUAL_TO – EQUAL_TO – NOT_EQUAL_TO 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 countryDTO: description: Informações cadastrais do país type: object required: – name – abbreviation – ddi – currencyCode – phoneNumberMask – documents – preferredLanguage – translations properties: id: type: string description: Id identificador do país name: type: string description: Nome do país abbreviation: type: string description: Abreviação do país ddi: type: integer format: int64 description: Código de telefonia internacional currencyCode: type: string description: Código de moeda phoneNumberMask: type: string description: Máscara para o número telefônico documents: type: array items: type: object allOf: – #/definitions/documentUniqueByCountryDTO minimum: 1 description: Documentos únicos preferredLanguage: type: string description: Idioma oficial/principal translations: type: array items: type: object allOf: – #/definitions/translationDTO minimum: 1 description: Lista que conterá as translations do país documentUniqueByCountryDTO: description: type: object required: – name – mask – justificationTranslations – validatorAlgorithms properties: name: type: string description: Nome do campo do documento mask: type: string description: Máscara do campo do documento justificationTranslations: type: array items: type: object allOf: – #/definitions/translationDTO minimum: 1 description: Lista que conterá as translations da justificativa do documento validatorAlgorithms: type: array items: type: object allOf: – #/definitions/validatorAlgorithmDTO minimum: 1 description: Lista que conterá os algoritmos responsáveis por fazer a validação do documento translationDTO: description: type: object required: – locale – value properties: locale: type: string description: Pré-definição de variante do idioma value: type: string description: Valor traduzido da propriedade de acordo à pré-definição da variante do idioma validatorAlgorithmDTO: description: type: object required: – algorithm – errorMessageTranslations properties: algorithm: type: string description: Algoritmo utilizado para a validação do documento errorMessageTranslations: type: array items: type: object allOf: – #/definitions/translationDTO minimum: 1 description: Lista que conterá as translations das mensagens de erro validatorAlgorithmTranslatedDTO: description: type: object required: – algorithm – errorMessage properties: algorithm: type: string description: Algoritmo utilizado para a validação do documento errorMessage: type: string description: Mensagem de erro languageDTO: description: type: object required: – locale – translations properties: id: type: string description: Id identificador do idioma locale: type: string description: Pré-definição da variante do idioma translations: type: array items: type: object allOf: – #/definitions/translationDTO minimum: 1 description: Lista que conterá as translations dos idiomas groupInformationFormDTO: description: discriminator: _discriminator type: object required: – id – name – maxRecordLimit – recordType – enable – sequence – translatedDescription – translatedNote – translatedHint – _discriminator properties: id: type: string description: Id identificador do grupo do formulário name: type: string description: Nome do grupo do formulário maxRecordLimit: type: integer format: int64 description: Limite máximo de registros recordType: type: string allOf: – #/definitions/recordType description: Tipo de registro: informa qual componente será usado no front-end enable: type: boolean description: Habilitado por padrão? sequence: type: integer format: int64 description: Sequência translatedDescription: type: array items: type: object allOf: – #/definitions/translatedGroupDescriptionDTO minimum: 1 description: Lista com as traduções pertinentes ao grupo do formulário translatedNote: type: array items: type: object allOf: – #/definitions/translatedGroupNoteDTO minimum: 1 description: Lista com as traduções das observações translatedHint: type: array items: type: object allOf: – #/definitions/translatedGroupHintDTO minimum: 1 description: hint options: type: string format: byte description: JSON Options _discriminator: type: string description: translatedGroupNoteDTO: description: type: object required: – locale – value properties: locale: type: string description: Pré-definição de variante do idioma value: type: string description: observações translatedGroupHintDTO: description: type: object required: – locale – value properties: locale: type: string description: Pré-definição de variante do idioma value: type: string description: hint translatedGroupDescriptionDTO: description: type: object required: – locale – value properties: locale: type: string description: Pré-definição de variante do idioma value: type: string description: Nome do agrupador no idioma específico dataGroupingDTO: description: type: object required: – name – groupingFields properties: name: type: string description: Nome do grupo macro da tabela groupInformationForm groupingFields: type: array items: type: object allOf: – #/definitions/groupedFieldsFormDTO minimum: 1 description: Agrupador de fields groupedFieldsFormDTO: description: type: object required: – id – fieldGroupingName – tag – fieldsValidatorPolicies – fieldFormEnabler – note – fields properties: id: type: string description: Identificador único do subgrupo fieldGroupingName: type: string description: Nome do agrupamento de campos no idioma pré-definido tag: type: string description: Identificador do registro fieldsValidatorPolicies: type: array items: type: object allOf: – #/definitions/fieldsValidatorPoliciesDTO minimum: 1 description: Políticas de validação de campos options: type: string format: byte description: JSON Options fieldFormEnabler: type: array items: type: object allOf: – #/definitions/criteriaFieldFormEnablerDTO minimum: 1 description: Habilitador do campo note: type: string description: Anotação do agrupamento no idioma de contexto learnMore: type: string description: Conteúdo textual sobre saiba mais do grupo de dados fields: type: array items: type: object allOf: – #/definitions/fieldFormDetailsDTO minimum: 1 description: Campos do formulário com suas respectivas informações fieldsValidatorPoliciesDTO: description: type: object required: – id – firstFieldId – validationRule – lastFieldId properties: id: type: string description: Identificador único do objeto firstFieldId: type: string description: Id do primeiro campo para validação validationRule: type: string allOf: – #/definitions/validationRule description: regra de validação lastFieldId: type: string description: Id do segundo campo para validação fieldFormDetailsDTO: description: type: object required: – id – sequence – name – typeField – length – sensibleData – mask – placeholder – possibleValuesList – enable – canRequiredByCompany – justification – hint – notes – fieldsToDisable – validatorAlgorithms properties: id: type: string description: Identificador único do campo sequence: type: integer format: int64 description: Sequência name: type: string description: Nome do Campo typeField: type: string allOf: – #/definitions/typeField description: Tipo de Campo length: type: integer format: int64 description: Tamanho máximo do campo sensibleData: type: boolean description: Define se a informação se enquadra na LGPD como dado sensível mask: type: string description: Máscara a ser utilizada para o tipo de informação placeholder: type: string description: Texto a ser apresentado na tela como dica de preenchimento para o candidato possibleValuesList: type: array items: type: object allOf: – #/definitions/itemValueGroupInformationByCountryDTO minimum: 1 description: Valores possíveis para campos do tipo Lista enable: type: boolean description: Habilitado por padrão canRequiredByCompany: type: boolean description: Pode ser solicitado pela empresa justification: type: object allOf: – #/definitions/justificationDTO description: Justificativa coleta de dados options: type: string format: byte description: JSON Options hint: type: string description: Hint do campo do formulário traduzido com o idioma de contexto notes: type: string description: Anotação adicionada ao campo de acordo ao idioma de contexto fieldsToDisable: type: array items: type: object allOf: – #/definitions/fieldsToDisableDTO minimum: 1 description: Desabilidador do campo validatorAlgorithms: type: array items: type: object allOf: – #/definitions/validatorAlgorithmTranslatedDTO minimum: 1 description: Lista que conterá os algoritmos responsáveis por fazer a validação do documento itemValueGroupInformationByCountryDTO: description: type: object required: – itemValue – defaultValue – sequence – itemHint – itemDescription properties: itemValue: type: string description: Item da lista de valores possíveis para o campo defaultValue: type: boolean description: Indica se o item é a opção padrão da lista sequence: type: integer format: int64 description: Sequência de apresentação em tela options: type: string format: byte description: JSON Options itemHint: type: string description: Nome do item no idioma de contexto itemDescription: type: string description: Descrição do item no idioma de contexto justificationDTO: description: type: object required: – enable – value properties: enable: type: boolean description: Indica se a justificativa da coleta dos dados está habilitada value: type: string description: Indica a descrição da justificação a partir do idioma de contexto criteriaFieldFormEnablerDTO: description: type: object required: – itemGroupInformationEnablerId – fieldFormEnablerId – valueEnabler properties: itemGroupInformationEnablerId: type: string description: Gupo que controla a habilitação deste campo fieldFormEnablerId: type: string description: Campo que controla a habilitação deste campo valueEnabler: type: string description: Valor informado no campo controlador que habilita este campo fieldsToDisableDTO: description: type: object required: – value – fields properties: value: type: string description: Campo que controla a desabilitação deste campo fields: type: array items: type: string minimum: 1 description: Valor informado no campo controlador que desabilita este campo settingsGroupDTO: description: Grupo (registro na tabela group_information_form) type: object required: – id – name – subgroups properties: id: type: string description: identificador único do grupo name: type: string description: nome do grupo, no idioma pré-definido subgroups: type: array items: type: object allOf: – #/definitions/settingsSubgroupDTO minimum: 1 description: Lista de subgrupos (field_form_grouping) settingsSubgroupDTO: description: Subgrupo (registro na tabela field_form_grouping) type: object required: – id – name – fields properties: id: type: string description: identificador único do subgrupo name: type: string description: nome do subgrupo, no idioma pré-definido fields: type: array items: type: object allOf: – #/definitions/settingsFieldDTO minimum: 1 description: Lista de campos (field_form) settingsFieldDTO: description: Campo (registro na tabela field_form) type: object required: – id – name properties: id: type: string description: identificador único do campo name: type: string description: nome do campo, no idioma pré-definido settingsInformationDTO: description: Estrutura de grupos subgrupos campos type: object required: – groups properties: groups: type: array items: type: object allOf: – #/definitions/settingsGroupDTO minimum: 1 description: Lista de grupos profileHighlightDTO: description: type: object required: – group – subgroup – fields – category properties: group: type: string description: subgroup: type: string description: fields: type: array items: type: string minimum: 1 description: category: type: string description: groupConfigurationByProviderDTO: description: allOf: – #/definitions/groupInformationFormDTO – type: object required: – subgroups properties: subgroups: type: array items: type: object allOf: – #/definitions/groupedFieldsFormDTO minimum: 1 description: 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