2.0info: 1.0.1 Admissão Digital Processador assíncrono description: Processador assincrono de rotinas complexas do módulo Admissão Digital x-senior-domain: hcm x-senior-domain-path: hcm x-senior-service-path: digitalhiringprocessor 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: /digitalhiringprocessor/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 /digitalhiringprocessor/queries/getAllAttachmentsFilesFromPreAdmissionId: post: description: Busca todos os anexos (arquivos) de uma pré admissão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – preAdmissionId properties: preAdmissionId: type: string description: Identificador único da pré-admissão responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/keyValueDTO minimum: 1 description: Lista com todos as URLS e nomes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca todos os anexos (arquivos) de uma pré admissão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: preAdmissionId description: Identificador único da pré-admissão in: query required: true type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/keyValueDTO minimum: 1 description: Lista com todos as URLS e nomes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /digitalhiringprocessor/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 /digitalhiringprocessor/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 /digitalhiringprocessor/signals/generatePdfGroupingAllAttachments: post: description: Baixa todos os arquivos de uma pré admissão em um único arquivo PDF para download tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – preAdmissionId properties: preAdmissionId: type: string description: Identificador único da pré-admissão responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /digitalhiringprocessor/signals/generateZipGroupingAllAttachments: post: description: Baixa todos os arquivos de uma pré admissão em um único arquivo ZIP para download tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – preAdmissionId properties: preAdmissionId: type: string description: Identificador único da pré-admissão responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /digitalhiringprocessor/signals/deleteInviteModelElectronicSignatureSigners: post: description: Deleta todos os registros associado aos assinantes informados tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – signers properties: signers: type: array items: type: string minimum: 1 description: Lista com os basic_ids dos assinantes responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /digitalhiringprocessor/signals/deleteInviteModelElectronicSignatureSignerNotificationMethodsFromSigners: post: description: Deleta todos os metodo de notificação passados , que estão associados aos assinantes informados tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – signers – methods properties: signers: type: array items: type: string minimum: 1 description: Lista com os basic_ids dos assinantes methods: type: array items: type: string allOf: – #/definitions/electronicSignatureSignerNotificationMethod minimum: 1 description: Lista com os métodos de notificação a serem removidos responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /digitalhiringprocessor/signals/documentConvert: post: description: Conversão de documentos para assinatura eletrônica tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – contractId – preAdmissionId – document properties: contractId: type: string description: Id do contrato preAdmissionId: type: string description: Id da pré-admissão document: type: string description: HTML do documento a ser convertido (o HTML não será obtido a partir do contrato pois o usuário pode editar em tela) responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /digitalhiringprocessor/signals/documentsSend: post: description: Envio de documentos para assinatura eletrônica tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – configuration – contracts – signers – preAdmissionId properties: configuration: type: object allOf: – #/definitions/electronicSignatureConfiguration description: Configuração para assinatura eletrônica contracts: type: array items: type: object allOf: – #/definitions/electronicSignatureContract minimum: 1 description: Documentos a serem enviados para assinatura eletrônica signers: type: array items: type: object allOf: – #/definitions/electronicSignatureSigner minimum: 1 description: Signatários dos documentos preAdmissionId: type: string description: Id da pré-admissão 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 electronicSignatureSignerNotificationMethod: type: string enum: – EMAIL – SMS – WPP – PLATFORM electronicSignatureSignerType: type: string enum: – INTERNAL – EXTERNAL – ADDITIONAL description: Tipo do assinante para assinatura eletrônica: * `INTERNAL` – Interno * `EXTERNAL` – Externo * `ADDITIONAL` – Adicional electronicSignatureNotificationMethod: type: string enum: – EMAIL – SMS – WPP – PLATFORM description: Forma de notificação do assinante para assinatura eletrônica: * `EMAIL` – E-mail * `SMS` – SMS * `WPP` – WhatsApp * `PLATFORM` – Plataforma 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 keyValueDTO: description: Estrutura genérica para retorno de chave-valor type: object required: – key – value properties: key: type: string description: Chave do par chave-valor value: type: string description: Valor do par chave-valor name: type: string description: Uma nomenclatura para o par electronicSignatureConfiguration: description: Configuração para assinatura eletrônica type: object required: – demandGeolocation – instructionsToSigner properties: demandGeolocation: type: boolean description: Obriga geolocalização do assinante instructionsToSigner: type: string description: Instruções para os assinantes electronicSignatureContract: description: Contrato para assinatura type: object required: – modelName – fileName – gedDocumentURI properties: modelName: type: string maxLength: 255 description: Nome do modelo de contrato fileName: type: string maxLength: 255 description: Nome do arquivo do contrato que foi feito upload no GED gedDocumentURI: type: string description: URI de upload do arquivo no GED electronicSignatureSigner: description: Assinante para assinatura eletrônica type: object required: – type – notificationMethods properties: id: type: string description: Identificador único do registro basicUserId: type: string description: Identificador do usuário no serviço User signerName: type: string maxLength: 255 description: Nome do usuário signerEmail: type: string maxLength: 255 description: E-mail do usuário signerPhone: type: string maxLength: 20 description: Celular do usuário type: type: string allOf: – #/definitions/electronicSignatureSignerType description: Tipo do usuário notificationMethods: type: array items: type: string allOf: – #/definitions/electronicSignatureNotificationMethod minimum: 1 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