HCM – Payroll Time Evaluation Monitor (monitor)

2.0info: 2.0.1 HCM – Payroll Time Evaluation Monitor description: HCM – Payroll Time Evaluation Monitor x-senior-domain: HCM – Payroll Time Evaluation Monitor x-senior-domain-path: hcm_payroll_time_evaluation x-senior-service-path: monitor 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_payroll_time_evaluationsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /monitor/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 /monitor/queries/getTimeEvaluationMonitor: post: description: Busca dos dados de monitoramento da apuração de horas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processId – calculationDefinition – employee properties: processId: type: string maxLength: 36 description: Identificador do processo do cálculo calculationDefinition: type: string maxLength: 36 description: Identificador único do código de cálculo employee: type: string maxLength: 36 description: Identificador único do colaborador responses: 200: description: Ok schema: type: object required: – monitor properties: monitor: type: string description: Monitoramento da apuração de horas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca dos dados de monitoramento da apuração de horas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: processId description: Identificador do processo do cálculo in: query required: true type: string maxLength: 36 – name: calculationDefinition description: Identificador único do código de cálculo in: query required: true type: string maxLength: 36 – name: employee description: Identificador único do colaborador in: query required: true type: string maxLength: 36 responses: 200: description: Ok schema: type: object required: – monitor properties: monitor: type: string description: Monitoramento da apuração de horas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /monitor/queries/getVacationTimeEvaluationMonitor: post: description: Busca dos dados de monitoramento da apuração de horas de férias tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processId – employee – vacationSchedule – acquisitivePeriod properties: processId: type: string maxLength: 36 description: Identificador do processo do cálculo employee: type: string maxLength: 36 description: Identificador único do colaborador vacationSchedule: type: string maxLength: 36 description: Identificador da programação de férias acquisitivePeriod: type: string maxLength: 36 description: Identificador do período aquisitivo responses: 200: description: Ok schema: type: object required: – monitor properties: monitor: type: string description: Monitoramento da apuração de horas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca dos dados de monitoramento da apuração de horas de férias tags: – Queries x-senior-visibility: PRIVATE parameters: – name: processId description: Identificador do processo do cálculo in: query required: true type: string maxLength: 36 – name: employee description: Identificador único do colaborador in: query required: true type: string maxLength: 36 – name: vacationSchedule description: Identificador da programação de férias in: query required: true type: string maxLength: 36 – name: acquisitivePeriod description: Identificador do período aquisitivo in: query required: true type: string maxLength: 36 responses: 200: description: Ok schema: type: object required: – monitor properties: monitor: type: string description: Monitoramento da apuração de horas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /monitor/queries/getDismissalTimeEvaluationMonitor: post: description: Busca dos dados de monitoramento da apuração de horas de rescisão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – processId – dismissalSchedule properties: processId: type: string maxLength: 36 description: Identificador do processo do cálculo dismissalSchedule: type: string maxLength: 36 description: Identificador da programação de rescisão responses: 200: description: Ok schema: type: object required: – monitor properties: monitor: type: string description: Monitoramento da apuração de horas da rescisão 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca dos dados de monitoramento da apuração de horas de rescisão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: processId description: Identificador do processo do cálculo in: query required: true type: string maxLength: 36 – name: dismissalSchedule description: Identificador da programação de rescisão in: query required: true type: string maxLength: 36 responses: 200: description: Ok schema: type: object required: – monitor properties: monitor: type: string description: Monitoramento da apuração de horas da rescisão 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /monitor/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 /monitor/queries/exportTimeEvaluationMonitor: 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 /monitor/queries/exportDismissalTimeEvaluationMonitor: 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 /monitor/queries/exportVacationTimeEvaluationMonitor: 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 /monitor/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 /monitor/actions/employeeVacationCompanyTransfer: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – previousEmployee – newEmployee properties: previousEmployee: type: string maxLength: 36 description: Colaborador origem newEmployee: type: string maxLength: 36 description: Colaborador destino vacationCompanyTransfer: type: array items: type: object allOf: – #/definitions/vacationCompanyTransfer description: Dados da definição de cálculo para transferência de empresa responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /monitor/actions/employeeFinancialStatementCompanyTransfer: post: description: Realiza o processo da transferência de empresa de um colaborador no domínio monitoramento de apuração de horas tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – previousEmployee – newEmployee properties: previousEmployee: type: string maxLength: 36 description: Colaborador origem newEmployee: type: string maxLength: 36 description: Colaborador destino calculationDefinitionCompanyTransfer: type: array items: type: object allOf: – #/definitions/calculationDefinitionCompanyTransfer description: Dados da definição de cálculo para transferência de empresa responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /monitor/actions/importTimeEvaluationMonitor: 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 /monitor/actions/importDismissalTimeEvaluationMonitor: 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 /monitor/actions/importVacationTimeEvaluationMonitor: 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 /monitor/signals/timeEvaluationMonitorCleaning: post: description: Limpa o monitoramento da apuração de horas não pertencentes ao processo informado, caso seja informado tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – calculationDefinitionId – employeeIds properties: calculationDefinitionId: type: string maxLength: 36 description: Identificador único do código de cálculo processId: type: string maxLength: 36 description: Identificador único do processo employeeIds: type: array items: type: string minimum: 1 description: Lista de identificador único do colaborador responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /monitor/signals/timeEvaluationMonitorBulk: post: description: Realiza a inserção em lote do monitoramento da apuração de horas tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – employeeTimeEvaluationData properties: employeeTimeEvaluationData: type: array items: type: object allOf: – #/definitions/employeeTimeEvaluationData minimum: 1 description: Informações gerais da apuração de horas responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /monitor/signals/vacationTimeEvaluationMonitorBulk: post: description: Realiza a inserção em lote do monitoramento de apuração de horas de férias tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId – vacationTimeEvaluationData properties: processId: type: string maxLength: 36 description: Identificador único do processo vacationTimeEvaluationData: type: array items: type: object allOf: – #/definitions/vacationTimeEvaluationData minimum: 1 description: Informações da apuração de horas dos colaboradores responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /monitor/signals/vacationTimeEvaluationMonitorCleaning: post: description: Limpeza do monitoramento da apuração de horas de férias tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – vacationScheduleProcess properties: vacationScheduleProcess: type: array items: type: object allOf: – #/definitions/vacationScheduleProcess minimum: 1 description: Informações das programações de férias dos colaboradores por identificador de processo. responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /monitor/signals/dismissalTimeEvaluationMonitorBulk: post: description: Realiza a inserção em lote do monitoramento de apuração de horas da rescisão tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId – dismissalTimeEvaluationData properties: processId: type: string maxLength: 36 description: Identificador único do processo dismissalTimeEvaluationData: type: array items: type: object allOf: – #/definitions/dismissalTimeEvaluationData minimum: 1 description: Informações da apuração de horas de rescisão dos colaboradores responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /monitor/signals/dismissalTimeEvaluationMonitorCleaning: post: description: Limpeza do monitoramento de apuração de horas da rescisão tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – dismissalScheduleProcess properties: dismissalScheduleProcess: type: array items: type: object allOf: – #/definitions/dismissalScheduleProcess minimum: 1 description: Informações das programações de rescisão dos colaboradores por identificador de processo. responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /monitor/signals/deleteEmployeeVacationCompanyTransfer: post: description: Realiza o processo de remoção de dados de férias da transferência de empresa de um colaborador. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – employee properties: employee: type: string maxLength: 36 description: Colaborador responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /monitor/signals/deleteEmployeeFinancialStatementCompanyTransfer: post: description: Realiza o processo de remoção de dados de ficha financeira da transferência de empresa de um colaborador. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – employee properties: employee: type: string maxLength: 36 description: Colaborador responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /monitor/events/importTimeEvaluationMonitorEvent: 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 /monitor/events/exportTimeEvaluationMonitorEvent: 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 /monitor/events/importDismissalTimeEvaluationMonitorEvent: 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 /monitor/events/exportDismissalTimeEvaluationMonitorEvent: 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 /monitor/events/importVacationTimeEvaluationMonitorEvent: 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 /monitor/events/exportVacationTimeEvaluationMonitorEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError definitions: healthcheckDTO: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Saudável * `DOWN` – Ruim userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text 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: Nome e status de retorno type: object required: – name – status properties: name: type: string description: Nome do status status: type: string allOf: – #/definitions/healthcheckDTO description: Status employeeTimeEvaluationData: description: Informações gerais da apuração de horas type: object properties: employee: type: string maxLength: 36 description: Identificador único do colaborador calculationDefinitionId: type: string maxLength: 36 description: Identificador único do código de cálculo processId: type: string maxLength: 36 description: Identificador único do processo timeEvaluationData: type: string description: Informações da apuração de horas vacationTimeEvaluationData: description: Informações da apuração de horas de férias dos colaboradores type: object required: – employee – acquisitivePeriod – vacationSchedule – information properties: employee: type: string maxLength: 36 description: Colaborador acquisitivePeriod: type: string maxLength: 36 description: Período aquisitivo vacationSchedule: type: string maxLength: 36 description: Programação de férias information: type: string description: Informações da apuração de horas vacationScheduleProcess: description: Informações das programações de férias type: object required: – processId – vacationScheduleId properties: processId: type: string maxLength: 36 description: Id do processo vacationScheduleId: type: array items: type: string minimum: 1 description: Programações de férias dismissalTimeEvaluationData: description: Informações da apuração de horas de rescisão dos colaboradores type: object required: – employee – dismissalSchedule – information properties: employee: type: string maxLength: 36 description: Colaborador dismissalSchedule: type: string maxLength: 36 description: Programação de rescisão information: type: string description: Informações da apuração de horas dismissalScheduleProcess: description: Informações das programações de rescisão dos colaboradores por identificador de processo. type: object required: – processId – dismissalScheduleId properties: processId: type: string maxLength: 36 description: Id do processo dismissalScheduleId: type: array items: type: string minimum: 1 description: Programações de rescisão vacationCompanyTransfer: description: Dados de férias para transferência de empresa type: object required: – previousAcquisitivePeriod – newAcquisitivePeriod – previousVacationSchedule – newVacationSchedule properties: previousAcquisitivePeriod: type: string maxLength: 36 description: Período aquisitivo origem newAcquisitivePeriod: type: string maxLength: 36 description: Período aquisitivo destino previousVacationSchedule: type: string maxLength: 36 description: Programação de férias origem newVacationSchedule: type: string maxLength: 36 description: Programação de férias destino calculationDefinitionCompanyTransfer: description: Dados da definição de cálculo para transferência de empresa type: object required: – previousCalculationDefinition – newCalculationDefinition properties: previousCalculationDefinition: type: string maxLength: 36 description: Definição de cálculo origem newCalculationDefinition: type: string maxLength: 36 description: Definição de cálculo destino timeEvaluationMonitor: description: Monitoramento da apuração de horas type: object required: – employee – calculationDefinition – processId – information properties: id: type: string format: uuid description: Identificador único employee: type: string format: uuid description: Colaborador calculationDefinition: type: string format: uuid description: Código de cálculo processId: type: string format: uuid description: Identificador do processo information: type: string maxLength: 4000 description: Informação dismissalTimeEvaluationMonitor: description: Monitoramento da apuração de horas da rescisão type: object required: – employee – dismissalSchedule – processId – information properties: id: type: string format: uuid description: Identificador único employee: type: string format: uuid description: Colaborador dismissalSchedule: type: string format: uuid description: Programação de rescisão processId: type: string format: uuid description: Identificador do processo information: type: string description: Informação vacationTimeEvaluationMonitor: description: Monitoramento da apuração de horas de férias type: object required: – employee – acquisitivePeriod – vacationSchedule – processId – information properties: id: type: string format: uuid description: Identificador único employee: type: string format: uuid description: Colaborador acquisitivePeriod: type: string format: uuid description: Período aquisitivo vacationSchedule: type: string format: uuid description: Programação de férias processId: type: string format: uuid description: Identificador do processo information: type: string description: Informação 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