2.0info: 3.0.0 HCM – Foundation Work Schedule description: HCM – Foundation Work Schedule x-senior-domain: HCM – Foundation x-senior-domain-path: hcm_foundation x-senior-service-path: work_schedule 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_foundationsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /work_schedule/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/heathcheckDTO 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/heathcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /work_schedule/queries/verifyIfWorkscheduleHasDependents: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – workscheduleId properties: workscheduleId: type: string maxLength: 36 description: responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: workscheduleId description: in: query required: true type: string maxLength: 36 responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /work_schedule/queries/getCompanyStructures: post: description: Busca os identificadores únicos de todas as estruturas históricas de uma empresa com base numa data de referencia. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – companyIds – referenceDate properties: companyIds: type: array items: type: string minimum: 1 description: Identificadores únicos das empresas referenceDate: type: string format: date description: Data de referência para a busca. structureTypes: type: array items: type: string allOf: – #/definitions/structureType description: Estruturas que serão trazidas. Caso nada seja informado, todas elas serão pesquisadas. responses: 200: description: Ok schema: type: object required: – result properties: result: type: array items: type: object allOf: – #/definitions/companyStructuresItem minimum: 1 description: Lista de estruturas das empresas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /work_schedule/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 /work_schedule/queries/exportWorkschedule: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /work_schedule/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 /work_schedule/queries/exportWorkshiftDetails: 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 /work_schedule/queries/exportWorkshiftGroup: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /work_schedule/queries/exportWorkscheduleWorkshift: 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 /work_schedule/queries/exportWorkscheduleClockingRegister: 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 /work_schedule/queries/exportWorkshiftStructure: 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 /work_schedule/queries/exportWorkshiftStructureCompanyHistory: 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 /work_schedule/queries/exportHolidayGroup: 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 /work_schedule/queries/exportHoliday: 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 /work_schedule/queries/exportE070emp: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /work_schedule/queries/exportExclusionProcess: 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 /work_schedule/queries/exportExclusionProcessStepGroup: 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 /work_schedule/queries/exportExclusionProcessStep: 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 /work_schedule/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 /work_schedule/actions/saveWorkScheduleClockingRegisters: post: description: Endponit para salvar as operações da tela de marcações do horário tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – workscheduleId properties: workscheduleId: type: string description: Identificador único do horário entitiesToSaveOrUpdate: type: array items: type: object allOf: – #/definitions/workScheduleClockingRegisterDTO description: Marcações do horário para serem inseridas ou atualizadas responses: 200: description: Ok schema: type: object required: – savedEntities properties: savedEntities: type: array items: type: object allOf: – #/definitions/workScheduleClockingRegisterDTO minimum: 1 description: Marcações do horário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /work_schedule/actions/saveOrUpdateAllWorkScheduleWorkShift: post: description: Endpoint para salvar as operações da tela de horarios da escala tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – workshiftId properties: workshiftId: type: string maxLength: 36 description: Identificador da escala data: type: array items: type: object allOf: – #/definitions/workscheduleWorkshiftBatchPayload description: Payload com as informações dos horários da escala e seus horarios de busca automática responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /work_schedule/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /work_schedule/actions/importWorkschedule: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /work_schedule/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 /work_schedule/actions/importWorkshiftDetails: 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 /work_schedule/actions/importWorkshiftGroup: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /work_schedule/actions/importWorkscheduleWorkshift: 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 /work_schedule/actions/importWorkscheduleClockingRegister: 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 /work_schedule/actions/importWorkshiftStructure: 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 /work_schedule/actions/importWorkshiftStructureCompanyHistory: 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 /work_schedule/actions/importHolidayGroup: 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 /work_schedule/actions/importHoliday: 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 /work_schedule/actions/importE070emp: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /work_schedule/actions/importExclusionProcess: 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 /work_schedule/actions/importExclusionProcessStepGroup: 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 /work_schedule/actions/importExclusionProcessStep: 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 /work_schedule/signals/startExclusionProcess: post: description: Inicia um processo de exclusão tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – pid properties: pid: type: string description: Id do Processo responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /work_schedule/signals/fixWorkshiftStructureMigration: post: description: tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /work_schedule/events/exclusionProcessStatusChanged: post: description: Evento responsável por informar mudança no status do processo de exclusão. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – pid – entityName – recordId – description – status properties: pid: type: string description: Identificador do process de exclusão entityName: type: string description: Nome da entidade recordId: type: string description: Identificador do registro description: type: string description: Descrição do registro status: type: string allOf: – #/definitions/exclusionProcessStatus description: Status responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /work_schedule/events/importWorkscheduleEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /work_schedule/events/exportWorkscheduleEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /work_schedule/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 /work_schedule/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 /work_schedule/events/importWorkshiftDetailsEvent: 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 /work_schedule/events/exportWorkshiftDetailsEvent: 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 /work_schedule/events/importWorkshiftGroupEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /work_schedule/events/exportWorkshiftGroupEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /work_schedule/events/importWorkscheduleWorkshiftEvent: 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 /work_schedule/events/exportWorkscheduleWorkshiftEvent: 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 /work_schedule/events/importWorkscheduleClockingRegisterEvent: 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 /work_schedule/events/exportWorkscheduleClockingRegisterEvent: 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 /work_schedule/events/importWorkshiftStructureEvent: 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 /work_schedule/events/exportWorkshiftStructureEvent: 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 /work_schedule/events/importWorkshiftStructureCompanyHistoryEvent: 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 /work_schedule/events/exportWorkshiftStructureCompanyHistoryEvent: 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 /work_schedule/events/importHolidayGroupEvent: 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 /work_schedule/events/exportHolidayGroupEvent: 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 /work_schedule/events/importHolidayEvent: 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 /work_schedule/events/exportHolidayEvent: 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 /work_schedule/events/importE070empEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /work_schedule/events/exportE070empEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /work_schedule/events/importExclusionProcessEvent: 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 /work_schedule/events/exportExclusionProcessEvent: 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 /work_schedule/events/importExclusionProcessStepGroupEvent: 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 /work_schedule/events/exportExclusionProcessStepGroupEvent: 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 /work_schedule/events/importExclusionProcessStepEvent: 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 /work_schedule/events/exportExclusionProcessStepEvent: 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 /work_schedule/entities/workschedule: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/workschedule responses: 200: description: The created resource schema: #/definitions/workschedule 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/workschedule responses: 200: description: The created resource schema: #/definitions/workschedule 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/workschedule 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /work_schedule/entities/workschedule/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editWorkschedule responses: 200: description: Ok schema: #/definitions/editWorkschedule 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/workschedule responses: 200: description: Ok schema: #/definitions/workschedule 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/workschedule 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /work_schedule/entities/workschedule/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/workschedule responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /work_schedule/entities/workshift: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/workshift responses: 200: description: The created resource schema: #/definitions/workshift 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/workshift responses: 200: description: The created resource schema: #/definitions/workshift 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/workshift 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /work_schedule/entities/workshift/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editWorkshift responses: 200: description: Ok schema: #/definitions/editWorkshift 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/workshift responses: 200: description: Ok schema: #/definitions/workshift 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/workshift 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /work_schedule/entities/workshift/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/workshift responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /work_schedule/entities/workshiftDetails: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/workshiftDetails responses: 200: description: The created resource schema: #/definitions/workshiftDetails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/workshiftDetails responses: 200: description: The created resource schema: #/definitions/workshiftDetails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/workshiftDetails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /work_schedule/entities/workshiftDetails/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editWorkshiftDetails responses: 200: description: Ok schema: #/definitions/editWorkshiftDetails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/workshiftDetails responses: 200: description: Ok schema: #/definitions/workshiftDetails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/workshiftDetails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /work_schedule/entities/workshiftDetails/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/workshiftDetails responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /work_schedule/entities/workshiftGroup: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/workshiftGroup responses: 200: description: The created resource schema: #/definitions/workshiftGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/workshiftGroup responses: 200: description: The created resource schema: #/definitions/workshiftGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/workshiftGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /work_schedule/entities/workshiftGroup/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editWorkshiftGroup responses: 200: description: Ok schema: #/definitions/editWorkshiftGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/workshiftGroup responses: 200: description: Ok schema: #/definitions/workshiftGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/workshiftGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /work_schedule/entities/workshiftGroup/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/workshiftGroup responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /work_schedule/entities/workscheduleWorkshift: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/workscheduleWorkshift responses: 200: description: The created resource schema: #/definitions/workscheduleWorkshift 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/workscheduleWorkshift responses: 200: description: The created resource schema: #/definitions/workscheduleWorkshift 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/workscheduleWorkshift 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /work_schedule/entities/workscheduleWorkshift/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editWorkscheduleWorkshift responses: 200: description: Ok schema: #/definitions/editWorkscheduleWorkshift 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/workscheduleWorkshift responses: 200: description: Ok schema: #/definitions/workscheduleWorkshift 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/workscheduleWorkshift 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /work_schedule/entities/workscheduleWorkshift/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/workscheduleWorkshift responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /work_schedule/entities/workscheduleClockingRegister: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/workscheduleClockingRegister responses: 200: description: The created resource schema: #/definitions/workscheduleClockingRegister 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/workscheduleClockingRegister responses: 200: description: The created resource schema: #/definitions/workscheduleClockingRegister 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/workscheduleClockingRegister 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /work_schedule/entities/workscheduleClockingRegister/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editWorkscheduleClockingRegister responses: 200: description: Ok schema: #/definitions/editWorkscheduleClockingRegister 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/workscheduleClockingRegister responses: 200: description: Ok schema: #/definitions/workscheduleClockingRegister 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/workscheduleClockingRegister 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /work_schedule/entities/workscheduleClockingRegister/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/workscheduleClockingRegister responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /work_schedule/entities/workshiftStructure: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/workshiftStructure responses: 200: description: The created resource schema: #/definitions/workshiftStructure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/workshiftStructure responses: 200: description: The created resource schema: #/definitions/workshiftStructure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/workshiftStructure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /work_schedule/entities/workshiftStructure/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editWorkshiftStructure responses: 200: description: Ok schema: #/definitions/editWorkshiftStructure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/workshiftStructure responses: 200: description: Ok schema: #/definitions/workshiftStructure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/workshiftStructure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /work_schedule/entities/workshiftStructure/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/workshiftStructure responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /work_schedule/entities/workshiftStructureCompanyHistory: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/workshiftStructureCompanyHistory responses: 200: description: The created resource schema: #/definitions/workshiftStructureCompanyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/workshiftStructureCompanyHistory responses: 200: description: The created resource schema: #/definitions/workshiftStructureCompanyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/workshiftStructureCompanyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /work_schedule/entities/workshiftStructureCompanyHistory/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editWorkshiftStructureCompanyHistory responses: 200: description: Ok schema: #/definitions/editWorkshiftStructureCompanyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/workshiftStructureCompanyHistory responses: 200: description: Ok schema: #/definitions/workshiftStructureCompanyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/workshiftStructureCompanyHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /work_schedule/entities/workshiftStructureCompanyHistory/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/workshiftStructureCompanyHistory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /work_schedule/entities/exclusionProcess: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/exclusionProcess 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /work_schedule/entities/exclusionProcessStepGroup: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/exclusionProcessStepGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /work_schedule/entities/exclusionProcess/{parentId}/groups: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/exclusionProcessStepGroup responses: 200: description: The created resources schema: type: array items: #/definitions/exclusionProcessStepGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/exclusionProcessStepGroup responses: 200: description: The created resources schema: type: array items: #/definitions/exclusionProcessStepGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/exclusionProcessStepGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /work_schedule/entities/exclusionProcess/{parentId}/groups/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editExclusionProcessStepGroup responses: 200: description: Ok schema: #/definitions/editExclusionProcessStepGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/exclusionProcessStepGroup responses: 200: description: Ok schema: #/definitions/exclusionProcessStepGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/exclusionProcessStepGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /work_schedule/entities/exclusionProcessStep: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/exclusionProcessStep 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /work_schedule/entities/exclusionProcessStepGroup/{parentId}/steps: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/exclusionProcessStep responses: 200: description: The created resources schema: type: array items: #/definitions/exclusionProcessStep 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/exclusionProcessStep responses: 200: description: The created resources schema: type: array items: #/definitions/exclusionProcessStep 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/exclusionProcessStep 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /work_schedule/entities/exclusionProcessStepGroup/{parentId}/steps/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editExclusionProcessStep responses: 200: description: Ok schema: #/definitions/editExclusionProcessStep 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/exclusionProcessStep responses: 200: description: Ok schema: #/definitions/exclusionProcessStep 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/exclusionProcessStep 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: heathcheckDTO: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Saudável * `DOWN` – Ruim timeShiftType: type: string enum: – FIRSTSHIFT – SECONDSHIFT – THIRDSHIFT – FOURTHSHIFT – MIXEDDAYTIME – MIXEDNIGHTTIME – GENERAL description: Turno do horário: * `FIRSTSHIFT` – 1º Turno * `SECONDSHIFT` – 2º Turno * `THIRDSHIFT` – 3º Turno * `FOURTHSHIFT` – 4º Turno * `MIXEDDAYTIME` – Misto predominante diurno * `MIXEDNIGHTTIME` – Misto predominante noturno * `GENERAL` – Geral exclusionProcessStatus: type: string enum: – PENDING – PROCESSING – ERROR – SUCCESS description: Status do processo de exclusão: * `PENDING` – Pendente * `PROCESSING` – Processando * `ERROR` – Erro * `SUCCESS` – Sucesso workshiftType: type: string enum: – PERMANENT – AUTOMATIC_SEARCH – DEFINED – AUTOMATIC_GENERATION – INTERMITTENT description: Tipo de escala: * `PERMANENT` – Permanente * `AUTOMATIC_SEARCH` – Busca automática * `DEFINED` – Definida * `AUTOMATIC_GENERATION` – Geração Automática * `INTERMITTENT` – Jornada Intermitente scheduleType: type: string enum: – RIGID – MOBILE – FLEXIBLE – MOBILE_ENTRANCE_EXIT – MOBILE_MEAL – FLEXIBLE_AT_INTERVALS description: Tipo de horário: * `RIGID` – Rígido * `MOBILE` – Móvel * `FLEXIBLE` – Flexível * `MOBILE_ENTRANCE_EXIT` – Misto – Móvel na entrada e saída * `MOBILE_MEAL` – Misto – Móvel na refeição * `FLEXIBLE_AT_INTERVALS` – Flexível nos intervalos holidayType: type: string enum: – OWN – BRANCH – NONE description: Tipo de feriado: * `OWN` – Feriado próprio * `BRANCH` – Feriado da filial * `NONE` – Não tem feriado usingType: type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 – V9 – V12 – V13 – V14 description: Uso da marcação: * `V1` – 1 – Entrada ou saída obrigatória * `V2` – 2 – Entrada ou saída não obrigatória * `V3` – 3 – Entrada ou saída gerada * `V4` – 4 – Refeição obrigatória * `V5` – 5 – Refeição pré-assinalada não obrigatória * `V6` – 6 – Refeição obrigatória, extra * `V9` – 9 – Refeição pré-assinalada gerada * `V12` – 12 – Lanche obrigatório * `V13` – 13 – Lanche não obrigatório * `V14` – 14 – Lanche obrigatório, extra workShiftJourneyType: type: string enum: – ON_ENTER – ON_LEAVE description: Tipo de jornada de horário: * `ON_ENTER` – Pela Entrada * `ON_LEAVE` – Pela Saída mealTimeType: type: string enum: – PROXIMITY_OF_MEAL_TIME – CONSIDER_ALL_INTERVALS description: Tipo do cálculo da refeição móvel: * `PROXIMITY_OF_MEAL_TIME` – Pela proximidade do tempo de refeição previsto * `CONSIDER_ALL_INTERVALS` – Considerar todo os intervalos missingHoursCalculationType: type: string enum: – AFTER_BUSINESS_TIME – OVER_BUSINESS_TIME description: Calcular faltas: * `AFTER_BUSINESS_TIME` – Somente no final do expediente * `OVER_BUSINESS_TIME` – Durante o expediente accessLevelCalculationType: type: string enum: – START_FINISH_SAME_DAY – START_FINISH_DIFFERENT_DAY description: Cálculo faixa horária de acesso: * `START_FINISH_SAME_DAY` – Inicia e finaliza no mesmo dia * `START_FINISH_DIFFERENT_DAY` – Inicia e finaliza em dias distintos workShifIntervalType: type: string enum: – INTERVAL_ON_FIXED_WORKSHIFT – INTERVAL_ON_VARIABLE_WORKSHIFT – NO_INTERVAL description: Tipo de intervalo da jornada: * `INTERVAL_ON_FIXED_WORKSHIFT` – Intervalo em horário fixo * `INTERVAL_ON_VARIABLE_WORKSHIFT` – Intervalo em horário Variável * `NO_INTERVAL` – Sem intervalo clockingEventUseType: type: string enum: – ENTER_LEAVE_REQUIRED – ENTER_LEAVE_NOT_REQUIRED – ENTER_LEAVE_GENERATED – MEAL_REQUIRED – MEAL_NOT_REQUIRED – MEAL_REQUIRED_EXTRA – MEAL_NOT_REQUIRED_DEFINE_TOLERANCE – MEAL_GENERATED – LUNCH_REQUIRED – LUNCH_NOT_REQUIRED – LUNCH_REQUIRED_EXTRA description: Uso da marcação: * `ENTER_LEAVE_REQUIRED` – Entrada/Saída obrigatória * `ENTER_LEAVE_NOT_REQUIRED` – Entrada/Saída não obrigatória * `ENTER_LEAVE_GENERATED` – Entrada/Saída gerada * `MEAL_REQUIRED` – Refeição obrigatória * `MEAL_NOT_REQUIRED` – Refeição não obrigatória * `MEAL_REQUIRED_EXTRA` – Refeição obrigatória, extra * `MEAL_NOT_REQUIRED_DEFINE_TOLERANCE` – Refeição não obrigatória, definir tolerância * `MEAL_GENERATED` – Refeição gerada * `LUNCH_REQUIRED` – Lance obrigatório * `LUNCH_NOT_REQUIRED` – Lance não obrigatório * `LUNCH_REQUIRED_EXTRA` – Lance obrigatório, extra structureType: type: string enum: – WORKSHIFT_STRUCTURE description: Tipo de estrutura: * `WORKSHIFT_STRUCTURE` – Estrutura de escala workscheduleDefinitionType: type: string enum: – NORMAL – DAYOFF – HOLIDAY – OFFSET – DSR description: Tipo de Horário: * `NORMAL` – Normal * `DAYOFF` – Folga * `HOLIDAY` – Feriado * `OFFSET` – Compensado * `DSR` – DSR userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error checkDTO: description: Retorno status usados de retorno type: object required: – name – status properties: name: type: string description: Nome do status status: type: string allOf: – #/definitions/heathcheckDTO description: Status workScheduleClockingRegisterDTO: description: DTO para a entidade marcações do horário type: object required: – usingType – sequenceEvent – clockingEvent properties: id: type: string description: Identificador único usingType: type: string allOf: – #/definitions/usingType description: Uso da marcação sequenceEvent: type: integer format: int64 description: Sequência da marcação clockingEvent: type: integer format: int64 description: Hora da marcação toleranceBefore: type: integer format: int64 description: Tolerância antes toleranceAfter: type: integer format: int64 description: Tolerância depois clockingEventMobility: type: integer format: int64 description: Mobilidade da marcação workscheduleWorkshiftDTO: description: DTO para a entidade horário de Escala type: object required: – workshift – registerSequence – workschedule properties: id: type: string description: Identificador único workshift: type: string description: Escala registerSequence: type: integer format: int64 description: Sequência do registro workschedule: type: string description: Horário automaticSearchWorkscheduleDTO: description: DTO para a entidade Horario de busca automática type: object required: – registerSequence – workschedule properties: id: type: string maxLength: 36 description: Identificador único workscheduleWorkshift: type: string maxLength: 36 description: Horário da escala registerSequence: type: integer format: int64 description: Sequência do registro workschedule: type: string description: Horario workscheduleWorkshiftBatchPayload: description: Objeto para salvamento em lote da entidade Horario da escala e seus Horarios de busca automática type: object required: – workscheduleWorkshift properties: workscheduleWorkshift: type: object allOf: – #/definitions/workscheduleWorkshiftDTO description: Horario da escala automaticSearchWorkschedules: type: array items: type: object allOf: – #/definitions/automaticSearchWorkscheduleDTO description: Horarios de busca automática companyStructuresItem: description: Estruturas da empresa type: object required: – companyId – structures properties: companyId: type: string description: Identificador único da empresa structures: type: array items: type: object allOf: – #/definitions/structureItem minimum: 1 description: Estruturas structureItem: description: Estrutura type: object required: – structureType – structureId properties: structureType: type: string allOf: – #/definitions/structureType description: Tipo da estrutura structureId: type: string description: Identificador único da estrutura workschedule: description: Horário type: object required: – code – name – workscheduleDefinitionType properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código minimum: 1 name: type: string description: Descrição horário x-i18n: true workscheduleDefinitionType: type: string allOf: – #/definitions/workscheduleDefinitionType description: Tipo de Horário initialValidity: type: string format: date description: Data de criação finalValidity: type: string format: date description: Data de extinção scheduleType: type: string allOf: – #/definitions/scheduleType description: Tipo de horário workload: type: integer format: int64 description: Carga horária\n(Campo gerenciado internamente) deleted: type: boolean description: Indicativo de exclusão do registro default: false externalId: type: string maxLength: 255 description: Identificador externo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: name: type: string example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. editWorkschedule: type: object required: – id allOf: – #/definitions/workschedule workshift: description: Escala type: object required: – code – name – workshiftType – workshiftStructure – dsrMinutes – weekMinutes – monthMinutes – timeShiftType properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código minimum: 1 maximum: 999999999 name: type: string maxLength: 255 description: Descrição x-i18n: true workshiftType: type: string allOf: – #/definitions/workshiftType description: Tipo de escala workshiftStructure: type: object allOf: – #/definitions/workshiftStructure description: Estrutura de escala initialValidity: type: string format: date description: Data de criação finalValidity: type: string format: date description: Data de extinção dsrMinutes: type: integer format: int64 description: Horas DSR maximum: 5999 weekMinutes: type: integer format: int64 description: Horas semana maximum: 59999 monthMinutes: type: integer format: int64 description: Hora mês maximum: 59999 timeShiftType: type: string allOf: – #/definitions/timeShiftType description: Turno da escala deleted: type: boolean description: Indicativo de exclusão do registro default: false externalId: type: string maxLength: 255 description: Identificador externo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: name: type: string maxLength: 255 example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. editWorkshift: type: object required: – id allOf: – #/definitions/workshift workshiftDetails: description: Configuração da escala type: object required: – startDate – holidayType – workshift properties: id: type: string format: uuid description: Identificador único startDate: type: string format: date description: Data inicio holidayType: type: string allOf: – #/definitions/holidayType description: Tipo de feriado holidayGroup: type: object allOf: – #/definitions/holidayGroup description: Tabela de feriados workshift: type: object allOf: – #/definitions/workshift description: Escala endDate: type: string format: date description: Data fim externalId: type: string maxLength: 255 description: Identificador externo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editWorkshiftDetails: type: object required: – id allOf: – #/definitions/workshiftDetails workshiftGroup: description: Turma de escala type: object required: – workshift – code – baseDate properties: id: type: string format: uuid description: Identificador único workshift: type: object allOf: – #/definitions/workshift description: Escala code: type: integer format: int64 description: Código minimum: 1 maximum: 8 baseDate: type: string format: date description: Data base da turma deleted: type: boolean description: Identificador de exclusão do registro default: false externalId: type: string maxLength: 255 description: Identificador externo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editWorkshiftGroup: type: object required: – id allOf: – #/definitions/workshiftGroup workscheduleWorkshift: description: Horário de Escala type: object required: – workshift – registerSequence – workschedule properties: id: type: string format: uuid description: Identificador único workshift: type: object allOf: – #/definitions/workshift description: Escala registerSequence: type: integer format: int64 description: Sequência do registro minimum: 0 maximum: 99 workschedule: type: object allOf: – #/definitions/workschedule description: Horário externalId: type: string maxLength: 255 description: Identificador externo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editWorkscheduleWorkshift: type: object required: – id allOf: – #/definitions/workscheduleWorkshift workscheduleClockingRegister: description: Marcação horário type: object required: – workschedule – sequenceEvent – usingType – clockingEvent properties: id: type: string format: uuid description: Identificador único workschedule: type: object allOf: – #/definitions/workschedule description: Horário sequenceEvent: type: integer format: int64 description: Sequência da marcação usingType: type: string allOf: – #/definitions/usingType description: Uso da marcação clockingEvent: type: integer format: int64 description: Hora da marcação minimum: 0 maximum: 99999 toleranceBefore: type: integer format: int64 description: Tolerância antes toleranceAfter: type: integer format: int64 description: Tolerância depois clockingEventMobility: type: integer format: int64 description: Mobilidade da marcação externalId: type: string maxLength: 255 description: Identificador externo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editWorkscheduleClockingRegister: type: object required: – id allOf: – #/definitions/workscheduleClockingRegister workshiftStructure: description: Estrutura de escala type: object required: – code – name properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código minimum: 1 name: type: string maxLength: 255 description: Descrição x-i18n: true createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: name: type: string maxLength: 255 example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. editWorkshiftStructure: type: object required: – id allOf: – #/definitions/workshiftStructure workshiftStructureCompanyHistory: description: Histórico de estruturas de escala da empresa type: object required: – company – workshiftStructure – startDate properties: id: type: string format: uuid description: Identificador único company: type: object allOf: – #/definitions/e070emp description: Empresa workshiftStructure: type: object allOf: – #/definitions/workshiftStructure description: Estrutura de escala startDate: type: string format: date description: Data de início endDate: type: string format: date description: Data de término externalId: type: string maxLength: 255 description: Identificador externo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editWorkshiftStructureCompanyHistory: type: object required: – id allOf: – #/definitions/workshiftStructureCompanyHistory holidayGroup: description: Tabela de feriados type: object required: – code – name properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código name: type: string description: Nome externalId: type: string maxLength: 255 description: Identificador externo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: holiday: description: Feriado type: object required: – name – holidayDate – holidayGroup properties: id: type: string format: uuid description: Identificador único name: type: string description: Nome x-i18n: true holidayDate: type: string format: date description: Data do feriado holidayGroup: type: object allOf: – #/definitions/holidayGroup description: Tabela de feriados createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: translations: type: object properties: locale: type: object properties: name: type: string example: pt-BR: name: Exemplo de texto usando locale pt-BR. en-US: name: Text example using en-US locale. e070emp: description: Empresa type: object required: – codEmp – nomEmp – sigEmp – extIntSts properties: id: type: string format: uuid description: Identificador único codEmp: type: integer format: int64 description: Código minimum: 0 maximum: 9999 nomEmp: type: string maxLength: 100 description: Nome sigEmp: type: string maxLength: 100 description: Nome fantasia excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação externalId: type: string maxLength: 255 description: Identificador externo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: exclusionProcess: description: Exclusion Process type: object required: – entityName – recordId – description – status properties: id: type: string format: uuid description: Exclusion process id entityName: type: string description: Entity name recordId: type: string description: Record id description: type: string description: Description status: type: string allOf: – #/definitions/exclusionProcessStatus description: Status startDate: type: string format: date-time description: Start date finishDate: type: string format: date-time description: Finish date errorMessage: type: string description: Error message groups: type: array items: type: object allOf: – #/definitions/exclusionProcessStepGroup description: Step groups createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: exclusionProcessStepGroup: description: Exclusion Process Step Group type: object required: – description – status properties: id: type: string format: uuid description: Exclusion step group id exclusionProcess: type: object allOf: – #/definitions/exclusionProcess description: Exclusion process description: type: string description: Description status: type: string allOf: – #/definitions/exclusionProcessStatus description: Status errorMessage: type: string description: Error message errorDetail: type: string description: Error detail startDate: type: string format: date-time description: Start date finishDate: type: string format: date-time description: Finish date steps: type: array items: type: object allOf: – #/definitions/exclusionProcessStep description: Steps createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editExclusionProcessStepGroup: type: object required: – id allOf: – #/definitions/exclusionProcessStepGroup exclusionProcessStep: description: Exclusion Process Step type: object required: – description – status properties: id: type: string format: uuid description: Exclusion step id stepGroup: type: object allOf: – #/definitions/exclusionProcessStepGroup description: Step group description: type: string description: Description status: type: string allOf: – #/definitions/exclusionProcessStatus description: Status startDate: type: string format: date-time description: Start date finishDate: type: string format: date-time description: Finish date errorMessage: type: string description: Error message errorDetail: type: string description: Error detail created_by: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editExclusionProcessStep: type: object required: – id allOf: – #/definitions/exclusionProcessStep 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