2.0info: 1.2.2 pontomobile_bff description: Ponto Mobile BFF x-senior-domain: hcm x-senior-domain-path: hcm x-senior-service-path: pontomobile_bff 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/hcmsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /pontomobile_bff/queries/getEmployeeClockingConfigQuery: post: description: Retorna a configuração de ponto do colaborador tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – employeeClockingConfig properties: employeeClockingConfig: type: object allOf: – #/definitions/employeeClockingConfig description: Configuração de marcação do colaborador 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a configuração de ponto do colaborador tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – employeeClockingConfig properties: employeeClockingConfig: type: object allOf: – #/definitions/employeeClockingConfig description: Configuração de marcação do colaborador 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pontomobile_bff/queries/getHLBQuery: post: description: Retorna a Hora Legal Brasileira, através da busca do NTP do ntp.br tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – hlbTime – defaultTimezone properties: hlbTime: type: integer format: int64 description: Hora Legal Brasileira defaultTimezone: type: string description: Timezone default: description: Error response schema: #/definitions/genericError get: description: Retorna a Hora Legal Brasileira, através da busca do NTP do ntp.br tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – hlbTime – defaultTimezone properties: hlbTime: type: integer format: int64 description: Hora Legal Brasileira defaultTimezone: type: string description: Timezone default: description: Error response schema: #/definitions/genericError /pontomobile_bff/queries/listFenceEmployeesQuery: post: description: Retorna, paginado e ordenado por nome, os colaboradores vinculados a uma cerca tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fenceId – page – pageSize properties: fenceId: type: string description: Identificador da cerca name: type: string description: Filtro de nome (contém) sortDirection: type: string allOf: – #/definitions/sortDirectionType description: Direção da ordenação por nome page: type: integer format: int64 description: Número da página (zero-based) pageSize: type: integer format: int64 description: Tamanho da página responses: 200: description: Ok schema: type: object required: – employeesPage properties: employeesPage: type: object allOf: – #/definitions/fenceEmployeesPage description: Lista paginada de colaboradores 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna, paginado e ordenado por nome, os colaboradores vinculados a uma cerca tags: – Queries x-senior-visibility: PRIVATE parameters: – name: fenceId description: Identificador da cerca in: query required: true type: string – name: name description: Filtro de nome (contém) in: query type: string – name: sortDirection description: Direção da ordenação por nome in: query type: string allOf: – #/definitions/sortDirectionType – name: page description: Número da página (zero-based) in: query required: true type: integer format: int64 – name: pageSize description: Tamanho da página in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – employeesPage properties: employeesPage: type: object allOf: – #/definitions/fenceEmployeesPage description: Lista paginada de colaboradores 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pontomobile_bff/queries/listModelByFenceQuery: post: description: Retorna, paginado e ordenado por codigo, os modelos vinculados a uma cerca tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fenceId properties: fenceId: type: string description: Identificador da cerca page: type: integer format: int64 description: Número da página (zero-based) default: 0 pageSize: type: integer format: int64 description: Tamanho da página default: 10 responses: 200: description: Ok schema: type: object required: – modelsPage properties: modelsPage: type: object allOf: – #/definitions/fenceModelsPage description: Lista paginada de modelos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna, paginado e ordenado por codigo, os modelos vinculados a uma cerca tags: – Queries x-senior-visibility: PRIVATE parameters: – name: fenceId description: Identificador da cerca in: query required: true type: string – name: page description: Número da página (zero-based) in: query type: integer format: int64 – name: pageSize description: Tamanho da página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – modelsPage properties: modelsPage: type: object allOf: – #/definitions/fenceModelsPage description: Lista paginada de modelos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pontomobile_bff/queries/geoPlacesAutocomplete: post: description: Busca sugestões de endereço baseado no texto de consulta tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – queryText properties: queryText: type: string description: Texto de consulta para autocompletar responses: 200: description: Ok schema: type: object required: – results properties: results: type: array items: type: object allOf: – #/definitions/geoPlacesSuggestionDTO minimum: 1 description: Lista de resultados do autocomplete 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca sugestões de endereço baseado no texto de consulta tags: – Queries x-senior-visibility: PRIVATE parameters: – name: queryText description: Texto de consulta para autocompletar in: query required: true type: string responses: 200: description: Ok schema: type: object required: – results properties: results: type: array items: type: object allOf: – #/definitions/geoPlacesSuggestionDTO minimum: 1 description: Lista de resultados do autocomplete 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pontomobile_bff/queries/geoPlacesGetPlace: post: description: Obtém detalhes de um local pelo seu identificador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – placeId properties: placeId: type: string description: Identificador do local responses: 200: description: Ok schema: type: object required: – place properties: place: type: object allOf: – #/definitions/geoPlacesPlaceDTO description: Detalhes do local 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém detalhes de um local pelo seu identificador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: placeId description: Identificador do local in: query required: true type: string responses: 200: description: Ok schema: type: object required: – place properties: place: type: object allOf: – #/definitions/geoPlacesPlaceDTO description: Detalhes do local 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pontomobile_bff/queries/geoPlacesGeocode: post: description: Converte um endereço em coordenadas geográficas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – queryText properties: queryText: type: string description: Texto do endereço para geocodificação responses: 200: description: Ok schema: type: object required: – results properties: results: type: array items: type: object allOf: – #/definitions/geoPlacesResultDTO minimum: 1 description: Lista de resultados da geocodificação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Converte um endereço em coordenadas geográficas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: queryText description: Texto do endereço para geocodificação in: query required: true type: string responses: 200: description: Ok schema: type: object required: – results properties: results: type: array items: type: object allOf: – #/definitions/geoPlacesResultDTO minimum: 1 description: Lista de resultados da geocodificação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pontomobile_bff/queries/geoPlacesReverseGeocode: post: description: Converte coordenadas geográficas em um endereço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – longitude – latitude properties: longitude: type: number format: double description: Longitude latitude: type: number format: double description: Latitude responses: 200: description: Ok schema: type: object required: – results properties: results: type: array items: type: object allOf: – #/definitions/geoPlacesReverseResultDTO minimum: 1 description: Lista de resultados da geocodificação reversa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Converte coordenadas geográficas em um endereço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: longitude description: Longitude in: query required: true type: number format: double – name: latitude description: Latitude in: query required: true type: number format: double responses: 200: description: Ok schema: type: object required: – results properties: results: type: array items: type: object allOf: – #/definitions/geoPlacesReverseResultDTO minimum: 1 description: Lista de resultados da geocodificação reversa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pontomobile_bff/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 /pontomobile_bff/queries/exportHeadQuarter: 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 /pontomobile_bff/queries/exportCostCenter: 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 /pontomobile_bff/queries/exportCompany: 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 /pontomobile_bff/queries/exportConfiguration: 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 /pontomobile_bff/queries/exportEmployee: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pontomobile_bff/queries/exportPlatformUsers: 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 /pontomobile_bff/queries/exportClockingEventUse: 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 /pontomobile_bff/queries/exportPushReminder: 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 /pontomobile_bff/queries/exportReminder: 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 /pontomobile_bff/queries/exportFence: 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 /pontomobile_bff/queries/exportPerimeter: 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 /pontomobile_bff/queries/exportLocation: 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 /pontomobile_bff/queries/exportModel: 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 /pontomobile_bff/queries/exportManager: 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 /pontomobile_bff/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 /pontomobile_bff/queries/healthcheck: post: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pontomobile_bff/actions/isManagerOfAllFenceEmployees: post: description: Verifica se o usuário logado é gestor de todos os colaboradores da cerca tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fenceId properties: fenceId: type: string description: Identificador da cerca responses: 200: description: Ok schema: type: object required: – isManager properties: isManager: type: boolean description: Indica se o usuário logado é gestor de todos os colaboradores 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pontomobile_bff/actions/linkEmployeeToFence: post: description: Vincula um colaborador a uma cerca tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fenceId – employeeId properties: fenceId: type: string description: Identificador da cerca employeeId: type: string description: Identificador do colaborador responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Indica se o vínculo foi realizado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pontomobile_bff/actions/unlinkEmployeeFromFence: post: description: Remove a vinculação de um colaborador a uma cerca tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fenceId – employeeId properties: fenceId: type: string description: Identificador da cerca employeeId: type: string description: Identificador do colaborador responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Indica se o vínculo foi removido 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pontomobile_bff/actions/linkAllEmployeesToFence: post: description: Vincula a cerca todos os colaboradores que atendem ao filtro tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fenceId properties: fenceId: type: string description: Identificador da cerca headQuarterId: type: string description: Identificador da Empresa companyId: type: string description: Identificador da filial costCenterId: type: string description: Identificador do Centro de Custo employeeIds: type: array items: type: string description: Identificador do colaborador responses: 200: description: Ok schema: type: object required: – success – linkedEmployeesCount properties: success: type: boolean description: Indica se o vínculo foi adicionado com sucesso linkedEmployeesCount: type: integer format: int64 description: Total de colaboradores vinculados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pontomobile_bff/actions/savePerimeter: post: description: Cadastra ou atualiza um perímetro de cerca virtual tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – perimeter – fenceId properties: perimeter: type: object allOf: – #/definitions/perimeterDTO description: Dados do perímetro fenceId: type: string description: Identificador da cerca virtual responses: 200: description: Ok schema: type: object required: – perimeter properties: perimeter: type: object allOf: – #/definitions/perimeterDTO description: Perímetro salvo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pontomobile_bff/actions/deleterPerimeter: post: description: Remove um perímetro de cerca virtual tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – perimeterId – fenceId properties: perimeterId: type: string description: Identificador do perímetro fenceId: type: string description: Identificador da cerca virtual responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pontomobile_bff/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 /pontomobile_bff/actions/importHeadQuarter: 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 /pontomobile_bff/actions/importCostCenter: 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 /pontomobile_bff/actions/importCompany: 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 /pontomobile_bff/actions/importConfiguration: 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 /pontomobile_bff/actions/importEmployee: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pontomobile_bff/actions/importPlatformUsers: 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 /pontomobile_bff/actions/importClockingEventUse: 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 /pontomobile_bff/actions/importPushReminder: 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 /pontomobile_bff/actions/importReminder: 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 /pontomobile_bff/actions/importFence: 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 /pontomobile_bff/actions/importPerimeter: 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 /pontomobile_bff/actions/importLocation: 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 /pontomobile_bff/actions/importModel: 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 /pontomobile_bff/actions/importManager: 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 /pontomobile_bff/events/importHeadQuarterEvent: 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 /pontomobile_bff/events/exportHeadQuarterEvent: 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 /pontomobile_bff/events/importCostCenterEvent: 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 /pontomobile_bff/events/exportCostCenterEvent: 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 /pontomobile_bff/events/importCompanyEvent: 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 /pontomobile_bff/events/exportCompanyEvent: 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 /pontomobile_bff/events/importConfigurationEvent: 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 /pontomobile_bff/events/exportConfigurationEvent: 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 /pontomobile_bff/events/importEmployeeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /pontomobile_bff/events/exportEmployeeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /pontomobile_bff/events/importPlatformUsersEvent: 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 /pontomobile_bff/events/exportPlatformUsersEvent: 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 /pontomobile_bff/events/importClockingEventUseEvent: 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 /pontomobile_bff/events/exportClockingEventUseEvent: 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 /pontomobile_bff/events/importPushReminderEvent: 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 /pontomobile_bff/events/exportPushReminderEvent: 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 /pontomobile_bff/events/importReminderEvent: 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 /pontomobile_bff/events/exportReminderEvent: 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 /pontomobile_bff/events/importFenceEvent: 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 /pontomobile_bff/events/exportFenceEvent: 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 /pontomobile_bff/events/importPerimeterEvent: 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 /pontomobile_bff/events/exportPerimeterEvent: 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 /pontomobile_bff/events/importLocationEvent: 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 /pontomobile_bff/events/exportLocationEvent: 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 /pontomobile_bff/events/importModelEvent: 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 /pontomobile_bff/events/exportModelEvent: 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 /pontomobile_bff/events/importManagerEvent: 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 /pontomobile_bff/events/exportManagerEvent: 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 /pontomobile_bff/entities/headQuarter: 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/headQuarter responses: 200: description: The created resource schema: #/definitions/headQuarter 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/headQuarter responses: 200: description: The created resource schema: #/definitions/headQuarter 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/headQuarter 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pontomobile_bff/entities/headQuarter/{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/editHeadQuarter responses: 200: description: Ok schema: #/definitions/editHeadQuarter 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/headQuarter responses: 200: description: Ok schema: #/definitions/headQuarter 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/headQuarter 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 /pontomobile_bff/entities/headQuarter/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/headQuarter responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pontomobile_bff/entities/costCenter: 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/costCenter responses: 200: description: The created resource schema: #/definitions/costCenter 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/costCenter responses: 200: description: The created resource schema: #/definitions/costCenter 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/costCenter 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pontomobile_bff/entities/costCenter/{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/editCostCenter responses: 200: description: Ok schema: #/definitions/editCostCenter 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/costCenter responses: 200: description: Ok schema: #/definitions/costCenter 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/costCenter 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 /pontomobile_bff/entities/costCenter/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/costCenter responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pontomobile_bff/entities/company: 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/company responses: 200: description: The created resource schema: #/definitions/company 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/company responses: 200: description: The created resource schema: #/definitions/company 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/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pontomobile_bff/entities/company/{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/editCompany responses: 200: description: Ok schema: #/definitions/editCompany 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/company responses: 200: description: Ok schema: #/definitions/company 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/company 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 /pontomobile_bff/entities/company/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/company responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pontomobile_bff/entities/configuration: 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/configuration responses: 200: description: The created resource schema: #/definitions/configuration 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/configuration responses: 200: description: The created resource schema: #/definitions/configuration 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/configuration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pontomobile_bff/entities/configuration/{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/editConfiguration responses: 200: description: Ok schema: #/definitions/editConfiguration 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/configuration responses: 200: description: Ok schema: #/definitions/configuration 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/configuration 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 /pontomobile_bff/entities/configuration/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/configuration responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pontomobile_bff/entities/employee: 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/employee responses: 200: description: The created resource schema: #/definitions/employee 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/employee responses: 200: description: The created resource schema: #/definitions/employee 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/employee 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pontomobile_bff/entities/employee/{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/editEmployee responses: 200: description: Ok schema: #/definitions/editEmployee 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/employee responses: 200: description: Ok schema: #/definitions/employee 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/employee 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 /pontomobile_bff/entities/employee/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/employee responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pontomobile_bff/entities/clockingEventUse: 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/clockingEventUse responses: 200: description: The created resource schema: #/definitions/clockingEventUse 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/clockingEventUse responses: 200: description: The created resource schema: #/definitions/clockingEventUse 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/clockingEventUse 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pontomobile_bff/entities/clockingEventUse/{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/editClockingEventUse responses: 200: description: Ok schema: #/definitions/editClockingEventUse 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/clockingEventUse responses: 200: description: Ok schema: #/definitions/clockingEventUse 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/clockingEventUse 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 /pontomobile_bff/entities/clockingEventUse/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/clockingEventUse responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pontomobile_bff/entities/pushReminder: 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/pushReminder responses: 200: description: The created resource schema: #/definitions/pushReminder 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/pushReminder responses: 200: description: The created resource schema: #/definitions/pushReminder 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/pushReminder 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pontomobile_bff/entities/pushReminder/{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/editPushReminder responses: 200: description: Ok schema: #/definitions/editPushReminder 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/pushReminder responses: 200: description: Ok schema: #/definitions/pushReminder 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/pushReminder 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 /pontomobile_bff/entities/pushReminder/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/pushReminder responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pontomobile_bff/entities/reminder: 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/reminder responses: 200: description: The created resource schema: #/definitions/reminder 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/reminder responses: 200: description: The created resource schema: #/definitions/reminder 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/reminder 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pontomobile_bff/entities/reminder/{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/editReminder responses: 200: description: Ok schema: #/definitions/editReminder 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/reminder responses: 200: description: Ok schema: #/definitions/reminder 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/reminder 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 /pontomobile_bff/entities/pushReminder/{parentId}/reminder: post: description: Esta entidade pode ser customizada. 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/reminder responses: 200: description: The created resources schema: type: array items: #/definitions/reminder 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: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/reminder responses: 200: description: The created resources schema: type: array items: #/definitions/reminder 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: 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/reminder 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pontomobile_bff/entities/pushReminder/{parentId}/reminder/{id}: put: description: Esta entidade pode ser customizada. 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/editReminder responses: 200: description: Ok schema: #/definitions/editReminder 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: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/reminder responses: 200: description: Ok schema: #/definitions/reminder 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/reminder 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: 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 /pontomobile_bff/entities/reminder/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/reminder responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pontomobile_bff/entities/fence: 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/fence responses: 200: description: The created resource schema: #/definitions/fence 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/fence responses: 200: description: The created resource schema: #/definitions/fence 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/fence 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pontomobile_bff/entities/fence/{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/editFence responses: 200: description: Ok schema: #/definitions/editFence 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/fence responses: 200: description: Ok schema: #/definitions/fence 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/fence 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 /pontomobile_bff/entities/fence/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/fence responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pontomobile_bff/entities/perimeter: 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/perimeter responses: 200: description: The created resource schema: #/definitions/perimeter 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/perimeter responses: 200: description: The created resource schema: #/definitions/perimeter 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/perimeter 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pontomobile_bff/entities/perimeter/{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/editPerimeter responses: 200: description: Ok schema: #/definitions/editPerimeter 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/perimeter responses: 200: description: Ok schema: #/definitions/perimeter 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/perimeter 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 /pontomobile_bff/entities/perimeter/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/perimeter responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pontomobile_bff/entities/location: 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/location responses: 200: description: The created resource schema: #/definitions/location 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/location responses: 200: description: The created resource schema: #/definitions/location 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/location 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pontomobile_bff/entities/location/{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/editLocation responses: 200: description: Ok schema: #/definitions/editLocation 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/location responses: 200: description: Ok schema: #/definitions/location 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/location 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 /pontomobile_bff/entities/perimeter/{parentId}/startPoint: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/location responses: 200: description: The created resource schema: #/definitions/location 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: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/location responses: 200: description: The created resource schema: #/definitions/location 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: 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/location 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pontomobile_bff/entities/perimeter/{parentId}/startPoint/{id}: put: description: Esta entidade pode ser customizada. 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/editLocation responses: 200: description: Ok schema: #/definitions/editLocation 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: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/location responses: 200: description: Ok schema: #/definitions/location 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/location 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: 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 /pontomobile_bff/entities/location/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/location responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pontomobile_bff/entities/model: 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/model responses: 200: description: The created resource schema: #/definitions/model 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/model responses: 200: description: The created resource schema: #/definitions/model 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/model 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pontomobile_bff/entities/model/{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/editModel responses: 200: description: Ok schema: #/definitions/editModel 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/model responses: 200: description: Ok schema: #/definitions/model 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/model 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 /pontomobile_bff/entities/model/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/model responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pontomobile_bff/entities/manager: 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/manager responses: 200: description: The created resource schema: #/definitions/manager 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/manager responses: 200: description: The created resource schema: #/definitions/manager 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/manager 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /pontomobile_bff/entities/manager/{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/editManager responses: 200: description: Ok schema: #/definitions/editManager 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/manager responses: 200: description: Ok schema: #/definitions/manager 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/manager 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 /pontomobile_bff/entities/manager/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/manager responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: dataOriginType: type: string enum: – G5 – MANUAL – HRIS description: Data Origim: * `G5` – Integração G5 * `MANUAL` – Manual * `HRIS` – HRIS employerType: type: string enum: – CNPJ – CPF description: Employer Type: * `CNPJ` – CNPJ * `CPF` – CPF timeoutType: type: string enum: – ZERO – FIVE – TEN – FIFTEEN description: Valores de timeout: * `ZERO` – 0 * `FIVE` – 5 minutos * `TEN` – 10 minutos * `FIFTEEN` – 15 minutos operationModeType: type: string enum: – MULTI – SINGLE – DRIVER – NFC – BIOMETRIC – QRCODE – FACE_RECOGNITION description: Modos de operação do aplicativo: * `MULTI` – Multi usuário * `SINGLE` – Usuário único * `DRIVER` – Motorista * `NFC` – NFC * `BIOMETRIC` – Biometria * `QRCODE` – QRCode * `FACE_RECOGNITION` – Reconhecimento facial sortDirectionType: type: string enum: – ASC – DESC description: Direção de ordenação: * `ASC` – Ascendente * `DESC` – Descendente deviceAuthorizationType: type: string enum: – NOT_REQUIRED – REQUIRED description: Modos de autorização de dispositivos: * `NOT_REQUIRED` – Não requer autorização * `REQUIRED` – Autorização obrigatória insightOutOfBoundType: type: string enum: – ALL_CLOCKING_EVENTS – MOBILE_ONLY – DO_NOT_SEND description: Tipos de envios do insight de marcações fora da cerca: * `ALL_CLOCKING_EVENTS` – Alertar todas as marcações * `MOBILE_ONLY` – Alertar somente as marcações do app * `DO_NOT_SEND` – Não alertar clockingEventUseType: type: string enum: – CLOCKING_EVENT – PAID_BREAK – MANDATORY_BREAK – DRIVING – WAITING description: Enumeração com a definição dos tipos de uso das marcações.: * `CLOCKING_EVENT` – Uso Ponto * `PAID_BREAK` – Uso Pausa Abonada * `MANDATORY_BREAK` – Uso Parada Obrigatória * `DRIVING` – Uso de Direção * `WAITING` – Uso de Espera reminderType: type: string enum: – INTERJOURNEY – INTRAJOURNEY description: Tipos de lembrete: * `INTERJOURNEY` – Intervalo interjornada estabelece um período de descanso entre o término de uma jornada de trabalho e o início da outra, no dia seguinte ou conforme a escala de trabalho adotada (CLT: Art. 66, Art. 235, Art. 245, Art. 308). * `INTRAJOURNEY` – Intervalo intrajornada tem duração variável, indo de 15 minutos a 2h, a depender da duração da jornada de trabalho aplicada (CLT: Art. 71). geometricFormType: type: string enum: – CIRCLE description: Forma geometrica: * `CIRCLE` – Circulo userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error healthcheckDTO: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Saudável * `DOWN` – Ruim employeeClockingConfig: description: Configuração de marcação do colaborador type: object required: – employee – name – timeZone – clockingEventUses properties: employee: type: object allOf: – #/definitions/employeeDTO description: Colaorador name: type: string description: Nome timeZone: type: string description: Fuso horário clockingEventUses: type: array items: type: object allOf: – #/definitions/clockingEventUseDTO minimum: 1 description: Usos de marcação permitidos fenceEmployeesPage: description: Página de colaboradores vinculados a uma cerca type: object required: – page – pageSize – totalElements – content properties: page: type: integer format: int64 description: Número da página (zero-based) pageSize: type: integer format: int64 description: Tamanho da página totalElements: type: integer format: int64 description: Total de registros content: type: array items: type: object allOf: – #/definitions/employeeFenceDTO minimum: 1 description: Colaboradores employeeFenceDTO: description: Colaborador para listagem no cadastro de cerca type: object properties: id: type: string description: Identificador único name: type: string description: Nome fenceModelsPage: description: Página de colaboradores vinculados a uma cerca type: object required: – totalElements – content properties: page: type: integer format: int64 description: Número da página (zero-based) pageSize: type: integer format: int64 description: Tamanho da página totalElements: type: integer format: int64 description: Total de registros content: type: array items: type: object allOf: – #/definitions/modelFenceDTO minimum: 1 description: Modelos modelFenceDTO: description: Modelo para listagem no cadastro de cerca type: object required: – code properties: id: type: string description: Identificador único code: type: integer format: int64 description: Codigo name: type: string description: Nome employeeDTO: description: Colaborador type: object properties: id: type: string description: Identificador único name: type: string description: Nome arpId: type: string description: Id do registro no ARP cpfNumber: type: string description: Cpf pis: type: string description: Pis company: type: object allOf: – #/definitions/companyDTO description: Filial companyDTO: description: Empresa type: object properties: id: type: string description: Identificador único arpId: type: string description: Id do registro no ARP cnpj: type: string description: CNPJ caepf: type: string description: caepf cnoNumber: type: string description: Número de Cadastro Nacional de Obras clockingEventUseDTO: description: Usos de marcação type: object required: – id – description – code – clockingEventUseType properties: id: type: string description: Identificador único description: type: string description: Descrição code: type: string description: Código clockingEventUseType: type: string allOf: – #/definitions/clockingEventUseType description: Uso perimeterDTO: description: Perímetro de cerca virtual type: object required: – name – type – startPoint properties: id: type: string description: Identificador único name: type: string description: Nome type: type: string allOf: – #/definitions/geometricFormType description: Tipo de forma geométrica startPoint: type: object allOf: – #/definitions/locationDTO description: Ponto inicial radius: type: integer format: int64 description: Raio em metros postalCode: type: string description: CEP address: type: string description: Endereço color: type: string description: Cor (formato hexadecimal) locationDTO: description: Localização geográfica type: object required: – latitude – longitude properties: id: type: string description: Identificador único latitude: type: number format: double description: Latitude longitude: type: number format: double description: Longitude geoPlacesSuggestionDTO: description: Sugestão de local retornada pelo autocomplete do AWS GeoPlaces type: object properties: placeId: type: string description: Identificador do local placeType: type: string description: Tipo de sugestão type: string description: Título da sugestão address: type: object allOf: – #/definitions/geoPlacesAddressDTO description: Endereço formatado distance: type: integer format: int64 description: Distância em metros language: type: string description: Idioma geoPlacesAddressDTO: description: Endereço do AWS GeoPlaces type: object properties: label: type: string description: Rótulo do endereço completo country: type: string description: País region: type: string description: Região/Estado subRegion: type: string description: Sub-região locality: type: string description: Localidade/Cidade district: type: string description: Distrito street: type: string description: Rua streetNumber: type: string description: Número da rua postalCode: type: string description: Código postal geoPlacesPlaceDTO: description: Detalhes de um local do AWS GeoPlaces type: object required: – position properties: placeId: type: string description: Identificador do local placeType: type: string description: Tipo do local type: string description: Título address: type: object allOf: – #/definitions/geoPlacesAddressDTO description: Endereço position: type: array items: type: number format: double minimum: 1 description: Coordenadas geográficas [longitude, latitude] geoPlacesResultDTO: description: Resultado de geocodificação do AWS GeoPlaces type: object required: – position properties: placeId: type: string description: Identificador do local placeType: type: string description: Tipo do local type: string description: Título address: type: object allOf: – #/definitions/geoPlacesAddressDTO description: Endereço position: type: array items: type: number format: double minimum: 1 description: Coordenadas geográficas [longitude, latitude] distance: type: integer format: int64 description: Distância em metros geoPlacesReverseResultDTO: description: Resultado de geocodificação reversa do AWS GeoPlaces type: object required: – position properties: placeId: type: string description: Identificador do local placeType: type: string description: Tipo do local type: string description: Título address: type: object allOf: – #/definitions/geoPlacesAddressDTO description: Endereço position: type: array items: type: number format: double minimum: 1 description: Coordenadas geográficas [longitude, latitude] distance: type: integer format: int64 description: Distância em metros headQuarter: description: Grupo Empresa type: object required: – name properties: id: type: string format: uuid description: Identificador único name: type: string description: Nome code: type: integer format: int64 description: Código minimum: 0 maximum: 9999 dataOrigin: type: string allOf: – #/definitions/dataOriginType description: Origem dos dados externalId: type: string description: Identificador único externo da empresa editHeadQuarter: type: object required: – id allOf: – #/definitions/headQuarter costCenter: description: Centro de Custo type: object required: – name – headQuarter properties: id: type: string format: uuid description: Identificador único name: type: string description: Nome code: type: string maxLength: 60 description: Código headQuarter: type: object allOf: – #/definitions/headQuarter description: Grupo Empresa dataOrigin: type: string allOf: – #/definitions/dataOriginType description: Origem dos dados externalId: type: string description: Identificador único externo da empresa editCostCenter: type: object required: – id allOf: – #/definitions/costCenter company: description: Empresa type: object required: – cnpj – name properties: id: type: string format: uuid description: Identificador único cnpj: type: string description: CNPJ name: type: string description: Nome dataOrigin: type: string allOf: – #/definitions/dataOriginType description: Origem dos dados timeZone: type: string description: Timezone headquarters: type: boolean description: Filial Matriz conventionOrAggremantNumber: type: string description: Número do processo de acordo ou convenção coletiva externalId: type: string description: Identificador Externo cnoNumber: type: string description: Número de Cadastro Nacional de Obras lastUpdate: type: string format: date-time description: Última atualização arpId: type: string description: Id do registro no ARP arpSyncDate: type: string format: date-time description: Data da sincronização do registro com o ARP caepf: type: string description: CAEPF legalRepresentativeIdentifier: type: integer format: int64 description: Cpf representante legal cep: type: string maxLength: 20 description: CEP address: type: string maxLength: 100 description: Endereço number: type: string maxLength: 60 description: Número complement: type: string maxLength: 200 description: Compleento neighborhood: type: string maxLength: 75 description: Bairro city: type: string maxLength: 60 description: Município state: type: string maxLength: 20 description: Estado country: type: string maxLength: 150 description: país employerType: type: string allOf: – #/definitions/employerType description: Tipo do empregador externalControlTimezone: type: boolean description: Controle de Timezone via importação default: false headQuarter: type: object allOf: – #/definitions/headQuarter description: Grupo Empresa editCompany: type: object required: – id allOf: – #/definitions/company configuration: description: Configuração type: object properties: id: type: string format: uuid description: Identificador único gps: type: boolean description: GPS requerido online: type: boolean description: Marcação apenas Online timeout: type: string allOf: – #/definitions/timeoutType description: Tempo para expiração do login no Web Gestor operationMode: type: string allOf: – #/definitions/operationModeType description: Modo de Operação employee: type: object allOf: – #/definitions/employee description: Colaborador nfcMode: type: boolean description: Permite ler informações NFC allowChangeTime: type: boolean description: Permite alterar a hora timezone: type: string description: Fuso horário deviceAuthModeSingleMode: type: string allOf: – #/definitions/deviceAuthorizationType description: Modo autorização dispositivo modo Individual deviceAuthModeMultiMode: type: string allOf: – #/definitions/deviceAuthorizationType description: Modo autorização dispositivo modo Multiplo deviceAuthModeDriverMode: type: string allOf: – #/definitions/deviceAuthorizationType description: Modo autorização dispositivo modo Motorista allowDrivingTime: type: boolean description: Permite informar tempo de direção overnight: type: boolean description: Habilita a rotina de pernoites no dispositivo com modo de operação Motoristas controlOvernight: type: boolean description: Habilita a inclusão de pernoites no dispositivo com modo de operação Motoristas allowGpoOnApp: type: boolean description: Permite disponibilizar o gestão do ponto no App exportNotChecked: type: boolean description: enviar marcações não verificadas insightOutOfBound: type: string allOf: – #/definitions/insightOutOfBoundType description: Insight marcações fora da cerca takePhotoSingle: type: boolean description: Permite captura da selfie para o perfil individual takePhotoMulti: type: boolean description: Permite captura da selfie para o perfil múltiplo takePhotoDriver: type: boolean description: Permite captura da selfie para o perfil motorista takePhotoQrcode: type: boolean description: Permite captura da selfie para o modo de captura de código de barras/QRCode takePhotoNfc: type: boolean description: Permite captura da selfie para o modo de captura NFC openExternalBrowser: type: boolean description: Deve utilizar browser externo ao app para abrir telas do gestão do ponto clockingEventUses: type: array items: type: object allOf: – #/definitions/clockingEventUse description: Usos allowUse: type: boolean description: Permitir outros usos externalControlTimezone: type: boolean description: Controle de Timezone via importação default: false faceRecognition: type: boolean description: Habilita o reconhecimento facial default: false canExclude: type: boolean description: Controle de exclusão de configurações default: true model: type: boolean description: Configuração de modelo default: false editConfiguration: type: object required: – id allOf: – #/definitions/configuration employee: description: Colaborador type: object required: – name – company properties: id: type: string format: uuid description: Identificador único externalId: type: string description: Identificador Externo name: type: string description: Nome mail: type: string description: Email platformUserName: type: string description: Id usuário SeniorX lastUpdate: type: string format: date-time description: Última atualização manager: type: object allOf: – #/definitions/manager description: Gestor managers: type: array items: type: object allOf: – #/definitions/manager description: Gestores fences: type: array items: type: object allOf: – #/definitions/fence description: Cercas virtuais platformUsers: type: array items: type: object allOf: – #/definitions/platformUsers description: Id usuários SeniorX enabled: type: boolean description: Status do empregado default: true company: type: object allOf: – #/definitions/company description: Empresa pis: type: string description: Pis cpfNumber: type: string description: Cpf arpId: type: string description: Id do registro no ARP headQuarter: type: object allOf: – #/definitions/headQuarter description: Grupo Empresa costCenter: type: object allOf: – #/definitions/costCenter description: Centro de custo editEmployee: type: object required: – id allOf: – #/definitions/employee platformUsers: description: Usuários da plataforma type: object required: – username properties: id: type: string format: uuid description: Identificador Único username: type: string description: Nome do usuáo da plataforma clockingEventUse: description: Usos de marcação type: object required: – id – description – code – clockingEventUseType properties: id: type: string format: uuid description: Identificador único description: type: string description: Descrição code: type: string description: Código clockingEventUseType: type: string allOf: – #/definitions/clockingEventUseType description: Uso configurations: type: array items: type: object allOf: – #/definitions/configuration description: Configuração editClockingEventUse: type: object required: – id allOf: – #/definitions/clockingEventUse pushReminder: description: Lembretes de push configurados type: object required: – code – description properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código description: type: string description: Descrição reminder: type: array items: type: object allOf: – #/definitions/reminder description: Lembrete editPushReminder: type: object required: – id allOf: – #/definitions/pushReminder reminder: description: Lembretes type: object required: – period – enabled – type properties: id: type: string format: uuid description: Identificador único period: type: string description: Tempo para validação do lembrete enabled: type: boolean description: Lembrete ativado type: type: string allOf: – #/definitions/reminderType description: Tipo de lembrete pushReminder: type: object allOf: – #/definitions/pushReminder description: Lembrete de push configurado editReminder: type: object required: – id allOf: – #/definitions/reminder fence: description: Cerca virtual type: object required: – name properties: id: type: string format: uuid description: Identificador único code: type: string description: Código name: type: string description: Nome perimeters: type: array items: type: object allOf: – #/definitions/perimeter description: Perimetros employees: type: array items: type: object allOf: – #/definitions/employee description: Colaboradores Vinculados editFence: type: object required: – id allOf: – #/definitions/fence perimeter: description: Perimetro cerca virtual type: object required: – name – type properties: id: type: string format: uuid description: Identificador único name: type: string description: Nome type: type: string allOf: – #/definitions/geometricFormType description: Tipo de forma geometrica startPoint: type: object allOf: – #/definitions/location description: Ponto inicial radius: type: integer format: int64 description: Raio postalCode: type: string description: CEP address: type: string description: Endereço color: type: string description: Cor editPerimeter: type: object required: – id allOf: – #/definitions/perimeter location: description: Localização type: object required: – latitude – longitude – dateAndTime properties: id: type: string format: uuid description: Identificador único latitude: type: number format: double description: Latitude longitude: type: number format: double description: Longitude dateAndTime: type: string format: date-time description: Date e hora perimeter: type: object allOf: – #/definitions/perimeter description: Perímetro editLocation: type: object required: – id allOf: – #/definitions/location model: description: Modelo type: object required: – code – description – headQuarter properties: id: type: string format: uuid description: Identificador único code: type: integer format: int64 description: Código description: type: string description: Descrição do modelo headQuarter: type: object allOf: – #/definitions/headQuarter description: Empresa costCenters: type: array items: type: object allOf: – #/definitions/costCenter description: Centros de Custo companies: type: array items: type: object allOf: – #/definitions/company description: Filiais configuration: type: object allOf: – #/definitions/configuration description: Configuração pushReminder: type: object allOf: – #/definitions/pushReminder description: Lembrete fences: type: array items: type: object allOf: – #/definitions/fence description: Cercas editModel: type: object required: – id allOf: – #/definitions/model manager: description: Gestor type: object required: – employees properties: id: type: string format: uuid description: Identificador único mail: type: string description: Email platformUserName: type: string description: Id usuário SeniorX platformUsers: type: array items: type: object allOf: – #/definitions/platformUsers description: List de usuários SeniorX employees: type: array items: type: object allOf: – #/definitions/employee minimum: 1 description: Lista de colaboradores editManager: type: object required: – id allOf: – #/definitions/manager notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service checkDTO: description: Retorno status usados de retorno type: object required: – status – name properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status name: type: string description: Status genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage