2.0info: 1.12.0 HCM – Integrador dos dados do Foundation com os demais módulos de gestão description: Esse serviço atua como um conversor, ou normalizador, de dados entre os projetos de origem (Foundation) e destino (hcm-backend).\nOs eventos de replicação da origem, que possuem modelagem própria, são convertidos para a modelagem do serviço destino e salvos diretamente no banco de dados do mesmo, emitindo os mesmos eventos de alteração que o sistema destino emite.\nPor emitir os mesmos eventos, os demais serviços inscritos nos eventos do serviço destino não necessitam de nenhuma alteração para manter suas integrações já existentes.\nFluxo principal:\nServiço origem emite eventos de replicação – hcm-foundation-integration-backend – Alteração no banco de dados do serviço destino – Disparo dos eventos do sistema destino\nCaso ocorra uma exceção na execução do fluxo este serviço tenta executá-lo novamente pela quantidade máxima de vezes definida por propriedade da PDL.\nCaso o número máximo de retentativas seja alcançado o evento de replicação é removido da fila de execução e armazenado no sistema de dead letter, onde deve ser analisado e tratado manualmente. x-senior-domain: Gestão de pessoas x-senior-domain-path: hcm x-senior-service-path: foundation_integration 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: /foundation_integration/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 /foundation_integration/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 /foundation_integration/queries/exportReplicationDeadLetter: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_integration/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 /foundation_integration/actions/invalidateUncoupledTenantCache: post: description: Invalida o cache de tenant desacoplado para o tenant especificado ou para todos os tenants caso um não seja especificado. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: tenant: type: string description: responses: 200: description: Ok schema: type: object required: – message properties: message: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_integration/actions/importReplicationDeadLetter: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation_integration/signals/retry: post: description: Primitiva para retentar a execução de um fluxo de normalização.\nCaso a execução de um fluxo disparada pelo evento de origem encontre um problema o serviço tenta executá-lo novamente\natravés dessa primitiva pela quantidade máxima de vezes definida por propriedade da PDL.\n tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – flow – flowId – sourceEventType – sourceEntity – flowStage – attempts – exceptionData properties: flow: type: string description: Nome do fluxo flowId: type: string description: Identificador único do fluxo sourceEventType: type: string allOf: – #/definitions/replicationEventType description: Tipo do evento recebido do sistema origem targetOperation: type: string description: Operação que será/foi realizada na base do sistema destino sourceEntity: type: object allOf: – #/definitions/entityData description: Entidade so sistema de origem targetEntity: type: object allOf: – #/definitions/entityData description: Entidade do sistema destino flowStage: type: string allOf: – #/definitions/flowStage description: Estágio do fluxo attempts: type: integer format: int64 description: Número de tentativas exceptionData: type: string description: Dados da exceção causadora do retry responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /foundation_integration/events/foundationJobPositionCreated: post: description: Evento de criação da entidade JobPosition x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/foundationJobPositionDTO responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_integration/events/foundationJobPositionUpdated: post: description: Evento de atualização da entidade JobPosition x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/foundationJobPositionDTO responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_integration/events/foundationJobPositionDeleted: post: description: Evento de remoção da entidade JobPosition x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id de JobPosition responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_integration/events/foundationPersonAddressCreated: post: description: Evento de replicação da entidade PersonAddress x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/foundationPersonAddressDTO responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_integration/events/foundationPersonAddressUpdated: post: description: Evento de replicação da entidade PersonAddress x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/foundationPersonAddressDTO responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_integration/events/foundationEmailCreated: post: description: Evento de replicação da entidade Email x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/foundationEmailDTO responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_integration/events/foundationEmailUpdated: post: description: Evento de replicação da entidade Email x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/foundationEmailDTO responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_integration/events/foundationEmployeeEmailCreated: post: description: Evento de replicação da entidade EmployeeEmail x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/foundationEmployeeEmailDTO responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_integration/events/foundationEmployeeEmailUpdated: post: description: Evento de replicação da entidade EmployeeEmail x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/foundationEmployeeEmailDTO responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_integration/events/foundationEmployeeEmailDeleted: post: description: Evento de replicação da entidade EmployeeEmail x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/foundationEmployeeEmailDTO responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_integration/events/foundationPersonCreated: post: description: Evento de replicação da entidade Person x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/foundationPersonDTO responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_integration/events/foundationPersonUpdated: post: description: Evento de replicação da entidade Person x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/foundationPersonDTO responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_integration/events/foundationPersonDisabilityCreated: post: description: Evento de replicação da entidade PersonDisabilty x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/foundationPersonDisabilityDTO responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_integration/events/foundationPersonDisabilityUpdated: post: description: Evento de replicação da entidade PersonDisability x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/foundationPersonDisabilityDTO responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_integration/events/foundationPersonDisabilityDeleted: post: description: Evento de replicação da entidade PersonDisability x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id de PersonDisability responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_integration/events/foundationWorkstationCreated: post: description: Evendo de replicação da entidade Workstation x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/foundationWorkstationDTO responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_integration/events/foundationWorkstationUpdated: post: description: Evendo de replicação da entidade Workstation x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/foundationWorkstationDTO responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_integration/events/foundationWorkstationDeleted: post: description: Evendo de remoção da entidade Workstation x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id da entidade Workstation responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_integration/events/foundationWorkstationGroupCreated: post: description: Evendo de criação da entidade Workstation Group x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/foundationWorkstationGroupDTO responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_integration/events/foundationWorkstationGroupUpdated: post: description: Evendo de atualização da entidade Workstation Group x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/foundationWorkstationGroupDTO responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_integration/events/foundationWorkstationGroupDeleted: post: description: Evendo de remoção da entidade Workstation Group x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id da entidade Workstation Group responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_integration/events/foundationUserAccountCreated: post: description: Evento de replicação da entidade UserAccount x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/foundationUserAccountDTO responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_integration/events/foundationUserAccountUpdated: post: description: Evento de replicação da entidade UserAccount x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/foundationUserAccountDTO responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_integration/events/foundationUserAccountDeleted: post: description: Evento de replicação da entidade UserAccount x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id de UserAccount responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_integration/events/foundationCostCenterCreated: post: description: Evento de replicação da entidade CostCenter x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/foundationCostCenterDTO responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_integration/events/foundationCostCenterUpdated: post: description: Evento de replicação da entidade CostCenter x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/foundationCostCenterDTO responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_integration/events/foundationCostCenterDeleted: post: description: Evento de replicação da entidade CostCenter x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id de CostCenter responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_integration/events/foundationWorkShiftCreated: post: description: Evento de replicação da entidade WorkShift x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/foundationWorkshiftDTO responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_integration/events/foundationWorkShiftUpdated: post: description: Evento de replicação da entidade WorkShift x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/foundationWorkshiftDTO responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_integration/events/foundationWorkShiftDeleted: post: description: Evento de replicação da entidade WorkShift x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id de WorkShift responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_integration/events/foundationEmployeeCreated: post: description: Evento de replicação da entidade Employee x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/foundationEmployeeDTO responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_integration/events/foundationEmployeeUpdated: post: description: Evento de replicação da entidade Employee x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/foundationEmployeeDTO responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_integration/events/legacyDepartmentCreated: post: description: Evento de replicação da entidade Department x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/legacyDepartmentDTO responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_integration/events/legacyDepartmentUpdated: post: description: Evento de replicação da entidade Department x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/legacyDepartmentDTO responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_integration/events/legacyDepartmentDeleted: post: description: Evento de replicação da entidade Department x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id de Department responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_integration/events/foundationCompanyCreated: post: description: Evento de criação da entidade Company x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/foundationCompanyDTO responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_integration/events/foundationCompanyUpdated: post: description: Evento de atualização da entidade Company x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/foundationCompanyDTO responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_integration/events/foundationCompanyDeleted: post: description: Evento de remoção da entidade Company x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id de Company responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_integration/events/foundationEmploymentRelationshipCreated: post: description: Evento de criação da entidade EmploymentRelationship x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/foundationEmploymentRelationshipDTO responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_integration/events/foundationEmploymentRelationshipUpdated: post: description: Evento de atualização da entidade EmploymentRelationship x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/foundationEmploymentRelationshipDTO responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_integration/events/foundationEmploymentRelationshipDeleted: post: description: Evento de remoção da entidade EmploymentRelationship x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id de EmploymentRelationship responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_integration/events/importReplicationDeadLetterEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /foundation_integration/events/exportReplicationDeadLetterEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError definitions: healthcheckDTO: description: Status do healthcheck type: string enum: – UP – DOWN replicationEventType: description: Tipo de evento de replicação disparado pela origem type: string enum: – CREATED – UPDATED – MERGED – DELETED targetOperationType: description: Tipo de operação executada no destino type: string enum: – INSERT – UPDATE – DELETE flowStage: description: Estágio do fluxo type: string enum: – PAYLOAD_MAPPING – TARGET_DATABASE_MANIPULATION – TARGET_EVENT_PUBLISHING 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 fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR foundationJobPositionDTO: description: foundationJobPositionDTO type: object required: – id – name – code – jobPositionStructureId properties: id: type: string description: Id do JobPosition name: type: string description: Nome do JobPosition code: type: string description: Código do JobPosition jobPositionStructureId: type: string description: Id da estrutura do JobPosition foundationPersonDTO: description: Dados da entidade Person Que vão ser disparadas nos eventos de replicação type: object required: – photoAttachment properties: id: type: string description: id username: type: string description: Usuário firstName: type: string description: Primeiro nome middleName: type: string description: Nome do meio lastName: type: string description: Último nome cpf: type: string description: CPF nationality: type: object allOf: – #/definitions/foundationNationalityDTO description: Nacionalidade gender: type: string description: Gênero birthday: type: string format: date description: Data de Nascimento maritalStatus: type: string description: Estado Civil photoAttachment: type: string description: Id da foto da pessoa foundationPersonDisabilityDTO: description: type: object required: – id – person – disability properties: id: type: string description: Id da relação Person Disability person: type: string description: Id da pessoa disability: type: object allOf: – #/definitions/foundationDisabilityDTO description: Deficiência da Pessoa foundationCompanyDTO: description: type: object required: – id – companyName – tradingName – headQuarterId – code properties: id: type: string description: Id da Company companyName: type: string description: Nome da Company tradingName: type: string description: Nome fantasia headQuarterId: type: string description: ID da matriz code: type: integer format: int64 description: Código da Company foundationDisabilityDTO: description: type: object required: – id – type properties: id: type: string description: Id da definciência type: type: string description: Tipo da deficiência foundationNationalityDTO: description: Nacionalidade type: object properties: id: type: string description: id name: type: string description: Nome da Nacionalidade code: type: integer format: int64 description: Código da Nscionalidade foundationUserAccountDTO: description: Dados da entidade UserAccout que serão disparadas nos eventos de replicação type: object required: – id – username properties: id: type: string description: Identificador único do registro username: type: string description: Nome do usuário na plataforma SeniorX personId: type: string description: Id de associação com entidade externa – Pessoa foundationCostCenterDTO: description: Centro de custo type: object required: – companyId – code – externalId – translateRecords properties: companyId: type: string description: Id empresa code: type: string description: Código externalId: type: string description: Id do centro de centro de custo translateRecords: type: array items: type: object allOf: – #/definitions/foundationTranslateRecords minimum: 1 description: Localização foundationWorkshiftDTO: description: Turno type: object required: – id – translateRecords properties: id: type: string description: Id turno shift: type: integer format: int64 description: Shift code: type: integer format: int64 description: Código translateRecords: type: array items: type: object allOf: – #/definitions/foundationTranslateRecords minimum: 1 description: Localização foundationEmploymentRelationshipDTO: description: Relação de trabalho type: object required: – id – translateRecords properties: id: type: string description: Id turno code: type: integer format: int64 description: Código translateRecords: type: array items: type: object allOf: – #/definitions/foundationTranslateRecords minimum: 1 description: Localização foundationTranslateRecords: description: Localização do Turno type: object required: – nameField – value – locale properties: nameField: type: string description: Nome do campo value: type: string description: Valor do campo locale: type: string description: Localização foundationEmployeeDTO: description: Colaborador type: object required: – id – hireDate – dismissalDate – workshiftId – contractType – personId – employerId – jobPositionId – departmentId – costCenterId – registerNumber properties: id: type: string description: id hireDate: type: string format: date description: Data de contratação dismissalDate: type: string format: date description: Date de demissão workshiftId: type: string description: Id turno de trabalho contractType: type: string description: Tipo contrato personId: type: string description: Id pessoa employerId: type: string description: Id empregrador jobPositionId: type: string description: Id cargo departmentId: type: string description: Id departamento costCenterId: type: string description: Id centro de custo registerNumber: type: integer format: int64 description: Número registro 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 foundationWorkstationDTO: description: type: object required: – id – workstationGroup – occupantId – companyId properties: id: type: string description: Identificador único workstationGroup: type: object allOf: – #/definitions/foundationWorkstationGroupDTO description: Grupo de postos de trabalho occupantId: type: string description: Id do ocupante (employee) do posto de trabalho companyId: type: string description: Id da empresa do respectivo posto de trabalho. entityData: description: Dados da entidade a ser processada type: object properties: json: type: string description: Payload da entidade em formato JSON className: type: string description: Nome da classe da entidade contendo o pacote id: type: string description: UUID da entidade a ser processada utilizado para operações de exclusão do CRUD foundationPersonAddressDTO: description: Dados da entidade PersonAddress Que vão ser disparadas nos eventos de replicação type: object required: – personId – addressId properties: personId: type: string description: id da pessoa. addressId: type: string description: Id do endereço. updateDate: type: string format: date description: Data de atualização address: type: string description: Endereço number: type: string description: Número postalCode: type: string description: Código postal country: type: string description: País state: type: string description: Estado city: type: string description: Cidade neightborhood: type: string description: Bairro additional: type: string description: Complemento stateAbbreviation: type: string description: Sigla da UF foundationEmailDTO: description: Dados da entidade Email Que vão ser disparadas nos eventos de replicação type: object required: – id – personId – type – email properties: id: type: string description: id. personId: type: string description: id da pessoa. type: type: string description: tipo do email email: type: string description: email foundationEmployeeEmailDTO: description: Dados da entidade EmployeeEmail Que vão ser disparadas nos eventos de replicação type: object required: – employeeId – personId – email properties: employeeId: type: string description: id do empregado personId: type: string description: id da pessoa email: type: string description: email legacyDepartmentDTO: description: Departamento type: object required: – id – name – code properties: id: type: string description: id name: type: string description: Nome departamento code: type: string description: Código foundationWorkstationGroupDTO: description: Grupo da estação de trabalho type: object required: – id – name – code – workstationGroupStructureId properties: id: type: string description: Identificador único name: type: string description: Nome do grupo do posto de trabalho code: type: string description: Código do grupo do posto de trabalho workstationGroupStructureId: type: string description: Id da estrutura do grupo do posto de trabalho. replicationDeadLetter: description: Mensagens não processadas da replicação de outros módulos (originalmente Foundation) type: object required: – flowId – flow – sourceEventType – targetOperation – flowStage – attempts – sourceEntityId – targetEntityId – eventPublicationDate – exceptionData properties: flowId: type: string description: Identificador único do fluxo flow: type: string description: Nome do fluxo sourceEventType: type: string allOf: – #/definitions/replicationEventType description: Tipo do evento recebido do sistema de origem targetOperation: type: string allOf: – #/definitions/targetOperationType description: Tipo de operação executada no destino flowStage: type: string allOf: – #/definitions/flowStage description: Estágio do fluxo attempts: type: integer format: int64 description: Número de tentativas sourceEntityClassName: type: string description: Nome da classe da entidade de origem contendo o pacote. Este campo é opcional pois no evento de delete é recebido apenas o ID como informação. sourceEntityId: type: string description: Identificador único da entidade de origem targetEntityClassName: type: string description: Nome da classe da entidade de destino contendo o pacote. Este campo é opcional pois no evento de delete é recebido apenas o ID como informação. targetEntityId: type: string description: Identificador único da entidade de destino eventPublicationDate: type: string format: date-time description: Data de publicação do evento do Foundation exceptionData: type: string description: Dados da exceção causadora do retry createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time 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. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: 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