• Início
    • A Plataforma
    • Para customizar
      • Visão geral
      • Tutoriais
      • Github.com
      • Guia de contribuição
      • Tabela de compatibilidade
    • Para desenvolver
      • Visão geral
      • API – Guia de Estilo
      • UX – Guia de estilo
    • Para administrar
      • Documentação
  • APIs
  • Documentação
    • APIs Senior X
    • Tutoriais
  • Fórum
  • Community
  • Entrar
  • Cadastrar-se
  • Início
    • A Plataforma
    • Para customizar
      • Visão geral
      • Tutoriais
      • Github.com
      • Guia de contribuição
      • Tabela de compatibilidade
    • Para desenvolver
      • Visão geral
      • API – Guia de Estilo
      • UX – Guia de estilo
    • Para administrar
      • Documentação
  • APIs
  • Documentação
    • APIs Senior X
    • Tutoriais
  • Fórum
  • Community
  • Entrar
  • Cadastrar-se
home/APIs Privadas/hcm_esocial_generator (HCM - Esocial Generator General)/HCM – Esocial Migrator Manager (migrator_manager)
Mais pesquisados:Customização, Tutorial, Documentação

HCM – Esocial Migrator Manager (migrator_manager)

12 views 0 09/11/2026 integrador

2.0info: 0.7.0 HCM – Esocial Migrator Manager description: HCM – Esocial Migrator Manager x-senior-domain: HCM – Esocial Migrator Manager x-senior-domain-path: hcm_esocial_generator x-senior-service-path: migrator_manager 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/hcm_esocial_generatorsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /migrator_manager/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 /migrator_manager/queries/exportMongoConnectionDefinition: 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 /migrator_manager/queries/exportE070emp: 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 /migrator_manager/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 /migrator_manager/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 /migrator_manager/actions/processMigrationData: post: description: Relacionar dados da migração do eSocial tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – companyId – layoutCode properties: companyId: type: string maxLength: 36 description: Identificador único da empresa layoutCode: type: string allOf: – #/definitions/layoutType description: Leiaute a ser processado responses: 200: description: Ok schema: type: object required: – processId properties: processId: type: string description: Identificador único do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /migrator_manager/actions/deleteMigrationData: post: description: Exclui dados previamente migrados do eSocial tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – companyId – layoutCode properties: companyId: type: string maxLength: 36 description: Identificador único da empresa layoutCode: type: string allOf: – #/definitions/layoutType description: Leiaute responses: 200: description: Ok schema: type: object required: – processId properties: processId: type: string maxLength: 36 description: Identificador único do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /migrator_manager/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /migrator_manager/actions/importMongoConnectionDefinition: 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 /migrator_manager/actions/importE070emp: 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 /migrator_manager/signals/finishedProcess: post: description: Realiza as ações necessárias ao finalizar um processo. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId – processType – processTypeDescription – startDate – startedBy – unit properties: processId: type: string description: Identificador único do processo processType: type: string description: Tipo de processo processTypeDescription: type: string description: Descrição do tipo do Processo. startDate: type: string format: date-time description: Data de Início do Processo endDate: type: string format: date-time description: Data de Término do Processo total: type: integer format: int64 description: Quantidade total de registros a serem processados default: 0 processed: type: integer format: int64 description: Quantidade total de registros processados processedWithError: type: integer format: int64 description: Quantidade de registros processados com erro default: 0 successfullyProcessed: type: integer format: int64 description: Quantidade de registros processados com sucesso default: 0 unprocessed: type: integer format: int64 description: Quantidade de registros não processados default: 0 startedBy: type: string description: Usuário que iniciou o processo unit: type: string description: Unidade dos itens que estão sendo processados (colaboradores, apurações, etc.) cancelledBy: type: string description: Usuário que cancelou o processo cancellationDate: type: string format: date-time description: Data de cancelamento do processo responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /migrator_manager/events/processDataInitializationFinished: post: description: Evento que comunica a finalização da inicialização de etapa de relacionar dados. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – companyId – processId – batchId – batchSequence – layout properties: companyId: type: string maxLength: 36 description: Identificador único da empresa processId: type: string maxLength: 36 description: Identificador único do processo batchId: type: string maxLength: 36 description: Identificador único do lote batchSequence: type: integer format: int64 description: Sequência do lote layout: type: string allOf: – #/definitions/layoutType description: Leiaute a ser processado responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /migrator_manager/events/importMongoConnectionDefinitionEvent: 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 /migrator_manager/events/exportMongoConnectionDefinitionEvent: 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 /migrator_manager/events/importE070empEvent: 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 /migrator_manager/events/exportE070empEvent: 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 /migrator_manager/entities/mongoConnectionDefinition: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/mongoConnectionDefinition responses: 200: description: The created resource schema: #/definitions/mongoConnectionDefinition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/mongoConnectionDefinition responses: 200: description: The created resource schema: #/definitions/mongoConnectionDefinition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/mongoConnectionDefinition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /migrator_manager/entities/mongoConnectionDefinition/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editMongoConnectionDefinition responses: 200: description: Ok schema: #/definitions/editMongoConnectionDefinition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/mongoConnectionDefinition responses: 200: description: Ok schema: #/definitions/mongoConnectionDefinition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/mongoConnectionDefinition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /migrator_manager/entities/mongoConnectionDefinition/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/mongoConnectionDefinition responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: layoutType: type: string enum: – S1000 – S1005 – S1070 – S1200 – S1210 – S1280 – S1299 – S2190 – S2200 – S2205 – S2206 – S2230 – S2298 – S2299 – S2300 – S2306 – S2399 description: Enumeração dos leiautes a serem processados: * `S1000` – Informações do empregador/contribuinte/órgão público * `S1005` – Tabela de estabelecimentos, obras ou unidades de órgãos públicos * `S1070` – Tabela de processos administrativos/judiciais * `S1200` – Remuneração de trabalhador vinculado ao RGPS * `S1210` – Pagamentos de rendimentos do trabalho * `S1280` – Informações complementares aos eventos periódicos * `S1299` – Fechamento dos eventos periódicos * `S2190` – Registro preliminar de trabalhador * `S2200` – Cadastramento inicial do vínculo e admissão/ingresso de trabalhador * `S2205` – Alteração de dados cadastrais do trabalhador * `S2206` – Alteração de contrato de trabalho/relação estatutária * `S2230` – Afastamento temporário * `S2298` – Reintegração/outros provimentos * `S2299` – Desligamento * `S2300` – Trabalhador sem vínculo de emprego/estatutário – Início * `S2306` – Trabalhador sem vínculo – Alteração contratual * `S2399` – Trabalhador sem vínculo – Término 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 fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error healthcheckDTO: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Saudável * `DOWN` – Ruim mongoConnectionDefinition: description: Definições de conexão com o MongoDB type: object required: – company – server – port – userName – authenticationDatabase – databaseName properties: id: type: string format: uuid description: Identificador único company: type: object allOf: – #/definitions/e070emp description: Empresa server: type: string description: Servidor port: type: integer format: int64 description: Porta minimum: 0 maximum: 99999 userName: type: string maxLength: 100 description: Usuário password: type: string maxLength: 100 description: Senha authenticationDatabase: type: string maxLength: 100 description: Base de dados de autenticação databaseName: type: string maxLength: 100 description: Base de dados createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editMongoConnectionDefinition: type: object required: – id allOf: – #/definitions/mongoConnectionDefinition e070emp: description: Empresa type: object required: – codEmp – nomEmp properties: id: type: string format: uuid description: Identificador único codEmp: type: integer format: int64 description: Código da empresa minimum: 0 maximum: 9999 nomEmp: type: string maxLength: 100 description: Nome da empresa excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação 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 checkDTO: description: Retorno status usados de retorno type: object required: – status – name properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status name: type: string description: Status 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

Este artigo foi útil para você?

Sim  Não
Leave A Comment Cancelar resposta

Você precisa fazer o login para publicar um comentário.

© 2022 Senior. Todos os direitos reservados.
Mais pesquisados:Customização, Tutorial, Documentação