digitalhiringrecruiter

2.0info: 0.1.2 digitalhiringrecruiter description: Serviço BFF (backend for frontend) responsável por centralizar as requisições da visão do RH (onboarding-frontend) e direcionar para os serviços de backend x-senior-domain: hcm x-senior-domain-path: hcm x-senior-service-path: digitalhiringrecruiter 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: /digitalhiringrecruiter/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 /digitalhiringrecruiter/queries/inviteModelElectronicSignatureQuery: post: description: Retorna a assinatura eletrônica tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: inviteModelId: type: string description: Código do modelo de convite, caso convite já existente. includePlatformUsers: type: boolean description: Informa se deve buscar os usuários de User ou só os já configurados. default: true size: type: integer format: int64 description: Parâmetro de paginação default: 10 page: type: integer format: int64 description: Parâmetro de paginação default: 0 responses: 200: description: Ok schema: type: object properties: configuration: type: object allOf: – #/definitions/inviteModelElectronicSignatureConfigurationData description: Configuração para assinatura eletrônica no modelo de convite internalSigners: type: array items: type: object allOf: – #/definitions/inviteModelElectronicSignatureInternalSignerData description: Assinantes internos para configuração no modelo de convite externalSigners: type: array items: type: object allOf: – #/definitions/inviteModelElectronicSignatureExternalSignerData description: Assinantes externos para configuração no modelo de convite totalElements: type: integer format: int64 description: Total de registros encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a assinatura eletrônica tags: – Queries x-senior-visibility: PRIVATE parameters: – name: inviteModelId description: Código do modelo de convite, caso convite já existente. in: query type: string – name: includePlatformUsers description: Informa se deve buscar os usuários de User ou só os já configurados. in: query type: boolean – name: size description: Parâmetro de paginação in: query type: integer format: int64 – name: page description: Parâmetro de paginação in: query type: integer format: int64 responses: 200: description: Ok schema: type: object properties: configuration: type: object allOf: – #/definitions/inviteModelElectronicSignatureConfigurationData description: Configuração para assinatura eletrônica no modelo de convite internalSigners: type: array items: type: object allOf: – #/definitions/inviteModelElectronicSignatureInternalSignerData description: Assinantes internos para configuração no modelo de convite externalSigners: type: array items: type: object allOf: – #/definitions/inviteModelElectronicSignatureExternalSignerData description: Assinantes externos para configuração no modelo de convite totalElements: type: integer format: int64 description: Total de registros encontrados. totalPages: type: integer format: int64 description: Total de páginas encontradas. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digitalhiringrecruiter/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 /digitalhiringrecruiter/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: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Saudável * `DOWN` – Ruim 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 enumInformationItemData: description: DTO de lista com os items das enumerações. type: object required: – key – value properties: key: type: string description: Chave do item da enumeração. value: type: string description: Valor traduzido do item da enumeração. electronicSignatureConfigurationData: description: Dados de configuração da assinatura eletrônica discriminator: _discriminator type: object required: – _discriminator properties: id: type: string description: Identificador único do registro. demandGeolocalization: type: boolean description: Exige geolocalização instructionsToSigner: type: string description: Instruções para os assinantes _discriminator: type: string description: inviteModelElectronicSignatureConfigurationData: description: Dados de configuração do modelo de convite com assinatura eletrônica allOf: – #/definitions/electronicSignatureConfigurationData – type: object properties: modelId: type: string description: Id do modelo de convite electronicSignatureSignerNotificationMethodData: description: Dados de configuração do método de notificação do assinante discriminator: _discriminator type: object required: – _discriminator properties: id: type: string description: Identificador único do registro. method: type: object allOf: – #/definitions/enumInformationItemData description: Método de notificação do assinante _discriminator: type: string description: inviteModelElectronicSignatureSignerNotificationMethodData: description: Dados de configuração do modelo de convite com assinatura eletrônica e método de notificação do assinante allOf: – #/definitions/electronicSignatureSignerNotificationMethodData – type: object properties: inviteModelSigner: type: string description: Id do assinante no modelo de convite electronicSignatureInternalSignerData: description: Dados de assinante da assinatura eletrônica interno discriminator: _discriminator type: object required: – _discriminator properties: id: type: string description: Identificador único do registro mustSend: type: boolean description: Informa se o usuário está marcado para envio no modelo de convite basicUserId: type: string description: Identificador do usuário no serviço User signerName: type: string description: Nome do usuário externo signerEmail: type: string description: E-mail do usuário externo signerPhone: type: string description: Telefone do usuário externo _discriminator: type: string description: inviteModelElectronicSignatureInternalSignerData: description: Dados de configuração do modelo de convite com assinatura eletrônica e método de notificação do assinante allOf: – #/definitions/electronicSignatureInternalSignerData – type: object properties: modelId: type: string description: Id do modelo de convite notificationMethods: type: array items: type: object allOf: – #/definitions/inviteModelElectronicSignatureSignerNotificationMethodData description: Formas de notificação do signatário electronicSignatureExternalSignerData: description: Dados de assinante da assinatura eletrônica externo discriminator: _discriminator type: object required: – _discriminator properties: id: type: string description: Identificador único do registro signerName: type: string description: Nome do usuário externo signerEmail: type: string description: E-mail do usuário externo signerPhone: type: string description: Telefone do usuário externo _discriminator: type: string description: inviteModelElectronicSignatureExternalSignerData: description: Dados de configuração do modelo de convite com assinatura eletrônica externo e método de notificação do assinante externo allOf: – #/definitions/electronicSignatureExternalSignerData – type: object properties: modelId: type: string description: Id do modelo de convite notificationMethods: type: array items: type: object allOf: – #/definitions/inviteModelElectronicSignatureSignerNotificationMethodData description: Formas de notificação do signatário 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