HCM – Clocking Event Time Evaluation Process Manager (process_manager)

2.0info: 3.0.0 HCM – Clocking Event Time Evaluation Process Manager description: HCM – Clocking Event Time Evaluation Process Manager x-senior-domain: HCM – Clocking Event Time Evaluation x-senior-domain-path: hcm_clocking_event_time_evaluation x-senior-service-path: process_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_clocking_event_time_evaluationsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /process_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 /process_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 /process_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 /process_manager/queries/exportCompanyClockingEventIndications: 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 /process_manager/queries/exportTimeEvaluationDefinition: 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 /process_manager/queries/exportCalculationDefinition: 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 /process_manager/queries/exportCalculationDefinitionException: 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 /process_manager/queries/exportProcess: 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 /process_manager/queries/exportProcessStepEvent: 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 /process_manager/queries/exportProcessProcessingError: 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 /process_manager/queries/exportHourBank: 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 /process_manager/queries/exportHourBankAccount: 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 /process_manager/queries/exportEmployee: 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 /process_manager/queries/exportE001pes: 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 /process_manager/queries/exportEmployeeSnapshot: 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 /process_manager/queries/exportHourBankEmployeeBalance: 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 /process_manager/queries/exportHourBankCompetenceBalance: 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 /process_manager/queries/exportCollectorLayout: 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 /process_manager/queries/exportCollectorLocal: 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 /process_manager/queries/exportCollector: 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 /process_manager/queries/exportCollectorFunction: 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 /process_manager/queries/exportRegisterJustification: 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 /process_manager/queries/exportTimeEvaluation: 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 /process_manager/queries/exportWorkschedule: 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 /process_manager/queries/exportWorkshift: 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 /process_manager/queries/exportClockingEvent: 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 /process_manager/queries/exportWorkscheduleClockingEvent: 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 /process_manager/queries/exportWorkshiftGroup: 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 /process_manager/queries/exportEmployeeClockingEvent: 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 /process_manager/queries/exportEmployeeModule: 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 /process_manager/queries/exportTimeEvaluationPending: 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 /process_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 /process_manager/actions/migrateSchema: post: description: Realiza a migração do schema do banco de dados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/actions/evaluate: post: description: Cálculo de apuração tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate – filters – considerDismissed – reconsiderDeletedClockingEventsAdjustment properties: startDate: type: string format: date description: data de inicio do cálculo endDate: type: string format: date description: data final do cálculo filters: type: object allOf: – #/definitions/filterEvaluate description: Filtros para o cálculo de apuração considerDismissed: type: boolean description: Considerar demitidos reconsiderDeletedClockingEventsAdjustment: type: boolean description: Reconsiderar marcações excluídas no acerto responses: 200: description: Ok schema: type: object required: – summaryId properties: summaryId: type: string description: Id do Log de processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/actions/evaluateAsync: post: description: Cálculo de apuração tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate – filters – considerDismissed – reconsiderDeletedClockingEventsAdjustment properties: startDate: type: string format: date description: data de inicio do cálculo endDate: type: string format: date description: data final do cálculo filters: type: object allOf: – #/definitions/filterEvaluate description: Filtros para o cálculo de apuração considerDismissed: type: boolean description: Considerar demitidos reconsiderDeletedClockingEventsAdjustment: type: boolean description: Reconsiderar marcações excluídas no acerto responses: 200: description: Ok schema: type: object required: – summaryId properties: summaryId: type: string description: Id do Log de processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/actions/reevaluate: post: description: Cálculo de apuração tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate – filters – considerDismissed – onlyModifiedDaysAfterEvaluation – realocateClockingEvents – undoAdjustments – verifiedDays properties: startDate: type: string format: date description: data de inicio do cálculo endDate: type: string format: date description: data final do cálculo filters: type: object allOf: – #/definitions/filterEvaluate description: Filtros para o cálculo de apuração considerDismissed: type: boolean description: Considerar demitidos onlyModifiedDaysAfterEvaluation: type: boolean description: Somente dias alterados após a apuração realocateClockingEvents: type: boolean description: Realocar marcações undoAdjustments: type: boolean description: Desfazer acertos verifiedDays: type: string allOf: – #/definitions/verifiedDaysType description: Dias verificados responses: 200: description: Ok schema: type: object required: – summaryId properties: summaryId: type: string description: Id do Log de processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/actions/reevaluateAsync: post: description: Cálculo de apuração tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate – filters – considerDismissed – onlyModifiedDaysAfterEvaluation – realocateClockingEvents – undoAdjustments – verifiedDays properties: startDate: type: string format: date description: data de inicio do cálculo endDate: type: string format: date description: data final do cálculo filters: type: object allOf: – #/definitions/filterEvaluate description: Filtros para o cálculo de apuração considerDismissed: type: boolean description: Considerar demitidos onlyModifiedDaysAfterEvaluation: type: boolean description: Somente dias alterados após a apuração realocateClockingEvents: type: boolean description: Realocar marcações undoAdjustments: type: boolean description: Desfazer acertos verifiedDays: type: string allOf: – #/definitions/verifiedDaysType description: Dias verificados responses: 200: description: Ok schema: type: object required: – summaryId properties: summaryId: type: string description: Id do Log de processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/actions/hourBankMonthlyClosureAsync: post: description: Fechamento mensal do Banco de Horas tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – hourBankId – filters properties: hourBankId: type: string maxLength: 36 description: Id do Banco de Horas competence: type: string format: date description: Competência filters: type: object allOf: – #/definitions/filterEvaluate description: Filtro de colaboradores responses: 200: description: Ok schema: type: object required: – summaryId properties: summaryId: type: string description: Identificador do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/actions/hourBankReevaluateAsync: post: description: Recálculo do banco de horas tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – hourBankId – startDate – filters properties: hourBankId: type: string maxLength: 36 description: Id do banco de horas startDate: type: string format: date description: Data de inicio do recálculo filters: type: object allOf: – #/definitions/filterEvaluate description: Filtros para o recálculo do banco de horas considerDismissed: type: boolean description: Considerar demitidos default: true isDeleteIntegrationEntries: type: boolean description: É para excluir os lançamentos de integração default: false isCreateEvaluationEntries: type: boolean description: É para recriar os lançamentos da apuração default: false responses: 200: description: Ok schema: type: object required: – summaryId properties: summaryId: type: string description: Identificador do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/actions/hourBankAnticipateAllowanceAsync: post: description: Antecipar pagamento para o banco de horas tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – hourBankPaymentDTO – filters properties: hourBankPaymentDTO: type: object allOf: – #/definitions/hourBankPaymentDTO description: DTO com os dados de pagamento filters: type: object allOf: – #/definitions/filterEvaluate description: Filtro de colaboradores responses: 200: description: Ok schema: type: object required: – summaryId properties: summaryId: type: string description: Identificador do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/actions/hourBankCancelDebitAsync: post: description: Anular debito para o banco de horas tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – hourBankPaymentDTO – filters properties: hourBankPaymentDTO: type: object allOf: – #/definitions/hourBankPaymentDTO description: DTO com os dados de pagamento filters: type: object allOf: – #/definitions/filterEvaluate description: Filtro de colaboradores responses: 200: description: Ok schema: type: object required: – summaryId properties: summaryId: type: string description: Identificador do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/actions/hourBankAnticipateDiscountAsync: post: description: Anular debito para o banco de horas tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – hourBankPaymentDTO – filters properties: hourBankPaymentDTO: type: object allOf: – #/definitions/hourBankPaymentDTO description: DTO com os dados de pagamento filters: type: object allOf: – #/definitions/filterEvaluate description: Filtro de colaboradores responses: 200: description: Ok schema: type: object required: – summaryId properties: summaryId: type: string description: Identificador do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/actions/clockingEventGenerateDismissalEvents: post: description: Calculo de geração de eventos do Ponto para rescisão tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – competence – doubleEvents – debitPaymentType – creditPaymentType – evaluateByDismissalHistory – filters properties: competence: type: string format: date description: Competência doubleEvents: type: string allOf: – #/definitions/doubleType description: Eventos duplos dismissalDate: type: string format: date description: Data de demissão isCloseAccounts: type: boolean description: Fechar contas do banco default: false debitPaymentType: type: string allOf: – #/definitions/eventGenerationDebitPaymentType description: Banco de horas negativo resetTimeEvaluationAfterDismissal: type: boolean description: Zerar apuração após a demissão default: false creditPaymentType: type: string allOf: – #/definitions/eventGenerationCreditPaymentType description: Banco de horas positivo evaluateByDismissalHistory: type: boolean description: Calcular conforme histórico de desligamento filters: type: object allOf: – #/definitions/filterEvaluate description: Filtros para o calculo da geração dos eventos responses: 200: description: Ok schema: type: object required: – summaryId properties: summaryId: type: string description: Id do Log de processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/actions/clockingEventGenerateEvents: post: description: Calculo de geração de eventos do Ponto tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – competence – filters – doubleEvents properties: competence: type: string format: date description: Competência filters: type: object allOf: – #/definitions/filterEvaluate description: Filtros para o calculo da geração dos eventos doubleEvents: type: string allOf: – #/definitions/doubleType description: Eventos duplos responses: 200: description: Ok schema: type: object required: – summaryId properties: summaryId: type: string description: Id do Log de processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/actions/resetTimeEvaluationAsync: post: description: Zerar apuração tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – filters properties: startDate: type: string format: date description: Data inicial endDate: type: string format: date description: Data final deleteClockingEventTyped: type: boolean description: Deletar marcações digitadas default: true filters: type: object allOf: – #/definitions/filterEvaluate description: Filtros para zerar apuração responses: 200: description: Ok schema: type: object required: – summaryId properties: summaryId: type: string description: Identificador do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/actions/reevaluateTimeEvaluationPendingAsync: post: description: Recalcular as pendências tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: employees: type: array items: type: string description: Colaboradores companies: type: array items: type: string description: Lista de empresas startCreatedDate: type: string format: date-time description: Data inicial pendência endCreatedDate: type: string format: date-time description: Data final da pendência timeEvaluationPendingStatus: type: string allOf: – #/definitions/timeEvaluationPendingStatus description: Motivo startDateClockingEvent: type: string format: date description: Marcação data inicial endDateClockingEvent: type: string format: date description: Marcação data final responses: 200: description: Ok schema: type: object required: – summaryId properties: summaryId: type: string description: Id do Log de processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_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 /process_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 /process_manager/actions/importCompanyClockingEventIndications: 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 /process_manager/actions/importTimeEvaluationDefinition: 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 /process_manager/actions/importCalculationDefinition: 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 /process_manager/actions/importCalculationDefinitionException: 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 /process_manager/actions/importProcess: 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 /process_manager/actions/importProcessStepEvent: 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 /process_manager/actions/importProcessProcessingError: 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 /process_manager/actions/importHourBank: 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 /process_manager/actions/importHourBankAccount: 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 /process_manager/actions/importEmployee: 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 /process_manager/actions/importE001pes: 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 /process_manager/actions/importEmployeeSnapshot: 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 /process_manager/actions/importHourBankEmployeeBalance: 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 /process_manager/actions/importHourBankCompetenceBalance: 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 /process_manager/actions/importCollectorLayout: 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 /process_manager/actions/importCollectorLocal: 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 /process_manager/actions/importCollector: 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 /process_manager/actions/importCollectorFunction: 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 /process_manager/actions/importRegisterJustification: 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 /process_manager/actions/importTimeEvaluation: 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 /process_manager/actions/importWorkschedule: 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 /process_manager/actions/importWorkshift: 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 /process_manager/actions/importClockingEvent: 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 /process_manager/actions/importWorkscheduleClockingEvent: 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 /process_manager/actions/importWorkshiftGroup: 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 /process_manager/actions/importEmployeeClockingEvent: 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 /process_manager/actions/importEmployeeModule: 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 /process_manager/actions/importTimeEvaluationPending: 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 /process_manager/signals/reevaluateScheduleHistoryBatchAsync: post: description: Recálculo de apuração histórico e programações tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate – employees properties: startDate: type: string format: date description: data de inicio do cálculo endDate: type: string format: date description: data final do cálculo employees: type: array items: type: string minimum: 1 description: Colaboradores responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /process_manager/signals/runTenantsWithTimeEvaluationPending: post: description: Inicia a execução das pendências para os tenants registrados no cache tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /process_manager/signals/finishedProcessNotification: 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 properties: processId: type: string maxLength: 36 description: Identificador do processo processType: type: string allOf: – #/definitions/processType description: Tipo do processo responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /process_manager/signals/cancelProcessNotification: post: description: Realiza as ações necessárias ao cancelar um processo. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId – processType properties: processId: type: string maxLength: 36 description: Identificador do processo processType: type: string allOf: – #/definitions/processType description: Tipo do processo responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /process_manager/events/hourBankClosureLoad: post: description: Evento para carregamento das informações do fechamento do banco de horas x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – processId – batchId – payloadParams – employeeIds properties: processId: type: string description: Id do processo. batchId: type: string description: Id do lote de colaboradores payloadParams: type: string description: payload dos parâmetros employeeIds: type: array items: type: string minimum: 1 description: Lista de colaboradores por lote responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /process_manager/events/employeeTimeEvaluationLoad: post: description: Evento para carregamento das informações do cálculo de apuração, Quando alterar verificar que o employee-contract-processor tem dependência x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – processId – batchId – employees – payloadParams properties: processId: type: string description: Id do processo. batchId: type: string description: Id do lote de colaboradores employees: type: array items: type: object allOf: – #/definitions/employeesPeriodDTO minimum: 1 description: payload payloadParams: type: string description: payload dos parâmetros responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /process_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 /process_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 /process_manager/events/importCompanyClockingEventIndicationsEvent: 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 /process_manager/events/exportCompanyClockingEventIndicationsEvent: 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 /process_manager/events/importTimeEvaluationDefinitionEvent: 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 /process_manager/events/exportTimeEvaluationDefinitionEvent: 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 /process_manager/events/importCalculationDefinitionEvent: 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 /process_manager/events/exportCalculationDefinitionEvent: 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 /process_manager/events/importCalculationDefinitionExceptionEvent: 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 /process_manager/events/exportCalculationDefinitionExceptionEvent: 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 /process_manager/events/importProcessEvent: 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 /process_manager/events/exportProcessEvent: 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 /process_manager/events/importProcessStepEventEvent: 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 /process_manager/events/exportProcessStepEventEvent: 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 /process_manager/events/importProcessProcessingErrorEvent: 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 /process_manager/events/exportProcessProcessingErrorEvent: 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 /process_manager/events/importHourBankEvent: 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 /process_manager/events/exportHourBankEvent: 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 /process_manager/events/importHourBankAccountEvent: 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 /process_manager/events/exportHourBankAccountEvent: 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 /process_manager/events/importEmployeeEvent: 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 /process_manager/events/exportEmployeeEvent: 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 /process_manager/events/importE001pesEvent: 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 /process_manager/events/exportE001pesEvent: 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 /process_manager/events/importEmployeeSnapshotEvent: 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 /process_manager/events/exportEmployeeSnapshotEvent: 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 /process_manager/events/importHourBankEmployeeBalanceEvent: 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 /process_manager/events/exportHourBankEmployeeBalanceEvent: 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 /process_manager/events/importHourBankCompetenceBalanceEvent: 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 /process_manager/events/exportHourBankCompetenceBalanceEvent: 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 /process_manager/events/importCollectorLayoutEvent: 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 /process_manager/events/exportCollectorLayoutEvent: 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 /process_manager/events/importCollectorLocalEvent: 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 /process_manager/events/exportCollectorLocalEvent: 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 /process_manager/events/importCollectorEvent: 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 /process_manager/events/exportCollectorEvent: 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 /process_manager/events/importCollectorFunctionEvent: 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 /process_manager/events/exportCollectorFunctionEvent: 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 /process_manager/events/importRegisterJustificationEvent: 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 /process_manager/events/exportRegisterJustificationEvent: 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 /process_manager/events/importTimeEvaluationEvent: 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 /process_manager/events/exportTimeEvaluationEvent: 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 /process_manager/events/importWorkscheduleEvent: 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 /process_manager/events/exportWorkscheduleEvent: 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 /process_manager/events/importWorkshiftEvent: 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 /process_manager/events/exportWorkshiftEvent: 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 /process_manager/events/importClockingEventEvent: 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 /process_manager/events/exportClockingEventEvent: 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 /process_manager/events/importWorkscheduleClockingEventEvent: 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 /process_manager/events/exportWorkscheduleClockingEventEvent: 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 /process_manager/events/importWorkshiftGroupEvent: 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 /process_manager/events/exportWorkshiftGroupEvent: 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 /process_manager/events/importEmployeeClockingEventEvent: 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 /process_manager/events/exportEmployeeClockingEventEvent: 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 /process_manager/events/importEmployeeModuleEvent: 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 /process_manager/events/exportEmployeeModuleEvent: 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 /process_manager/events/importTimeEvaluationPendingEvent: 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 /process_manager/events/exportTimeEvaluationPendingEvent: 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 /process_manager/entities/timeEvaluationPending: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/timeEvaluationPending responses: 200: description: The created resource schema: #/definitions/timeEvaluationPending 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/timeEvaluationPending responses: 200: description: The created resource schema: #/definitions/timeEvaluationPending 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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/timeEvaluationPending 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /process_manager/entities/timeEvaluationPending/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editTimeEvaluationPending responses: 200: description: Ok schema: #/definitions/editTimeEvaluationPending 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/timeEvaluationPending responses: 200: description: Ok schema: #/definitions/timeEvaluationPending 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/timeEvaluationPending 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /process_manager/entities/timeEvaluationPending/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/timeEvaluationPending responses: 200: description: The bulk creation has created resources 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 verifiedDaysType: type: string enum: – ALL_DAYS – ONLY_VERIFIED_DAYS – ONLY_UNVERIFIED_DAYS description: Dias verificados: * `ALL_DAYS` – Todos os dias * `ONLY_VERIFIED_DAYS` – Somente os dias verificados * `ONLY_UNVERIFIED_DAYS` – Somente os dias não verificados hourBankClosureType: type: string enum: – MONTHLY_CLOSE – ANTICIPATE_ALLOWANCE – CANCEL_DEBIT – ANTICIPATE_DISCOUNT description: Tipo de fechamento de banco de horas: * `MONTHLY_CLOSE` – Fechamento mensal * `ANTICIPATE_ALLOWANCE` – Antecipar pagamento * `CANCEL_DEBIT` – Anular debito * `ANTICIPATE_DISCOUNT` – Antecipar desconto eventGenerationCreditPaymentType: type: string enum: – PAY – NOTHING_TO_DO description: Tipo de operações para o banco de horas positivo: * `PAY` – Pagar * `NOTHING_TO_DO` – Nada a fazer eventGenerationDebitPaymentType: type: string enum: – DISCOUNT – NOTHING_TO_DO – CANCEL_DEBIT description: Tipo de operações para o banco de horas negativo: * `DISCOUNT` – Discontar * `NOTHING_TO_DO` – Nada a fazer * `CANCEL_DEBIT` – Cancelar débito calculationType: type: string enum: – MONTHLY_PAYROLL – ADVANCE_SALARY – THIRTEENTH_SALARY – ADVANCE_THIRTEENTH_SALARY – SUPPLEMENTARY_PAYROLL – SUPPLEMENTARY_LABOR_AGREEMENT – SUPPLEMENTARY_LABOR_AGREEMENT_PAYROLL – SUPPLEMENTARY_DISMISSAL_ERROR_OR_OMISSION – SUPPLEMENTARY_DISMISSAL_PENDING_COMISSIONS – SUPPLEMENTARY_DISMISSAL_LABOR_AGREEMENT_PAYROLL description: Tipo de cálculo: * `MONTHLY_PAYROLL` – Folha mensal * `ADVANCE_SALARY` – Adiantamento salarial * `THIRTEENTH_SALARY` – 13º salário integral * `ADVANCE_THIRTEENTH_SALARY` – Adiantamento 13º salário * `SUPPLEMENTARY_PAYROLL` – Folha complementar * `SUPPLEMENTARY_LABOR_AGREEMENT` – Dissídio complementar * `SUPPLEMENTARY_LABOR_AGREEMENT_PAYROLL` – Folha de pagamento de dissídio * `SUPPLEMENTARY_DISMISSAL_ERROR_OR_OMISSION` – Rescisão complementar – Erro ou omissão * `SUPPLEMENTARY_DISMISSAL_PENDING_COMISSIONS` – Rescisão complementar – Comissões pendentes * `SUPPLEMENTARY_DISMISSAL_LABOR_AGREEMENT_PAYROLL` – Rescisão complementar – Dissídio exceptionType: type: string enum: – V1 – V2 – V3 description: Tipo de exceção: * `V1` – Filial * `V2` – Cargo * `V3` – Vínculo processType: type: string enum: – TIME_EVALUATION – TIME_EVALUATION_RECALCULATION – HOUR_BANK_CLOSURE – HOUR_BANK_REEVALUATE – GENERATE_EVENT – TIME_EVALUATION_VERIFICATION – RESET_TIME_EVALUATION – TIME_EVALUATION_PENDING description: Tipos de processo: * `TIME_EVALUATION` – Cálculo * `TIME_EVALUATION_RECALCULATION` – Recálculo * `HOUR_BANK_CLOSURE` – Fechamento do banco de horas * `HOUR_BANK_REEVALUATE` – Recálculo do banco de horas * `GENERATE_EVENT` – Geração de evento * `TIME_EVALUATION_VERIFICATION` – Verificação do ponto/dias apurados * `RESET_TIME_EVALUATION` – Zerar apuração * `TIME_EVALUATION_PENDING` – Processar pendências da apuração contractType: type: string enum: – EMPLOYEE – DIRECTOR – TRAINEE – APRENTICE – THIRD_PARTY description: Tipo de contrato: * `EMPLOYEE` – Empregado * `DIRECTOR` – Diretor * `TRAINEE` – Estagiário * `APRENTICE` – Aprendiz * `THIRD_PARTY` – Terceiro salaryType: type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 – V7 description: Tipo do salário: * `V1` – Por hora * `V2` – Por dia * `V3` – Por semana * `V4` – Por quinzena * `V5` – Por mês * `V6` – Por tarefa * `V7` – Comissionado – salário exclusivamente variável timeShiftType: type: string enum: – FIRSTSHIFT – SECONDSHIFT – THIRDSHIFT – FOURTHSHIFT – MIXEDDAYTIME – MIXEDNIGHTTIME – GENERAL description: Turno da escala: * `FIRSTSHIFT` – 1º Turno * `SECONDSHIFT` – 2º Turno * `THIRDSHIFT` – 3º Turno * `FOURTHSHIFT` – 4º Turno * `MIXEDDAYTIME` – Misto predominante diurno * `MIXEDNIGHTTIME` – Misto predominante noturno * `GENERAL` – Geral doubleType: type: string enum: – DESPISE – KEEP description: Eventos duplos: * `DESPISE` – Desprezar * `KEEP` – Manter admissionModuleType: type: string enum: – HCMHRI – HCMFLX – HCMCEM description: Tipo de inscrição do estabelecimento no caso de contratação indireta: * `HCMHRI` – HCMHRI – HRIS * `HCMFLX` – HCMFLX – Folha X * `HCMCEM` – HCMCEM – Ponto X timeEvaluationPendingStatus: type: string enum: – WAITING – EXPIRED – PROCESSING – BLOCKED_CLOSE_CALC_DEF description: Motivos de pendência da marcação ser ignorada: * `WAITING` – Aguardando * `EXPIRED` – Tempo de processamento vendido * `PROCESSING` – Processando * `BLOCKED_CLOSE_CALC_DEF` – Fechamento de cálculo de apuração identificationType: type: string enum: – V1 – V2 – V3 – V4 description: Tipo de Identificação: * `V1` – Pis * `V2` – Crachá * `V3` – Colaborador * `V4` – CPF clockingEventOriginType: type: string enum: – V1 – V2 – V3 description: Origem Marcação: * `V1` – Eletrônica * `V2` – DIGITADA * `V3` – GERADA clockingUseType: type: string enum: – V1 description: Uso da marcação: * `V1` – Marcação de Ponto reasonIgnored: type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 – V9 – V10 – V11 description: Motivo da marcação ignorada: * `V1` – Marcação normal * `V2` – Colaborador não apurado na data * `V3` – Colaborador dispensado de ponto * `V4` – Marcação após a demissão * `V5` – Marcação sem histórico * `V6` – Uso inválido * `V7` – Fora do intervalo entre marcações * `V8` – Marcação antes da admissão * `V9` – Marcação removida no acerto * `V10` – Marcação ainda não analisada * `V11` – Excedeu Limite de 100 Marcações fileType: type: string enum: – AFD – OTHER description: Tipo do Arquivo: * `AFD` – AFD * `OTHER` – Outros workscheduleDefinitionType: type: string enum: – NORMAL – DAYOFF – HOLIDAY – OFFSET – DSR description: Definição de Horário: * `NORMAL` – Normal * `DAYOFF` – Folga * `HOLIDAY` – Feriado * `OFFSET` – Compensado * `DSR` – DSR journeyType: type: string enum: – START_OF_WORK – END_OF_WORK description: Tipo de jornada: * `START_OF_WORK` – Pela entrada * `END_OF_WORK` – Pela saída calculateAbsenceType: type: string enum: – ONLY_END_OF_WORK – DURING_WORK description: Calcular faltas: * `ONLY_END_OF_WORK` – Somente no final do expediente * `DURING_WORK` – Durante o expediente changeType: type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 – V9 – V10 – V11 – V12 description: Indicador de alteração do dia por programação/histórico: * `V1` – Programação de troca de horário * `V2` – Programação de troca de escala * `V3` – Programação de pontes * `V4` – Programação de compensação * `V5` – Programação de autorização de horas extras * `V6` – Programação de autorização de saídas * `V7` – Programação de projeção de horário * `V8` – Histórico de afastamentos * `V9` – Histórico de escala * `V10` – Histórico de filial * `V11` – Programação de troca de rateio * `V12` – Sobreaviso/Prontidão workshiftType: type: string enum: – PERMANENT – AUTOMATIC_SEARCH description: Tipo de escala: * `PERMANENT` – Permanente * `AUTOMATIC_SEARCH` – Busca automática timeSourceCalculatedType: type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 description: Origem do horário apurado: * `V1` – Horário base conforme escala * `V2` – Horário conforme busca automática * `V3` – Programação de ponte * `V4` – Programação de troca de horário * `V5` – Programação de troca de escala * `V6` – Definido pela regra 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 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 filterEvaluate: description: Filtro para o cálculo de apuração type: object properties: employees: type: array items: type: string description: Lista de colaboradores companies: type: array items: type: string description: Lista de empresas advancedFilterId: type: string description: Identificado do filtro avançado employeesPeriodDTO: description: Colaboradores com período type: object required: – employee – startDate – endDate properties: employee: type: string description: Colaborador startDate: type: string format: date description: Data Inicial endDate: type: string format: date description: Data Final hourBankPaymentDTO: description: DTO com os dados de pagamento type: object required: – hourBankId – closureDate – percentage properties: hourBankId: type: string description: ID do banco de horas closureDate: type: string format: date description: Data de fechamento percentage: type: number format: double description: Percentual (%) minimum: 1 maximum: 100 hoursLimit: type: string description: Limite de horas, formato em quantidade de horas: hhh:mm isCloseBankAccount: type: boolean description: Fechar contas do banco default: false e070emp: description: Empresa – entidade incompleta type: object required: – codEmp – nomEmp properties: id: type: string format: uuid description: Id da entidade codEmp: type: integer format: int64 description: Código da empresa minimum: 0 maximum: 9999 nomEmp: type: string maxLength: 100 description: Nome da empresa companyClockingEventIndications: type: object allOf: – #/definitions/companyClockingEventIndications description: Assinalamentos do ponto para a 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: companyClockingEventIndications: description: Assinalamentos do ponto para a empresa – entidade incompleta type: object properties: id: type: string format: uuid description: Identificador único company: type: object allOf: – #/definitions/e070emp description: Empresa timeEvaluationDefinition: type: object allOf: – #/definitions/timeEvaluationDefinition description: Definição de apuração deleted: 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: timeEvaluationDefinition: description: Definição de apuração – entidade incompleta type: object required: – code – name properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código name: type: string maxLength: 255 description: Descrição x-i18n: true daysResume: type: integer format: int64 description: Dias para retomar deleted: 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: translations: type: object properties: locale: type: object properties: name: type: string maxLength: 255 example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. calculationDefinition: description: Código de cálculo type: object required: – code – calculationType – competence – timeTrackingStartDate – timeTrackingEndDate – paymentDate properties: id: type: string format: uuid description: Identificador único company: type: object allOf: – #/definitions/e070emp description: Empresa code: type: integer format: int64 description: Código do cálculo calculationType: type: string allOf: – #/definitions/calculationType description: Tipo de cálculo competence: type: string format: date description: Competência timeTrackingStartDate: type: string format: date description: Período apuração ponto inicial timeTrackingEndDate: type: string format: date description: Período apuração ponto final paymentDate: type: string format: date description: Data pagamento deleted: 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: calculationDefinitionException: description: Exceção do código de cálculo type: object required: – exceptionType – filter – timeTrackingStartDate – timeTrackingEndDate – paymentDate properties: id: type: string format: uuid description: Identificador único calculationDefinition: type: object allOf: – #/definitions/calculationDefinition description: Código de cálculo exceptionType: type: string allOf: – #/definitions/exceptionType description: Tipo de exceção filter: type: string description: Abrangência timeTrackingStartDate: type: string format: date description: Período apuração ponto inicial timeTrackingEndDate: type: string format: date description: Período apuração ponto final paymentDate: type: string format: date description: Data pagamento deleted: 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: process: description: Responsável pelo controle da coreografia de pré-requisitos do processo de apuração de horas dos colaboradores. type: object required: – processId – batchId – total properties: id: type: string format: uuid description: Identificador único processId: type: string format: uuid description: Identificador do processo batchId: type: string format: uuid description: Identificador do lote total: type: integer format: int64 description: Total de pré-requisitos finalizados minimum: 0 processType: type: string allOf: – #/definitions/processType description: Tipo do processo type: integer format: int64 description: Versão do fluxo do processo status: type: string maxLength: 100 description: Status do processamento batchNumber: type: integer format: int64 description: Número do lote batchSize: type: integer format: int64 description: Quantidade total de registros do lote minimum: 0 default: 0 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 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: processStepEvent: description: Controle de eventos recebidos por etapa na orquestração do processo. type: object required: – process – stepOrder – originDomain – originService – originEvent properties: id: type: string format: uuid description: Identificador único process: type: object allOf: – #/definitions/process description: Processo stepOrder: type: integer format: int64 description: Ordem da etapa originDomain: type: string maxLength: 100 description: Domínio de origem originService: type: string maxLength: 100 description: Serviço de origem originEvent: type: string maxLength: 100 description: Evento createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: processProcessingError: description: Registro de erros de processamento de lotes por colaborador. type: object required: – process – employee – errorOrigin – errorMessage properties: id: type: string format: uuid description: Identificador único process: type: object allOf: – #/definitions/process description: Processo employee: type: object allOf: – #/definitions/employee description: Colaborador errorOrigin: type: string maxLength: 100 description: Origem do erro errorMessage: type: string maxLength: 4000 description: Mensagem de erro createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: hourBank: description: Banco de horas type: object required: – code – name properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código name: type: string maxLength: 255 description: Descrição x-i18n: true createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: name: type: string maxLength: 255 example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. hourBankAccount: description: Conta do banco de horas type: object required: – employee – hourBank – creationDateAccount properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador hourBank: type: object allOf: – #/definitions/hourBank description: Banco de Horas creationDateAccount: type: string format: date description: Data de criação da conta extinctionDateAccount: type: string format: date description: Data de extinção da conta initialCompetence: type: string format: date description: Compentencia inicial finalCompetence: type: string format: date description: Compentencia final createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: employee: description: Colaborador type: object required: – person – code properties: id: type: string format: uuid description: Identificador único person: type: object allOf: – #/definitions/e001pes description: Pessoa hireDate: type: string format: date description: Data de admissão dismissalDate: type: string format: date description: Data de desligamento employer: type: object allOf: – #/definitions/e070emp description: Empresa que o contratou code: type: integer format: int64 description: Cadastro employeeSnapshot: type: object allOf: – #/definitions/employeeSnapshot description: Históricos correntes do colaborador deleted: 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: e001pes: description: Pessoa type: object required: – nomPes properties: id: type: string format: uuid description: Identificador único nomPes: type: string maxLength: 100 description: Nome numNis: type: string maxLength: 11 description: Número de inscrição do segurado (NIS, NIT e PIS/PASEP) cnpCpf: type: string maxLength: 14 description: CNPJ/CPF 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: employeeSnapshot: description: Históricos correntes do colaborador type: object properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador company: type: string format: uuid description: Empresa corrente do colaborador companyCode: type: integer format: int64 description: Código da empresa corrente do colaborador companyBranch: type: string format: uuid description: Filial corrente do colaborador companyBranchCode: type: integer format: int64 description: Código da filial corrente do colaborador companyBranchName: type: string description: Nome da filial employmentRelationship: type: string format: uuid description: Vínculo empregatício corrente do colaborador employmentRelationshipCode: type: string description: Código do vínculo empregatício corrente do colaborador employmentRelationshipContractType: type: string allOf: – #/definitions/contractType description: Tipo de contrato vínculo empregatício corrente do colaborador jobPosition: type: string format: uuid description: Cargo corrente do colaborador jobPositionCode: type: integer format: int64 description: Código do cargo corrente do colaborador position: type: string format: uuid description: Posição corrente do colaborador positionCode: type: integer format: int64 description: Código da posição corrente do colaborador salaryHistorySalaryType: type: string allOf: – #/definitions/salaryType description: Tipo de salário corrente do colaborador syndicate: type: string format: uuid description: Sindicato corrente do colaborador syndicateCode: type: integer format: int64 description: Código do sindicato corrente do colaborador workshift: type: string format: uuid description: Escala corrente do colaborador workshiftCode: type: integer format: int64 description: Código da escala corrente do colaborador workshiftTimeShiftType: type: string allOf: – #/definitions/timeShiftType description: Turno do horário corrente do colaborador workshiftGroup: type: string format: uuid description: Turma da escala corrente do colaborador workshiftGroupCode: type: integer format: int64 description: Código da turma da escala corrente do colaborador costCenter: type: string format: uuid description: Centro de custo corrente do colaborador costCenterCode: type: string maxLength: 9 description: Código do centro de custo corrente do colaborador location: type: string format: uuid description: Local corrente do colaborador locationCode: type: integer format: int64 description: Código do local corrente do colaborador deleted: 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: hourBankEmployeeBalance: description: Total do banco de horas por colaborador type: object required: – employee – hourBank properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador hourBank: type: object allOf: – #/definitions/hourBank description: Banco de horas compensationDeadline: type: string format: date description: Data de vencimento createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: hourBankCompetenceBalance: description: Saldos de Banco de horas por competência type: object required: – employee – hourBank properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador hourBank: type: object allOf: – #/definitions/hourBank description: Banco de horas competenceBalance: type: string format: date description: Competência do saldo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: collectorLayout: description: Modelo de Coletor type: object required: – code – name – clockingRecord properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código name: type: string description: Descrição x-i18n: true masterRecord: type: string maxLength: 35 description: Registro mestre clockingRecord: type: string maxLength: 100 description: Registro marcação deleted: 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: translations: type: object properties: locale: type: object properties: name: type: string example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. collectorLocal: description: Local type: object required: – code – name properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código name: type: string description: Descrição x-i18n: true deleted: 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: translations: type: object properties: locale: type: object properties: name: type: string example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. collector: description: Coletor type: object required: – code – name – fileType properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código name: type: string description: Descrição x-i18n: true collectorLayout: type: object allOf: – #/definitions/collectorLayout description: Leiaute collectorLocal: type: object allOf: – #/definitions/collectorLocal description: Local fileType: type: string allOf: – #/definitions/fileType description: Tipo de Arquivo deleted: 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: translations: type: object properties: locale: type: object properties: name: type: string example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. collectorFunction: description: Função type: object required: – code – name properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código maximum: 99 name: type: string maxLength: 20 description: Descrição x-i18n: true deleted: 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: translations: type: object properties: locale: type: object properties: name: type: string maxLength: 20 example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. registerJustification: description: Justificativa type: object required: – code – name properties: id: type: string format: uuid description: ID code: type: integer format: int64 description: Código name: type: string description: Descrição x-i18n: true deleted: 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: translations: type: object properties: locale: type: object properties: name: type: string example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. timeEvaluation: description: Apuração type: object required: – employee – timeEvaluationDate properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador timeEvaluationDate: type: string format: date description: Data da apuração workschedule: type: object allOf: – #/definitions/workschedule description: Horário na data lastTimeEvaluationUser: type: string maxLength: 255 description: Usuário da última apuração verifierUser: type: string maxLength: 255 description: Usuário verificador changeType: type: string allOf: – #/definitions/changeType description: Indicador de alteração do dia por programação/histórico workshift: type: object allOf: – #/definitions/workshift description: Escala workshiftGroup: type: object allOf: – #/definitions/workshiftGroup description: Turma hasException: type: boolean description: Tem exceção no dia default: false missingClockingEvent: type: boolean description: Falta marcação no dia default: false timeSourceCalculated: type: string allOf: – #/definitions/timeSourceCalculatedType description: Origem do horário apurado incompleteJourney: type: boolean description: Apurado jornada incompleta default: false timeEvaluationPeriod: type: string format: date description: Competência do cálculo timeEvaluationAdjustmentLog: type: boolean description: Log de acerto default: false endDateLimitDay: type: string format: date description: Data final Separação do dia endTimeLimitDay: type: integer format: int64 description: Horas final Separação do dia minimum: 0 maximum: 1439 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: workschedule: description: Horário type: object required: – code – name – workscheduleDefinitionType properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código name: type: string description: Descrição horário x-i18n: true workscheduleDefinitionType: type: string allOf: – #/definitions/workscheduleDefinitionType description: Tipo do horário workscheduleClockingEvent: type: object allOf: – #/definitions/workscheduleClockingEvent description: Horário do ponto initialValidity: type: string format: date description: Data de criação finalValidity: type: string format: date description: Data de extinção deleted: 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: translations: type: object properties: locale: type: object properties: name: type: string example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. workshift: description: Escala type: object required: – code – name properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código name: type: string maxLength: 255 description: Nome x-i18n: true workshiftType: type: string allOf: – #/definitions/workshiftType description: Tipo de escala initialValidity: type: string format: date description: Data de criação finalValidity: type: string format: date description: Data de extinção deleted: 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: translations: type: object properties: locale: type: object properties: name: type: string maxLength: 255 example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. clockingEvent: description: Marcações type: object required: – clockingEventDate – clockingEventTime – identificationType – identification – clockingEventOrigin – clockingUse properties: id: type: string format: uuid description: Identificador único collector: type: object allOf: – #/definitions/collector description: Coletor clockingEventDate: type: string format: date description: Data da Marcação clockingEventTime: type: integer format: int64 description: Hora da Marcação minimum: 0 maximum: 1439 nsrNumber: type: integer format: int64 description: Número NSR maximum: 999999999 identificationType: type: string allOf: – #/definitions/identificationType description: Tipo de Identificação identification: type: integer format: int64 description: Identificação clockingEventOrigin: type: string allOf: – #/definitions/clockingEventOriginType description: Origem Marcação function: type: object allOf: – #/definitions/collectorFunction description: Função zoneOffset: type: string description: Timezone employee: type: object allOf: – #/definitions/employee description: Colaborador timeEvaluationDate: type: string format: date description: Data da Apuração clockingUse: type: string allOf: – #/definitions/clockingUseType description: Uso da Marcação justification: type: object allOf: – #/definitions/registerJustification description: Justificativa de marcação observation: type: string description: Observação da justificativa reasonIgnored: type: string allOf: – #/definitions/reasonIgnored description: Motivo da marcação ignorada clockingEventRemoved: type: boolean description: Excluída do ponto default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: workscheduleClockingEvent: description: Horário do ponto type: object required: – journeyType properties: id: type: string format: uuid description: Identificador único workschedule: type: object allOf: – #/definitions/workschedule description: Horário journeyType: type: string allOf: – #/definitions/journeyType description: Tipo de jornada calculateAbsence: type: string allOf: – #/definitions/calculateAbsenceType description: Calcular faltas workStartEndOvertimeTolerance: type: integer format: int64 description: Extras entrada/saída minimum: 0 maximum: 1439 mealOvertimeTolerance: type: integer format: int64 description: Extras refeição minimum: 0 maximum: 1439 overtimeDailyTotalTolerance: type: integer format: int64 description: Total diário de extras minimum: 0 maximum: 1439 workStartEndAbsenceTolerance: type: integer format: int64 description: Faltas entrada/saída minimum: 0 maximum: 1439 mealAbsenceTolerance: type: integer format: int64 description: Faltas refeição minimum: 0 maximum: 1439 absenceDailyTotalTolerance: type: integer format: int64 description: Total diário de faltas minimum: 0 maximum: 1439 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: workshiftGroup: description: Turma de escala type: object required: – code – baseDate properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código workshift: type: object allOf: – #/definitions/workshift description: Escala baseDate: type: string format: date description: Data base da turma deleted: 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: employeeClockingEvent: description: Especialização do colaborador para o ponto type: object required: – hireCompetence properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador hireCompetence: type: string format: date description: Competência de admissão dismissalCompetence: type: string format: date description: Compentência de demissão createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: employeeModule: description: Modulo do colaborador type: object required: – employee – moduleType properties: id: type: string format: uuid description: Identificador employee: type: object allOf: – #/definitions/employee description: Colaborador moduleType: type: string maxLength: 6 description: Tipo do módulo deleted: type: boolean description: Indica se o registro foi excluído default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: timeEvaluationPending: description: Pendência de apuração de ponto type: object required: – employee properties: id: type: string format: uuid description: Identificador único employee: type: object allOf: – #/definitions/employee description: Colaborador clockingEvent: type: object allOf: – #/definitions/clockingEvent description: Marcação status: type: string allOf: – #/definitions/timeEvaluationPendingStatus description: Status da pendência timeEvaluationDate: type: string format: date description: Data da apuração summaryId: type: string format: uuid description: Id do Log de processo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editTimeEvaluationPending: type: object required: – id allOf: – #/definitions/timeEvaluationPending 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 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