2.0info: 1.2.0 Métricas da Mão de Obra description: Serviço de Medidas da Mão de obra x-senior-domain: Labor Manager System x-senior-domain-path: lms x-senior-service-path: metricas 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/lmssecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /metricas/queries/getGoalByCodOperator: post: description: Busca meta por código de operador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codOperator properties: codOperator: type: string description: Código do operador responses: 200: description: Ok schema: type: object required: – goal properties: goal: type: object allOf: – #/definitions/employeeGoal description: Meta do Operador 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca meta por código de operador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: codOperator description: Código do operador in: query required: true type: string responses: 200: description: Ok schema: type: object required: – goal properties: goal: type: object allOf: – #/definitions/employeeGoal description: Meta do Operador 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /metricas/queries/getCurrentEmployeeGoals: post: description: Busca as metas atuais dos colaboradores tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: logisticUnitIds: type: array items: type: string description: Ids das unidades logisticas workshiftIds: type: array items: type: string description: Ids das escalas/turnos employeeIds: type: array items: type: string description: Ids dos colaboradores hireDate: type: string format: date description: Data de admissão offset: type: integer format: int64 description: Offset da página default: 0 size: type: integer format: int64 description: Tamanho da página default: 10 responses: 200: description: Ok schema: type: object required: – totalElements – totalPages – contents properties: totalElements: type: integer format: int64 description: Número de elementos na pagina totalPages: type: integer format: int64 description: Número total de páginas contents: type: array items: type: object allOf: – #/definitions/currentEmployeeGoals minimum: 1 description: Metas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca as metas atuais dos colaboradores tags: – Queries x-senior-visibility: PRIVATE parameters: – name: logisticUnitIds description: Ids das unidades logisticas in: query type: array items: type: string – name: workshiftIds description: Ids das escalas/turnos in: query type: array items: type: string – name: employeeIds description: Ids dos colaboradores in: query type: array items: type: string – name: hireDate description: Data de admissão in: query type: string format: date – name: offset description: Offset da página in: query type: integer format: int64 – name: size description: Tamanho da página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – totalElements – totalPages – contents properties: totalElements: type: integer format: int64 description: Número de elementos na pagina totalPages: type: integer format: int64 description: Número total de páginas contents: type: array items: type: object allOf: – #/definitions/currentEmployeeGoals minimum: 1 description: Metas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /metricas/queries/getCurrentEmployeGoalByEmployee: post: description: Busca a meta atual do colaborador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeeId properties: employeeId: type: string description: Id do employee responses: 200: description: Ok schema: type: object required: – employeeGoal properties: employeeGoal: type: object allOf: – #/definitions/currentEmployeeGoals description: Dados da meta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca a meta atual do colaborador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: employeeId description: Id do employee in: query required: true type: string responses: 200: description: Ok schema: type: object required: – employeeGoal properties: employeeGoal: type: object allOf: – #/definitions/currentEmployeeGoals description: Dados da meta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /metricas/queries/getCurrentEmployeGoalByEmployees: post: description: Busca a meta atual dos colaboradorres tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – employeeIds properties: employeeIds: type: array items: type: string minimum: 1 description: Id do employee responses: 200: description: Ok schema: type: object required: – employeeGoals properties: employeeGoals: type: array items: type: object allOf: – #/definitions/currentEmployeeGoals minimum: 1 description: Dados das metas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca a meta atual dos colaboradorres tags: – Queries x-senior-visibility: PRIVATE parameters: – name: employeeIds description: Id do employee in: query required: true type: array items: type: string minimum: 1 responses: 200: description: Ok schema: type: object required: – employeeGoals properties: employeeGoals: type: array items: type: object allOf: – #/definitions/currentEmployeeGoals minimum: 1 description: Dados das metas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /metricas/queries/getUlGoals: post: description: Busca as metas das unidades logisticas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: offset: type: integer format: int64 description: Offset da página default: 0 size: type: integer format: int64 description: Tamanho da página default: 10 responses: 200: description: Ok schema: type: object required: – totalElements – totalPages – contents properties: totalElements: type: integer format: int64 description: Número de elementos na pagina totalPages: type: integer format: int64 description: Número total de páginas contents: type: array items: type: object allOf: – #/definitions/simplifiedUlGoal minimum: 1 description: Metas das unidades logisticas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca as metas das unidades logisticas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: offset description: Offset da página in: query type: integer format: int64 – name: size description: Tamanho da página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – totalElements – totalPages – contents properties: totalElements: type: integer format: int64 description: Número de elementos na pagina totalPages: type: integer format: int64 description: Número total de páginas contents: type: array items: type: object allOf: – #/definitions/simplifiedUlGoal minimum: 1 description: Metas das unidades logisticas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /metricas/queries/getUlGoalsByLogisticUnit: post: description: Busca as metas da unidade logistica pelo id da unidade tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – logisticUnitId properties: logisticUnitId: type: string description: Id da unidade logistica responses: 200: description: Ok schema: type: object required: – ulGoals properties: ulGoals: type: array items: type: object allOf: – #/definitions/unidadeLogisticaGoal minimum: 1 description: Metas da unidade logistica 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca as metas da unidade logistica pelo id da unidade tags: – Queries x-senior-visibility: PRIVATE parameters: – name: logisticUnitId description: Id da unidade logistica in: query required: true type: string responses: 200: description: Ok schema: type: object required: – ulGoals properties: ulGoals: type: array items: type: object allOf: – #/definitions/unidadeLogisticaGoal minimum: 1 description: Metas da unidade logistica 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /metricas/queries/countEmployeesWithoutActiveGoal: post: description: Retorna o número de colaboradores que não tenha meta ativa tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – total properties: total: type: integer format: int64 description: Valor total de colaboradores sem meta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o número de colaboradores que não tenha meta ativa tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – total properties: total: type: integer format: int64 description: Valor total de colaboradores sem meta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /metricas/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 /metricas/queries/exportOperadorMovimentacao: 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 /metricas/queries/exportUnidadeLogistica: 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 /metricas/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 /metricas/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 /metricas/queries/exportGoal: 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 /metricas/queries/exportGoalHistory: 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 /metricas/queries/exportUnidadeLogisticaGoal: 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 /metricas/queries/exportWorkshiftGoal: 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 /metricas/queries/exportEmployeeGoalView: 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 /metricas/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 /metricas/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 /metricas/actions/defineGoal: post: description: Define uma meta tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – perHour – perWorkshift – calculationType properties: perHour: type: integer format: int64 description: Meta por hora perWorkshift: type: integer format: int64 description: Meta por escala/turno calculationType: type: string allOf: – #/definitions/tipoCalculo description: Tipo de cálculo responses: 200: description: Ok schema: type: object required: – goalId properties: goalId: type: string description: Id da meta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /metricas/actions/customSaveUlGoal: post: description: Salva ul goal tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – unidadeLogisticaGoal – unidadeLogistica properties: unidadeLogisticaGoal: type: array items: type: object allOf: – #/definitions/unidadeLogisticaGoal minimum: 1 description: Lista de unidade logísticas goal unidadeLogistica: type: array items: type: object allOf: – #/definitions/unidadeLogistica minimum: 1 description: Lista de unidade logísticas responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Sucesso na execução 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /metricas/actions/saveEmployeeGoals: post: description: Salva uma nova meta por colaboradores tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – perHour – perWorkshift – calculationType properties: perHour: type: integer format: int64 description: Meta por hora perWorkshift: type: integer format: int64 description: Meta por escala/turno calculationType: type: string allOf: – #/definitions/tipoCalculo description: Tipo de cálculo employeeIds: type: array items: type: string description: Ids dos colaboradores startDate: type: string format: date description: Data de inicio responses: 200: description: Ok schema: type: object required: – success – numberOfEmployees properties: success: type: boolean description: Sucesso na execução numberOfEmployees: type: integer format: int64 description: Colaboradores vinculados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /metricas/actions/chatGptInsights: post: description: Integração com a openIa API tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – context – dataset properties: context: type: string allOf: – #/definitions/gptContext description: Grafico a ser analisado dataset: type: string maxLength: 3000 description: Conteudo do dataset em string question: type: string description: Pergunta feita pelo usuário responses: 200: description: Ok schema: type: object required: – answer properties: answer: type: string description: Resposta dos insights 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /metricas/actions/importOperadorMovimentacao: 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 /metricas/actions/importUnidadeLogistica: 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 /metricas/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 /metricas/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 /metricas/actions/importGoal: 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 /metricas/actions/importGoalHistory: 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 /metricas/actions/importUnidadeLogisticaGoal: 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 /metricas/actions/importWorkshiftGoal: 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 /metricas/actions/importEmployeeGoalView: 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 /metricas/signals/saveWorkshiftGoal: post: description: Define uma meta para a escala/turno tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – perHour – perWorkshift – calculationType – workshiftId – employeeIds properties: perHour: type: integer format: int64 description: Meta por hora perWorkshift: type: integer format: int64 description: Meta por escala/turno calculationType: type: string allOf: – #/definitions/tipoCalculo description: Tipo de cálculo workshiftId: type: string description: Id da escala/turno employeeIds: type: array items: type: string minimum: 1 description: Ids dos colaboradores responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /metricas/signals/linkEmployeeToGoal: post: description: Vincula um colaborador a uma meta tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – employeeId – workshiftId properties: employeeId: type: string description: Id do employee workshiftId: type: string description: Id da escala/turno do employee responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /metricas/signals/linkEmployeesToGoal: post: description: Vincula colaboradores a meta tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – employeeIds – workshiftId properties: employeeIds: type: array items: type: string minimum: 1 description: Ids dos employees workshiftId: type: string description: Id da escala/turno do employee responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /metricas/events/importOperadorMovimentacaoEvent: 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 /metricas/events/exportOperadorMovimentacaoEvent: 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 /metricas/events/importUnidadeLogisticaEvent: 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 /metricas/events/exportUnidadeLogisticaEvent: 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 /metricas/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 /metricas/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 /metricas/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 /metricas/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 /metricas/events/importGoalEvent: 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 /metricas/events/exportGoalEvent: 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 /metricas/events/importGoalHistoryEvent: 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 /metricas/events/exportGoalHistoryEvent: 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 /metricas/events/importUnidadeLogisticaGoalEvent: 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 /metricas/events/exportUnidadeLogisticaGoalEvent: 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 /metricas/events/importWorkshiftGoalEvent: 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 /metricas/events/exportWorkshiftGoalEvent: 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 /metricas/events/importEmployeeGoalViewEvent: 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 /metricas/events/exportEmployeeGoalViewEvent: 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 /metricas/entities/operadorMovimentacao: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/operadorMovimentacao responses: 200: description: The created resource schema: #/definitions/operadorMovimentacao 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/operadorMovimentacao responses: 200: description: The created resource schema: #/definitions/operadorMovimentacao 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: array items: #/definitions/operadorMovimentacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /metricas/entities/operadorMovimentacao/{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/operadorMovimentacao responses: 200: description: Ok schema: #/definitions/operadorMovimentacao 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/operadorMovimentacao responses: 200: description: Ok schema: #/definitions/operadorMovimentacao 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/operadorMovimentacao 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 /metricas/entities/operadorMovimentacao/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/operadorMovimentacao responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /metricas/entities/goal: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/goal responses: 200: description: The created resource schema: #/definitions/goal 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/goal responses: 200: description: The created resource schema: #/definitions/goal 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: array items: #/definitions/goal 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /metricas/entities/goal/{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/goal responses: 200: description: Ok schema: #/definitions/goal 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/goal responses: 200: description: Ok schema: #/definitions/goal 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/goal 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 /metricas/entities/goal/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/goal responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /metricas/entities/goalHistory: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/goalHistory responses: 200: description: The created resource schema: #/definitions/goalHistory 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/goalHistory responses: 200: description: The created resource schema: #/definitions/goalHistory 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: array items: #/definitions/goalHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /metricas/entities/goalHistory/{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/goalHistory responses: 200: description: Ok schema: #/definitions/goalHistory 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/goalHistory responses: 200: description: Ok schema: #/definitions/goalHistory 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/goalHistory 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 /metricas/entities/goalHistory/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/goalHistory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /metricas/entities/unidadeLogisticaGoal: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/unidadeLogisticaGoal responses: 200: description: The created resource schema: #/definitions/unidadeLogisticaGoal 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/unidadeLogisticaGoal responses: 200: description: The created resource schema: #/definitions/unidadeLogisticaGoal 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: array items: #/definitions/unidadeLogisticaGoal 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /metricas/entities/unidadeLogisticaGoal/{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/unidadeLogisticaGoal responses: 200: description: Ok schema: #/definitions/unidadeLogisticaGoal 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/unidadeLogisticaGoal responses: 200: description: Ok schema: #/definitions/unidadeLogisticaGoal 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/unidadeLogisticaGoal 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 /metricas/entities/unidadeLogisticaGoal/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/unidadeLogisticaGoal responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /metricas/entities/workshiftGoal: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/workshiftGoal responses: 200: description: The created resource schema: #/definitions/workshiftGoal 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/workshiftGoal responses: 200: description: The created resource schema: #/definitions/workshiftGoal 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: array items: #/definitions/workshiftGoal 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /metricas/entities/workshiftGoal/{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/workshiftGoal responses: 200: description: Ok schema: #/definitions/workshiftGoal 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/workshiftGoal responses: 200: description: Ok schema: #/definitions/workshiftGoal 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/workshiftGoal 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 /metricas/entities/workshiftGoal/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/workshiftGoal responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /metricas/entities/employeeGoalView: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/employeeGoalView responses: 200: description: The created resource schema: #/definitions/employeeGoalView 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/employeeGoalView responses: 200: description: The created resource schema: #/definitions/employeeGoalView 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: array items: #/definitions/employeeGoalView 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /metricas/entities/employeeGoalView/{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/employeeGoalView responses: 200: description: Ok schema: #/definitions/employeeGoalView 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/employeeGoalView responses: 200: description: Ok schema: #/definitions/employeeGoalView 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/employeeGoalView 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 /metricas/entities/employeeGoalView/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/employeeGoalView responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: tipoCalculo: description: Tipo de Cálculo/Métrica type: string enum: – PECA – PESO – CUBAGEM_VOLUMETRIA – QUANTIDADE_TAREFAS – LINHAS_EXPEDIDAS statusMeta: description: Situação da meta do operador type: string enum: – BOM – ALERTA – ATRASADO – SEM_META gptContext: description: Contextos para geração de insights para integração do chat gpt type: string enum: – DEFAULT – OVERVIEW – INSIGHTS_IMPROVEMENTS – TEST userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR healthcheckDTO: description: Status do healthcheck type: string enum: – UP – DOWN operadorMovimentacao: description: Movimentação do operador type: object required: – employee – data – volumeMovimentado – pesoMovimentado – pecaMovimentada – linhasExpedidasMovimentadas properties: id: type: string format: uuid description: Identificador único do registro employee: type: object allOf: – #/definitions/employee description: Empregado data: type: string format: date-time description: DataHora da movimentação volumeMovimentado: type: integer format: int64 description: Volume Movimentado pesoMovimentado: type: integer format: int64 description: Peso Movimentado pecaMovimentada: type: number format: double description: Peças Movimentadas linhasExpedidasMovimentadas: type: integer format: int64 description: Linhas expedidas movimentadas finalizada: type: boolean description: Operação finalizada default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: unidadeLogistica: description: Unidade Logística type: object required: – nome – code properties: id: type: string format: uuid description: Identificador único do registro nome: type: string description: Nome code: type: string description: Código de Integração deleted: type: boolean description: Indicação registro deletado default: false 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 da unidade Logistica type: object required: – name – hireDate properties: id: type: string format: uuid description: Identificador único do registro name: type: string description: Nome do Funcionário hireDate: type: string format: date description: Data de admissão dismissalDate: type: string format: date description: Data de desligamento unidadeLogistica: type: object allOf: – #/definitions/unidadeLogistica description: Unidade Logística createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: workshift: description: Escala/Turno de Trabalho type: object required: – code – shortName properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código shortName: type: string description: Nome createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: goal: description: Meta dos colaboradores type: object required: – perHour – perWorkshift – calculationType properties: id: type: string format: uuid description: Identificador único do registro perHour: type: integer format: int64 description: Meta por hora perWorkshift: type: integer format: int64 description: Meta por escala/turno calculationType: type: string allOf: – #/definitions/tipoCalculo description: Tipo de cálculo deleted: type: boolean description: Indicação registro deletado default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: goalHistory: description: Historico de metas type: object required: – goal – employee – startDate – endDate properties: id: type: string format: uuid description: Identificador único do registro goal: type: object allOf: – #/definitions/goal description: Meta do coloborador employee: type: object allOf: – #/definitions/employee description: Colaboradores startDate: type: string format: date description: Data de inicio endDate: type: string format: date description: Data final createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: unidadeLogisticaGoal: description: Meta das Unidades Logísticas type: object required: – status – percentualMinimo – percentualMaximo properties: id: type: string format: uuid description: Identificador único do registro unidadeLogistica: type: object allOf: – #/definitions/unidadeLogistica description: Unidade Logística status: type: string allOf: – #/definitions/statusMeta description: status percentualMinimo: type: integer format: int64 description: Início do intervalo percentualMaximo: type: integer format: int64 description: Fim do intervalo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: workshiftGoal: description: Meta padrão da escala/turno type: object required: – workshiftId – goalId properties: id: type: string format: uuid description: Identificador único do registro workshiftId: type: string description: Id da Escala/Turno vinculada goalId: type: string description: Id da Meta vinculada createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: employeeGoalView: description: View com a meta ativa do subordinado type: object required: – id – employee properties: id: type: string format: uuid description: ID do subordinado employee: type: object allOf: – #/definitions/employee description: Subordinado activeGoal: type: object allOf: – #/definitions/goalHistory description: Meta ativa por colaborador employeeGoal: description: Meta de um Operador type: object required: – workshiftGoal – hourGoal – workshiftTotal – hourTotal – status – calculationType properties: workshiftGoal: type: integer format: int64 description: Meta do Turno hourGoal: type: integer format: int64 description: Meta do Hora workshiftTotal: type: number format: double description: Total separado do Turno hourTotal: type: number format: double description: Total separado da Hora status: type: string allOf: – #/definitions/statusMeta description: Situação do turno calculationType: type: string allOf: – #/definitions/tipoCalculo description: Tipo de Meta currentEmployeeGoals: description: Metas type: object required: – id – goalId – employeeId – employeeName – perHour – perWorkshift – calculationType – startDate properties: id: type: string description: Id do historico de meta goalId: type: string description: Id da Meta employeeId: type: string description: Id do Colaborador employeeName: type: string description: Nome do colaborador perHour: type: integer format: int64 description: Meta por hora perWorkshift: type: integer format: int64 description: Meta por escala/turno calculationType: type: string allOf: – #/definitions/tipoCalculo description: Tipo de cálculo startDate: type: string format: date description: Data de inicio endDate: type: string format: date description: Data de inicio logisticUnitName: type: string description: Nome da unidade logistica workshiftName: type: string description: Nome da escala/turno simplifiedUlGoal: description: Metas das unidades logisticas type: object required: – id – logisticUnitId – logisticUnitName – createdDate – createdBy properties: id: type: string description: Id da meta logisticUnitId: type: string description: Id das unidade logistica logisticUnitName: type: string description: Nome da unidade logistica createdDate: type: string format: date description: Data de criação createdBy: type: string description: Criado por notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service checkDTO: description: Retorno status usados de retorno type: object required: – status – name properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status name: type: string description: Status genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE