2.0info: 2.121.0 Gestão de Rotinas description: Serviço do backend do Gestão de Rotinas do Ronda senior X x-senior-domain: Gestão de Acesso e Segurança x-senior-domain-path: sam x-senior-service-path: patrol 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/samsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /patrol/queries/healthcheck: post: description: Endpoint para verificação da saúde do serviço tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckStatus description: Status geral do healthcheck checks: type: array items: type: object allOf: – #/definitions/healthcheckItem minimum: 1 description: Itens verificados no healthcheck 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Endpoint para verificação da saúde do serviço tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckStatus description: Status geral do healthcheck checks: type: array items: type: object allOf: – #/definitions/healthcheckItem minimum: 1 description: Itens verificados no healthcheck 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/generatePositionQRCode: post: description: Gera um Código QR com informações do plano de rotina\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/position – Visualizar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – positionId properties: positionId: type: integer format: int64 description: ID do plano de rotina responses: 200: description: Ok schema: type: object required: – qrcode properties: qrcode: type: string description: Código QR em Base64 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Gera um Código QR com informações do plano de rotina\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/position – Visualizar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: positionId description: ID do plano de rotina in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – qrcode properties: qrcode: type: string description: Código QR em Base64 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/generateCheckpointQRCode: post: description: Gera um Código QR com informações do ponto de controle\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/checkpoint – Visualizar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – checkpointId properties: checkpointId: type: integer format: int64 description: ID do ponto de controle responses: 200: description: Ok schema: type: object required: – qrcode properties: qrcode: type: string description: Código QR em Base64 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Gera um Código QR com informações do ponto de controle\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/checkpoint – Visualizar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: checkpointId description: ID do ponto de controle in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – qrcode properties: qrcode: type: string description: Código QR em Base64 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/findPositionsByGeolocation: post: description: Busca os planos de rotinas pelas coordenadas geográficas\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/position – Visualizar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – latitude – longitude properties: latitude: type: number format: double description: Latitude minimum: -90.0 maximum: 90.0 longitude: type: number format: double description: Longitude minimum: -180.0 maximum: 180.0 responses: 200: description: Ok schema: type: object required: – positions properties: positions: type: array items: type: object allOf: – #/definitions/nearbyPositionRecord minimum: 1 description: Plano de rotinas encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca os planos de rotinas pelas coordenadas geográficas\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/position – Visualizar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: latitude description: Latitude in: query required: true type: number format: double – name: longitude description: Longitude in: query required: true type: number format: double responses: 200: description: Ok schema: type: object required: – positions properties: positions: type: array items: type: object allOf: – #/definitions/nearbyPositionRecord minimum: 1 description: Plano de rotinas encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/getPendingTours: post: description: Busca as rotinas pendentes e em progresso que a data final é posterior a data da consulta e que possuem ponto de controle vinculado, foi mantido para continuar tendo compatibilidade com as versões anteriores do\naplicativo móvel. Deve ser utilizada a versão 2 do endpoint(getPendingTours__2)\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/tour – Visualizar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – deviceUUID – positionId properties: deviceUUID: type: string description: Identificador do dispositivo positionId: type: integer format: int64 description: Identificador do plano de rotina size: type: integer format: int64 description: Quantidade de registros por página minimum: 1 default: 10 offset: type: integer format: int64 description: Número da página minimum: 0 default: 0 onlyScheduled: type: boolean description: Somente agendadas, este campo quando configurado como true, retornará somente rotinas que possuem agendamento default: true responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Número total de páginas totalElements: type: integer format: int64 description: Número total de elementos contents: type: array items: type: object allOf: – #/definitions/tourRecord minimum: 1 description: Lista de rotinas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca as rotinas pendentes e em progresso que a data final é posterior a data da consulta e que possuem ponto de controle vinculado, foi mantido para continuar tendo compatibilidade com as versões anteriores do\naplicativo móvel. Deve ser utilizada a versão 2 do endpoint(getPendingTours__2)\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/tour – Visualizar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: deviceUUID description: Identificador do dispositivo in: query required: true type: string – name: positionId description: Identificador do plano de rotina in: query required: true type: integer format: int64 – name: size description: Quantidade de registros por página in: query type: integer format: int64 – name: offset description: Número da página in: query type: integer format: int64 – name: onlyScheduled description: Somente agendadas, este campo quando configurado como true, retornará somente rotinas que possuem agendamento in: query type: boolean responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Número total de páginas totalElements: type: integer format: int64 description: Número total de elementos contents: type: array items: type: object allOf: – #/definitions/tourRecord minimum: 1 description: Lista de rotinas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/getPendingTours__2: post: description: Busca as rotinas pendentes e em progresso que a data final é posterior a data da consulta e que possuem ponto de controle vinculado,\nrecomendado a utilização deste endpoint\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/tour – Visualizar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – deviceUUID – positionId properties: deviceUUID: type: string description: Identificador do dispositivo positionId: type: integer format: int64 description: Identificador do plano de rotina size: type: integer format: int64 description: Quantidade de registros por página minimum: 1 default: 10 offset: type: integer format: int64 description: Número da página minimum: 0 default: 0 onlyScheduled: type: boolean description: Somente agendadas, este campo quando configurado como true, retornará somente rotinas que possuem agendamento default: true answerTypes: type: array items: type: string allOf: – #/definitions/answerType description: Tipos de resposta que devem ser retornadas, caso não seja filtrado, o padrão será o tipo Lista com a descrição Conforme/Não conforme para não haver quebra com o aplicativo responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Número total de páginas totalElements: type: integer format: int64 description: Número total de elementos contents: type: array items: type: object allOf: – #/definitions/tourRecord minimum: 1 description: Lista de rotinas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/getTourStatusReportFilter: post: description: Busca os status das rotinas para o campo de lookup do relatório\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/tour – Visualizar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: searchText: type: string description: Valor da busca informada pelo usuário searchValue: type: string description: Valor para busca exata por um registro responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/reportFilterData minimum: 1 description: Lista de registros encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca os status das rotinas para o campo de lookup do relatório\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/tour – Visualizar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchText description: Valor da busca informada pelo usuário in: query type: string – name: searchValue description: Valor para busca exata por um registro in: query type: string responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/reportFilterData minimum: 1 description: Lista de registros encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/getPositionReportFilter: post: description: Busca os planos de rotinas para o campo de lookup do relatório\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/position – Visualizar\n###Abrangência:\nPlano de rotina e Tipo de plano de rotina tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: searchText: type: string description: Valor da busca informada pelo usuário searchValue: type: string description: Valor para busca exata por um registro responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/reportFilterData minimum: 1 description: Lista de registros encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca os planos de rotinas para o campo de lookup do relatório\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/position – Visualizar\n###Abrangência:\nPlano de rotina e Tipo de plano de rotina tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchText description: Valor da busca informada pelo usuário in: query type: string – name: searchValue description: Valor para busca exata por um registro in: query type: string responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/reportFilterData minimum: 1 description: Lista de registros encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/getPersonReportFilter: post: description: Busca as pessoas para o campo de lookup do relatório\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/person – Visualizar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: searchText: type: string description: Valor da busca informada pelo usuário searchValue: type: string description: Valor para busca exata por um registro responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/reportFilterData minimum: 1 description: Lista de registros encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca as pessoas para o campo de lookup do relatório\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/person – Visualizar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchText description: Valor da busca informada pelo usuário in: query type: string – name: searchValue description: Valor para busca exata por um registro in: query type: string responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/reportFilterData minimum: 1 description: Lista de registros encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/getChecklistStatusReportFilter: post: description: Busca a situação dos checklists para o campo de lookup do relatório\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/checklist – Visualizar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: searchText: type: string description: Valor da busca informada pelo usuário searchValue: type: string description: Valor para busca exata por um registro responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/reportFilterData minimum: 1 description: Lista de registros encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca a situação dos checklists para o campo de lookup do relatório\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/checklist – Visualizar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchText description: Valor da busca informada pelo usuário in: query type: string – name: searchValue description: Valor para busca exata por um registro in: query type: string responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/reportFilterData minimum: 1 description: Lista de registros encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/getCheckpointReportFilter: post: description: Busca os pontos de controle para o campo de lookup do relatório\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/checkpoint – Visualizar\n###Abrangência:\nPlano de rotina e Tipo de plano de rotina tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: searchText: type: string description: Valor da busca informada pelo usuário searchValue: type: string description: Valor para busca exata por um registro responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/reportFilterData minimum: 1 description: Lista de registros encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca os pontos de controle para o campo de lookup do relatório\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/checkpoint – Visualizar\n###Abrangência:\nPlano de rotina e Tipo de plano de rotina tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchText description: Valor da busca informada pelo usuário in: query type: string – name: searchValue description: Valor para busca exata por um registro in: query type: string responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/reportFilterData minimum: 1 description: Lista de registros encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/getComplianceTypeReportFilter: post: description: Busca os tipos de conformidade para o campo de lookup do relatório\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/answerOption – Visualizar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: searchText: type: string description: Valor da busca informada pelo usuário searchValue: type: string description: Valor para busca exata por um registro responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/reportFilterData minimum: 1 description: Lista de registros encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca os tipos de conformidade para o campo de lookup do relatório\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/answerOption – Visualizar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchText description: Valor da busca informada pelo usuário in: query type: string – name: searchValue description: Valor para busca exata por um registro in: query type: string responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/reportFilterData minimum: 1 description: Lista de registros encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/getRoutineTemplateReportFilter: post: description: Busca as rotinas para o campo de lookup do relatório\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/routineTemplate – Visualizar\n###Abrangência:\nPlano de rotina e Tipo de plano de rotina tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: searchText: type: string description: Valor da busca informada pelo usuário searchValue: type: string description: Valor para busca exata por um registro responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/reportFilterData minimum: 1 description: Lista de registros encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca as rotinas para o campo de lookup do relatório\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/routineTemplate – Visualizar\n###Abrangência:\nPlano de rotina e Tipo de plano de rotina tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchText description: Valor da busca informada pelo usuário in: query type: string – name: searchValue description: Valor para busca exata por um registro in: query type: string responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/reportFilterData minimum: 1 description: Lista de registros encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/getChecklistAnswerType: post: description: Busca os tipos de resposta do checklist para o campo de lookup do relatório\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/checklist – Visualizar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: searchText: type: string description: Valor da busca informada pelo usuário searchValue: type: string description: Valor para busca exata por um registro responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/reportFilterData minimum: 1 description: Lista de registros encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca os tipos de resposta do checklist para o campo de lookup do relatório\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/checklist – Visualizar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchText description: Valor da busca informada pelo usuário in: query type: string – name: searchValue description: Valor para busca exata por um registro in: query type: string responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/reportFilterData minimum: 1 description: Lista de registros encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/listOfLastStatusMobileDevice: post: description: Busca o último status dos dispositivos móveis ativos tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – status properties: status: type: array items: type: object allOf: – #/definitions/lastStatusMobileDeviceRecord minimum: 1 description: Lista de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca o último status dos dispositivos móveis ativos tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – status properties: status: type: array items: type: object allOf: – #/definitions/lastStatusMobileDeviceRecord minimum: 1 description: Lista de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/lastStatusMobileDevice: post: description: Busca o último status de um determinado dispositvo móvel ativo, pelo seu id tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: integer format: int64 description: Id do dispositivo móvel responses: 200: description: Ok schema: type: object required: – status properties: status: type: object allOf: – #/definitions/lastStatusMobileDeviceRecord description: Dispositivo móvel 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca o último status de um determinado dispositvo móvel ativo, pelo seu id tags: – Queries x-senior-visibility: PUBLIC parameters: – name: id description: Id do dispositivo móvel in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – status properties: status: type: object allOf: – #/definitions/lastStatusMobileDeviceRecord description: Dispositivo móvel 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/getRoutineAssociatedWithIncident: post: description: Retorna o checklist associado a ocorrência tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – incidentId properties: incidentId: type: integer format: int64 description: Identificador do ocorrência responses: 200: description: Ok schema: type: object required: – checklistId – tourId – tourCheckpointId properties: checklistId: type: integer format: int64 description: Id do checklist tourId: type: integer format: int64 description: Id da rotina tourCheckpointId: type: integer format: int64 description: Id do ponto de controle da rotina 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o checklist associado a ocorrência tags: – Queries x-senior-visibility: PRIVATE parameters: – name: incidentId description: Identificador do ocorrência in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – checklistId – tourId – tourCheckpointId properties: checklistId: type: integer format: int64 description: Id do checklist tourId: type: integer format: int64 description: Id da rotina tourCheckpointId: type: integer format: int64 description: Id do ponto de controle da rotina 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/getTourDetails: post: description: Busca os detalhes da rotina\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/tour – Editar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tourId properties: tourId: type: integer format: int64 description: Identificador da rotina responses: 200: description: Ok schema: type: object required: – tour properties: tour: type: object allOf: – #/definitions/tourDetailsRecord description: Detalhes da rotina 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca os detalhes da rotina\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/tour – Editar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: tourId description: Identificador da rotina in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – tour properties: tour: type: object allOf: – #/definitions/tourDetailsRecord description: Detalhes da rotina 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/getPositionRangeItens: post: description: Retorna os Itens de Abrangência do Plano de Rotina tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: searchText: type: string description: Valor da busca informada pelo usuário searchValue: type: integer format: int64 description: Valor para busca por identificador de um registro parameters: type: array items: type: object allOf: – #/definitions/searchParametersItens description: Nome e valor de outros campos filtros responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/rangeItens minimum: 1 description: Lista de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/getRoutinePlanTypeRangeItens: post: description: Retorna os Itens de Abrangência dos tipos de plano de rotinas tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: searchText: type: string description: Valor da busca informada pelo usuário searchValue: type: integer format: int64 description: Valor para busca por identificador de um registro parameters: type: array items: type: object allOf: – #/definitions/searchParametersItens description: Nome e valor de outros campos filtros responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/rangeItens minimum: 1 description: Lista de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/getMobileDeviceRangeItens: post: description: Retorna os Itens de Abrangência dos dispositivos móveis tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: searchText: type: string description: Valor da busca informada pelo usuário searchValue: type: integer format: int64 description: Valor para busca por identificador de um registro parameters: type: array items: type: object allOf: – #/definitions/searchParametersItens description: Nome e valor de outros campos filtros responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/rangeItens minimum: 1 description: Lista de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/getRoutinePlanType: post: description: Retorna os tipos de plano de rotinas tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – routinePlanTypes properties: routinePlanTypes: type: array items: type: string allOf: – #/definitions/routinePlanType minimum: 1 description: Lista de planos de rotinas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os tipos de plano de rotinas tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – routinePlanTypes properties: routinePlanTypes: type: array items: type: string allOf: – #/definitions/routinePlanType minimum: 1 description: Lista de planos de rotinas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/requestTourDocumentDownload: post: description: Retorna a URL para download do documento da rotina armazenado no GED, executando a requisição com usuário admin\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/tour – Visualizar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – routineId properties: routineId: type: integer format: int64 description: Identificador da rotina preview: type: boolean description: Indica se a URL deve ser gerada para visualização do documento default: false responses: 200: description: Ok schema: type: object properties: downloadUrl: type: string description: Url para download do documento no GED. Nula quando a rotina não possui documento no GED 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a URL para download do documento da rotina armazenado no GED, executando a requisição com usuário admin\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/tour – Visualizar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: routineId description: Identificador da rotina in: query required: true type: integer format: int64 – name: preview description: Indica se a URL deve ser gerada para visualização do documento in: query type: boolean responses: 200: description: Ok schema: type: object properties: downloadUrl: type: string description: Url para download do documento no GED. Nula quando a rotina não possui documento no GED 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/countRoutinePlanByChecklistTemplate: post: description: Retorna a quantidade de Planos de rotinas por modelos de checklists, mesmo os que estão fora da abrangência do usuário\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/checklistTemplate – Visualizar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – checklistTemplateId properties: checklistTemplateId: type: integer format: int64 description: ID do checklist template responses: 200: description: Ok schema: type: object required: – count properties: count: type: integer format: int64 description: Quantidade de plano de rotinas associadas ao checklist template 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a quantidade de Planos de rotinas por modelos de checklists, mesmo os que estão fora da abrangência do usuário\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/checklistTemplate – Visualizar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: checklistTemplateId description: ID do checklist template in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – count properties: count: type: integer format: int64 description: Quantidade de plano de rotinas associadas ao checklist template 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/getUnscheduledRoutines: post: description: Retorna os modelos de rotinas não agendados\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/routineTemplate – Incluir\nou\nres: res://senior.com.br/sam/patrol/entities/scheduling – Incluir\nou\nres: res://senior.com.br/sam/patrol/entities/tour – Visualizar\n###Abrangência:\nPlano de rotina e Tipo de plano de rotina tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – routinePlanId properties: routinePlanId: type: integer format: int64 description: ID do plano de rotina responses: 200: description: Ok schema: type: object required: – unscheduledRoutines properties: unscheduledRoutines: type: array items: type: object allOf: – #/definitions/unscheduledRoutineRecord minimum: 1 description: Lista de modelos de rotinas não agendados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os modelos de rotinas não agendados\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/routineTemplate – Incluir\nou\nres: res://senior.com.br/sam/patrol/entities/scheduling – Incluir\nou\nres: res://senior.com.br/sam/patrol/entities/tour – Visualizar\n###Abrangência:\nPlano de rotina e Tipo de plano de rotina tags: – Queries x-senior-visibility: PRIVATE parameters: – name: routinePlanId description: ID do plano de rotina in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – unscheduledRoutines properties: unscheduledRoutines: type: array items: type: object allOf: – #/definitions/unscheduledRoutineRecord minimum: 1 description: Lista de modelos de rotinas não agendados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/activeFeature: post: description: Consulta o serviço feature-toggle para saber ser a feature desejada está ativa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – feature properties: feature: type: string description: Feature que será consultada responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: O resultado da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consulta o serviço feature-toggle para saber ser a feature desejada está ativa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: feature description: Feature que será consultada in: query required: true type: string responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: O resultado da consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/hasUserAcceptedPrivacyTerm: post: description: Verifica se o usuário corrente já leu a política de privacidade mais atual do aplicativo tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – hasUserRead properties: hasUserRead: type: boolean description: Usuário leu a política 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verifica se o usuário corrente já leu a política de privacidade mais atual do aplicativo tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – hasUserRead properties: hasUserRead: type: boolean description: Usuário leu a política 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/getFacialRecognitionToken: post: description: Retorna o token do SDK de reconhecimento facial (Gryfo) para o tenant corrente, para uso no aplicativo tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – token properties: token: type: string description: Token do SDK, escopado ao company do tenant na Gryfo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o token do SDK de reconhecimento facial (Gryfo) para o tenant corrente, para uso no aplicativo tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – token properties: token: type: string description: Token do SDK, escopado ao company do tenant na Gryfo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/isFacialRecognitionAvailable: post: description: Informa se o reconhecimento facial está disponível para o tenant corrente (toggle reconhecimento-facial ligado ou licença de reconhecimento facial maior que zero) tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – available properties: available: type: boolean description: Reconhecimento facial disponível 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Informa se o reconhecimento facial está disponível para o tenant corrente (toggle reconhecimento-facial ligado ou licença de reconhecimento facial maior que zero) tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – available properties: available: type: boolean description: Reconhecimento facial disponível 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/listPersonInfo: post: description: Retorna uma lista de pessoas com a URL da foto de perfil, a partir de uma lista de identificadores de pessoas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – peopleIds properties: peopleIds: type: array items: type: integer format: int64 minimum: 1 description: Identificadores de pessoas includeSignRequirements: type: boolean description: Quando verdadeiro e o toggle sign-rotinas estiver ligado, consulta a pessoa no GRS e informa se ela possui os dados exigidos para criar o contato no Sign (missingBirthday e missingContact) default: false responses: 200: description: Ok schema: type: object required: – persons properties: persons: type: array items: type: object allOf: – #/definitions/personRecord minimum: 1 description: Informações das pessoas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/getPersonRegistrationPhoto: post: description: Retorna a foto de perfil da pessoa no GRS em base64, para ser reaproveitada na biometria facial. A foto é baixada no servidor porque o S3 do s-secure não libera CORS para o navegador. Retorna erro de validação quando a pessoa não tem foto no cadastro tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – personId properties: personId: type: integer format: int64 description: Identificador da pessoa no GRS responses: 200: description: Ok schema: type: object required: – photo – contentType properties: photo: type: string description: Conteúdo da foto em base64 contentType: type: string description: Tipo da imagem (ex.: image/jpeg) 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a foto de perfil da pessoa no GRS em base64, para ser reaproveitada na biometria facial. A foto é baixada no servidor porque o S3 do s-secure não libera CORS para o navegador. Retorna erro de validação quando a pessoa não tem foto no cadastro tags: – Queries x-senior-visibility: PRIVATE parameters: – name: personId description: Identificador da pessoa no GRS in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – photo – contentType properties: photo: type: string description: Conteúdo da foto em base64 contentType: type: string description: Tipo da imagem (ex.: image/jpeg) 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/listPpeDeliveryMotive: post: description: Lista os motivos de entrega de EPI tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: size: type: integer format: int64 description: Quantidade de registros por página minimum: 1 default: 10 offset: type: integer format: int64 description: Número da página minimum: 0 default: 0 responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – ppeDeliveryMotives properties: totalPages: type: integer format: int64 description: Número total de páginas totalElements: type: integer format: int64 description: Número total de elementos ppeDeliveryMotives: type: array items: type: object allOf: – #/definitions/ppeDeliveryMotiveRecord minimum: 1 description: Lista de motivos de entrega de EPI 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os motivos de entrega de EPI tags: – Queries x-senior-visibility: PRIVATE parameters: – name: size description: Quantidade de registros por página in: query type: integer format: int64 – name: offset description: Número da página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – ppeDeliveryMotives properties: totalPages: type: integer format: int64 description: Número total de páginas totalElements: type: integer format: int64 description: Número total de elementos ppeDeliveryMotives: type: array items: type: object allOf: – #/definitions/ppeDeliveryMotiveRecord minimum: 1 description: Lista de motivos de entrega de EPI 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/listPersonPpe: post: description: Lista os EPIs de colaboradores tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – personIds properties: personIds: type: array items: type: integer format: int64 minimum: 1 description: Lista de IDs de pessoas responses: 200: description: Ok schema: type: object required: – personPpes properties: personPpes: type: array items: type: object allOf: – #/definitions/personPpeRecord minimum: 1 description: Lista de EPIs das pessoas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/listPersonalProtectiveEquipmentSupplier: post: description: Lista os fornecedores vinculados aos EPIs informados. Quando nenhum EPI for informado, retorna os fornecedores de todos os EPIs tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: ppeIds: type: array items: type: string description: Identificadores dos EPIs size: type: integer format: int64 description: Quantidade de registros por página minimum: 1 default: 10 offset: type: integer format: int64 description: Número da página minimum: 0 default: 0 responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Número total de páginas totalElements: type: integer format: int64 description: Número total de elementos contents: type: array items: type: object allOf: – #/definitions/ppeSupplierGroupRecord minimum: 1 description: Fornecedores agrupados por EPI 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/listPersonalProtectiveEquipment: post: description: Lista os Equipamentos de Proteção Individual disponíveis tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: size: type: integer format: int64 description: Quantidade de registros por página minimum: 1 default: 10 offset: type: integer format: int64 description: Deslocamento para paginação minimum: 0 default: 0 filter: type: string description: Filtro por nome do EPI responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Número total de páginas totalElements: type: integer format: int64 description: Número total de elementos contents: type: array items: type: object allOf: – #/definitions/personalProtectiveEquipmentRecord minimum: 1 description: Lista de EPIs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os Equipamentos de Proteção Individual disponíveis tags: – Queries x-senior-visibility: PRIVATE parameters: – name: size description: Quantidade de registros por página in: query type: integer format: int64 – name: offset description: Deslocamento para paginação in: query type: integer format: int64 – name: filter description: Filtro por nome do EPI in: query type: string responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Número total de páginas totalElements: type: integer format: int64 description: Número total de elementos contents: type: array items: type: object allOf: – #/definitions/personalProtectiveEquipmentRecord minimum: 1 description: Lista de EPIs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/getLoadGroupFilters: post: description: Retorna os filtros do grupo de carga configurados para um plano de rotina, já resolvendo o objeto (id e nome) referenciado por cada filtro. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – positionId properties: positionId: type: integer format: int64 description: ID do plano de rotina responses: 200: description: Ok schema: type: object properties: filters: type: array items: type: object allOf: – #/definitions/loadFilterDetailRecord description: Filtros configurados para o plano, com o objeto referenciado resolvido 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os filtros do grupo de carga configurados para um plano de rotina, já resolvendo o objeto (id e nome) referenciado por cada filtro. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: positionId description: ID do plano de rotina in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object properties: filters: type: array items: type: object allOf: – #/definitions/loadFilterDetailRecord description: Filtros configurados para o plano, com o objeto referenciado resolvido 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/getPersonsForLoadGroup: post: description: Retorna as pessoas resolvidas pelo grupo de carga do plano de rotina, com o resumo do cadastro local (nome, documento, situação da biometria e external id para o SDK). O external id é derivado do cadastro local, sem consultar a Gryfo. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – positionId properties: positionId: type: integer format: int64 description: Identificador do posto (plano de rotina) onlyRegisteredBiometrics: type: boolean description: Quando verdadeiro, retorna apenas as pessoas com biometria registrada (REGISTERED) e não excluída, aplicando o filtro antes da paginação. Usado pelo aplicativo para carregar somente as pessoas que podem ser reconhecidas. Quando falso, retorna todas as pessoas resolvidas pelo plano default: false size: type: integer format: int64 description: Quantidade de registros por página minimum: 1 default: 10 offset: type: integer format: int64 description: Deslocamento para paginação minimum: 0 default: 0 responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – hasLoadFilter – registeredBiometricsCount properties: totalPages: type: integer format: int64 description: Número total de páginas totalElements: type: integer format: int64 description: Número total de elementos hasLoadFilter: type: boolean description: Indica se o plano de rotina possui algum filtro de grupo de carga configurado. Quando falso, o plano resolve todas as pessoas do cadastro registeredBiometricsCount: type: integer format: int64 description: Quantidade total de pessoas do plano com biometria registrada (REGISTERED) e não excluída. Considera todo o plano, não apenas a página atual persons: type: array items: type: object allOf: – #/definitions/gryfoPersonRecord description: Pessoas resolvidas pelo grupo de carga 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as pessoas resolvidas pelo grupo de carga do plano de rotina, com o resumo do cadastro local (nome, documento, situação da biometria e external id para o SDK). O external id é derivado do cadastro local, sem consultar a Gryfo. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: positionId description: Identificador do posto (plano de rotina) in: query required: true type: integer format: int64 – name: onlyRegisteredBiometrics description: Quando verdadeiro, retorna apenas as pessoas com biometria registrada (REGISTERED) e não excluída, aplicando o filtro antes da paginação. Usado pelo aplicativo para carregar somente as pessoas que podem ser reconhecidas. Quando falso, retorna todas as pessoas resolvidas pelo plano in: query type: boolean – name: size description: Quantidade de registros por página in: query type: integer format: int64 – name: offset description: Deslocamento para paginação in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – hasLoadFilter – registeredBiometricsCount properties: totalPages: type: integer format: int64 description: Número total de páginas totalElements: type: integer format: int64 description: Número total de elementos hasLoadFilter: type: boolean description: Indica se o plano de rotina possui algum filtro de grupo de carga configurado. Quando falso, o plano resolve todas as pessoas do cadastro registeredBiometricsCount: type: integer format: int64 description: Quantidade total de pessoas do plano com biometria registrada (REGISTERED) e não excluída. Considera todo o plano, não apenas a página atual persons: type: array items: type: object allOf: – #/definitions/gryfoPersonRecord description: Pessoas resolvidas pelo grupo de carga 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/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 /patrol/queries/exportPosition: 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 /patrol/queries/exportRoutineTemplate: 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 /patrol/queries/exportScheduling: 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 /patrol/queries/exportContact: 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 /patrol/queries/exportPositionContact: 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 /patrol/queries/exportPhysicalLocation: 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 /patrol/queries/exportChecklistTemplate: 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 /patrol/queries/exportChecklistTemplateItem: 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 /patrol/queries/exportCheckpoint: 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 /patrol/queries/exportRouteCheckpoint: 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 /patrol/queries/exportTour: 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 /patrol/queries/exportTourCheckpoint: 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 /patrol/queries/exportTourSign: 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 /patrol/queries/exportChecklist: 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 /patrol/queries/exportRejectedTour: 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 /patrol/queries/exportPerson: 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 /patrol/queries/exportDocument: 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 /patrol/queries/exportDocumentType: 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 /patrol/queries/exportMobileDevice: 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 /patrol/queries/exportMobileDeviceActivation: 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 /patrol/queries/exportChecklistAttachment: 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 /patrol/queries/exportChecklistNotificationEmail: 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 /patrol/queries/exportIncidentType: 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 /patrol/queries/exportIncident: 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 /patrol/queries/exportMobileDeviceStatus: 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 /patrol/queries/exportHoliday: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/exportHolidayList: 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 /patrol/queries/exportPositionChecklistTemplate: 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 /patrol/queries/exportRoutineAttachment: 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 /patrol/queries/exportTimezone: 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 /patrol/queries/exportLocalTimezone: 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 /patrol/queries/exportChecklistAnswerType: 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 /patrol/queries/exportAnswerOption: 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 /patrol/queries/exportChecklistAnswer: 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 /patrol/queries/exportPpeSupplier: 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 /patrol/queries/exportPpeDeliveryMotive: 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 /patrol/queries/exportChecklistPpeDelivery: 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 /patrol/queries/exportPersonRole: 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 /patrol/queries/exportRole: 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 /patrol/queries/exportRangeIncidentType: 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 /patrol/queries/exportUser: 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 /patrol/queries/exportPrivacyPolicyRead: 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 /patrol/queries/exportVehicle: 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 /patrol/queries/exportLoadPersonFilter: 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 /patrol/queries/exportOrganizationalStructureType: 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 /patrol/queries/exportOrganizationalStructure: 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 /patrol/queries/exportOrganizationalStructurePerson: 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 /patrol/queries/exportGroup: 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 /patrol/queries/exportGroupPerson: 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 /patrol/queries/exportAsset: 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 /patrol/queries/exportBiometricsTemplate: 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 /patrol/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 /patrol/actions/createTours: post: description: Cria as instâncias de rotinas. Esta primitiva é de uso interno e não deve ser utilizada tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – executionDate properties: executionDate: type: string format: date-time description: Data da execução responses: 200: description: Ok schema: type: object properties: successfulSchedules: type: array items: type: integer format: int64 description: Agendamentos processados com sucesso schedulesWithErrors: type: array items: type: integer format: int64 description: Agendamentos processados com erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/finishTour: post: description: Finaliza a rotina em execução\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/tour – Editar tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – deviceUUID – tourId – personId – finishDate – justification properties: deviceUUID: type: string description: Identificador do dispositivo móvel tourId: type: integer format: int64 description: Identificador da rotina personId: type: integer format: int64 description: Identificador da pessoa que finalizou a rotina finishDate: type: string description: Data/hora da finalização da rotina no formato ISO8601 justification: type: string maxLength: 500 description: Justificativa para finalizar a rotina responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/finishTourCheckpoint: post: description: Finaliza um ponto de controle específico sem responder completamente, útil quando não é possível determinar algo durante a execução\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/tour – Editar tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – deviceUUID – tourId – tourCheckpointId – personId – checkInDate – justification properties: deviceUUID: type: string description: Identificador do dispositivo móvel tourId: type: integer format: int64 description: Identificador da rotina tourCheckpointId: type: integer format: int64 description: Identificador do ponto de controle personId: type: integer format: int64 description: Identificador da pessoa que finalizou o ponto de controle checkInDate: type: string description: Data/hora do check-in no formato ISO8601 finishedInDate: type: string description: Data/hora de finalização no formato ISO8601 justification: type: string maxLength: 500 description: Justificativa para finalizar o ponto de controle responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/registerCheckpoints__2: post: description: Registra a execução de uma lista de pontos de controle, sem fazer validação de configuração notas dos checklists realizado.\nDeve ser utilizado a versão 3 deste endpoint(registerCheckpoints__3)\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/tour – Editar tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – deviceUUID – checkpoints properties: deviceUUID: type: string description: Identificador do dispositivo móvel checkpoints: type: array items: type: object allOf: – #/definitions/registerCheckpointRecord minimum: 1 description: Checkpoints responses: 200: description: Ok schema: type: object properties: successfulCheckpoints: type: array items: type: integer format: int64 description: Controles sincronizados com sucesso checkpointsWithErrors: type: array items: type: object allOf: – #/definitions/checkpointsSyncStatusRecord description: Controles sincronizados com erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/registerCheckpoints__3: post: description: Registra a execução de uma lista de pontos de controle, é realizado validação de notas dos checklists realizado.\nRecomenda-se utilização deste endpoint\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/tour – Editar tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – deviceUUID – checkpoints properties: deviceUUID: type: string description: Identificador do dispositivo móvel checkpoints: type: array items: type: object allOf: – #/definitions/registerCheckpointRecord minimum: 1 description: Checkpoints responses: 200: description: Ok schema: type: object properties: successfulCheckpoints: type: array items: type: integer format: int64 description: Controles sincronizados com sucesso checkpointsWithErrors: type: array items: type: object allOf: – #/definitions/checkpointsSyncStatusRecord description: Controles sincronizados com erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/createUnscheduledRoutine: post: description: Cria uma instância de uma rotina não agendada, se este endpoint for chamado informando uma rotina que ainda não foi finalizada o mesmo estará\nretornando a rotina já criada e não será criado uma nova rotina para substiuir a existente\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/tour – Editar\n###Abrangência:\nPlano de rotina e Tipo de plano de rotina tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – routineTemplateId – personId properties: routineTemplateId: type: integer format: int64 description: ID do modelo de rotina personId: type: integer format: int64 description: ID da pessoa responses: 200: description: Ok schema: type: object required: – tourRecord properties: tourRecord: type: object allOf: – #/definitions/tourRecord description: Rotina criada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/getMobileDevice: post: description: Busca um dispositivo móvel\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/mobileDevice – Visualizar tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: mobileDeviceId: type: integer format: int64 description: ID responses: 200: description: Ok schema: type: object required: – mobileDeviceRecord properties: mobileDeviceRecord: type: object allOf: – #/definitions/mobileDeviceRecord description: Dispositivo móvel encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/createMobileDevice: post: description: Cria um dispositivo móvel\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/mobileDevice – Incluir tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – name – active – platform properties: name: type: string maxLength: 255 description: Nome note: type: string maxLength: 255 description: Observação phoneNumber: type: string maxLength: 50 description: Número de telefone com o formato esperado E.164 active: type: boolean description: Estado do dispositivo móvel platform: type: string allOf: – #/definitions/platform description: Plataforma responses: 200: description: Ok schema: type: object required: – mobileDeviceRecord properties: mobileDeviceRecord: type: object allOf: – #/definitions/mobileDeviceRecord description: Dispositivo móvel criado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/updateMobileDevice: post: description: Atualiza um dispositivo móvel\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/mobileDevice – Editar tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – name – active – platform properties: id: type: integer format: int64 description: ID name: type: string maxLength: 255 description: Nome note: type: string maxLength: 255 description: Observação phoneNumber: type: string maxLength: 50 description: Número de telefone com o formato esperado E.164 active: type: boolean description: Estado do dispositivo móvel platform: type: string allOf: – #/definitions/platform description: Plataforma responses: 200: description: Ok schema: type: object required: – mobileDeviceRecord properties: mobileDeviceRecord: type: object allOf: – #/definitions/mobileDeviceRecord description: Dispositivo móvel alterado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/deleteMobileDevice: post: description: Apaga um dispositivo móvel\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/mobileDevice – Excluir tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: mobileDeviceId: type: integer format: int64 description: ID responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/generateActivationCode: post: description: Gera um código de ativação para um dispositivo móvel\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/mobileDevice – Editar tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – mobileDeviceId properties: mobileDeviceId: type: integer format: int64 description: ID do dispositivo móvel responses: 200: description: Ok schema: type: object required: – activationCode properties: activationCode: type: string description: Código de ativação gerado para o dispositivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/activateMobileDevice: post: description: Ativa um dispositivo móvel\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/mobileDevice – Incluir tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – activationCode properties: activationCode: type: string description: Código de ativação responses: 200: description: Ok schema: type: object properties: deviceUUID: type: string description: Identificador gerado para o dispositivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/getChecklistAttachmentUploadUrl: post: description: Retorna a URL para o upload do anexo de um checklist\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/checklistAttachment – Incluir tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – deviceUUID – checklistId – fileName properties: deviceUUID: type: string description: Identificador do dispositivo móvel checklistId: type: string description: Identificador do checklist (ID numérico ou UUID gerado externamente) fileName: type: string description: Nome do arquivo no formato timestamp.extensão responses: 200: description: Ok schema: type: object required: – version – uploadUrl properties: type: string description: Versão do arquivo uploadUrl: type: string description: Url para upload do arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/saveChecklistAttachment: post: description: Salva o anexo de um checklist\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/checklistAttachment – Incluir tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – deviceUUID – checklistId – personId – fileName – version – fileType properties: deviceUUID: type: string description: Identificador do dispositivo móvel checklistId: type: string description: Identificador do checklist (ID numérico ou UUID gerado externamente) personId: type: integer format: int64 description: ID da pessoa fileName: type: string description: Nome do arquivo no formato timestamp.extensão type: string description: Versão do arquivo fileType: type: string allOf: – #/definitions/fileType description: Tipo do arquivo responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/getChecklistAttachmentDownloadUrl: post: description: Retorna a URL para download do anexo de um checklist\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/checklistAttachment – Visualizar tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – checklistId – fileName properties: checklistId: type: integer format: int64 description: ID do checklist fileName: type: string description: Nome do arquivo responses: 200: description: Ok schema: type: object required: – downloadUrl properties: downloadUrl: type: string description: Url para download do arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/createMobileDeviceStatus: post: description: Salva o status do dispositivo móvel tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – mobileDevicesStatus properties: mobileDevicesStatus: type: array items: type: object allOf: – #/definitions/mobileDeviceStatusRecord minimum: 1 description: Lista de records do status dos dispositivos móveis responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/createPerson: post: description: API DEPRECIADA: Serviço descontinuado | DATA: 2023-07-05 | Salva a pessoa tags: – Actions deprecated : true x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – name – documentTypeId – document – user – email properties: name: type: string description: Nome do usuário documentTypeId: type: integer format: int64 description: Identificador do tipo de documento document: type: string description: Número do documento user: type: string description: Usuário da plataforma email: type: string description: E-mail do usuário responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/saveRoutineAttachment: post: description: Salva o anexo de uma rotina\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/tour – Incluir tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – routineId – personId – fileName – version – fileType – deviceUUID properties: routineId: type: integer format: int64 description: ID da rotina personId: type: integer format: int64 description: ID da pessoa fileName: type: string description: Nome do arquivo no formato timestamp.extensão type: string description: Versão do arquivo fileType: type: string allOf: – #/definitions/fileType description: Tipo do arquivo deviceUUID: type: string description: Identificador do dispositivo móvel responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/getRoutineAttachmentUploadUrl: post: description: Retorna a URL para o upload do anexo de uma rotina\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/tour – Incluir tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – routineId – fileName – deviceUUID properties: routineId: type: integer format: int64 description: ID da rotina fileName: type: string description: Nome do arquivo no formato timestamp.extensão deviceUUID: type: string description: Identificador do dispositivo móvel responses: 200: description: Ok schema: type: object required: – version – uploadUrl properties: type: string description: Versão do arquivo uploadUrl: type: string description: Url para upload do arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/getRoutineAttachmentDownloadUrl: post: description: Retorna a URL para download do anexo de uma rotina\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/tour – Incluir tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – routineId – fileName properties: routineId: type: integer format: int64 description: ID da rotina fileName: type: string description: Nome do arquivo responses: 200: description: Ok schema: type: object required: – downloadUrl properties: downloadUrl: type: string description: Url para download do arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/getTourSignPhotoUploadUrl: post: description: Retorna a URL para o upload da foto do contato assinante da rotina\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/tour – Editar tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – routineId – personId properties: routineId: type: integer format: int64 description: ID da rotina personId: type: integer format: int64 description: ID da pessoa responses: 200: description: Ok schema: type: object required: – version – uploadUrl properties: type: string description: Versão do arquivo uploadUrl: type: string description: Url para upload do arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/saveTourSignPhoto: post: description: Salva a foto do contato assinante vinculada à rotina\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/tour – Editar tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – routineId – version – personId properties: routineId: type: integer format: int64 description: ID da rotina type: string description: Versão do arquivo personId: type: integer format: int64 description: ID da pessoa responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/getTourSignPhotoDownloadUrl: post: description: Retorna a URL para download da foto do contato assinante da rotina\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/tour – Editar tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – routineId – personId properties: routineId: type: integer format: int64 description: ID da rotina personId: type: integer format: int64 description: ID da pessoa responses: 200: description: Ok schema: type: object required: – downloadUrl properties: downloadUrl: type: string description: Url para download do arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/getChecklistAnswerAttachmentUploadUrl: post: description: Retorna a URL para o upload do anexo de resposta do checklist\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/tour – Editar tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – checklistId – personId – fileName properties: checklistId: type: integer format: int64 description: ID do checklist personId: type: integer format: int64 description: Identificador da pessoa fileName: type: string description: Nome do arquivo no formato timestamp.extensão responses: 200: description: Ok schema: type: object required: – version – uploadUrl properties: type: string description: Versão do arquivo uploadUrl: type: string description: Url para upload do arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/saveChecklistAnswerAttachment: post: description: Salva o anexo de resposta do checklist\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/tour – Editar tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – checklistId – personId – fileName – version properties: checklistId: type: integer format: int64 description: ID do checklist personId: type: integer format: int64 description: ID da pessoa fileName: type: string description: Nome do arquivo no formato timestamp.extensão type: string description: Versão do arquivo responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/getChecklistAnswerAttachmentDownloadUrl: post: description: Retorna a URL para download do anexo de resposta do checklist\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/tour – Editar tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – checklistId – fileName properties: checklistId: type: integer format: int64 description: ID do checklist fileName: type: string description: Nome do arquivo responses: 200: description: Ok schema: type: object required: – downloadUrl properties: downloadUrl: type: string description: Url para download do arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/syncSignRoutine: post: description: Dispara o fluxo de assinatura facial para a rotina de forma síncrona tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – routineId properties: routineId: type: integer format: int64 description: Identificador da rotina responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/updateChecklistTemplateData: post: description: Atualiza o modelo de checklist.\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/checklistTemplate – Editar\n tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – name – active – checklistType properties: id: type: integer format: int64 description: ID name: type: string maxLength: 50 description: Nome active: type: boolean description: Status do checklist checklistType: type: string allOf: – #/definitions/checklistType description: Tipo do checklist checklistNotificationEmail: type: array items: type: object allOf: – #/definitions/checklistNotificationEmailRecord description: Email para notificação positionChecklistTemplate: type: array items: type: object allOf: – #/definitions/positionChecklistTemplateRecord description: Planos de rotinas vinculados ao checklist responses: 200: description: Ok schema: type: object allOf: – #/definitions/checklistTemplate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/updateChecklistTemplateItemData: post: description: Atualiza o item de um modelo de checklist. Caso o item tenha associação com alguma rotina já realizada, o item será desativado\ne um novo criado.\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/checklistTemplateItem – Editar\n tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – description – attachmentConfig – noteConfig – checklistAnswerType properties: id: type: integer format: int64 description: ID description: type: string maxLength: 255 description: Descrição incidentType: type: object allOf: – #/definitions/incidentTypeRecord description: Tipo de ocorrência attachmentConfig: type: string allOf: – #/definitions/checklistConfig description: Tipos de configuração de anexos noteConfig: type: string allOf: – #/definitions/checklistConfig description: Tipos de configuração de observações notInComplianceValue: type: integer format: int64 description: Somente valores acima deste limite serão considerados conformes para respostas do tipo inteiro checklistAnswerType: type: object allOf: – #/definitions/checklistAnswerTypeRecord description: Tipo de resposta order: type: integer format: int64 description: Ordem responses: 200: description: Ok schema: type: object allOf: – #/definitions/checklistTemplateItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/createChecklistTemplateItemsData: post: description: Cria vários itens de um modelo de checklist. Caso tenha rotinas futuras vinculadas ao modelo do checklist essas serão recriadas.\n###Resources:\nres: res://senior.com.br/sam/patrol/entities/checklistTemplateItem – Incluir\n tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – checklistTemplateId – checklistTemplateItem properties: checklistTemplateId: type: integer format: int64 description: ID do checklist template checklistTemplateItem: type: array items: type: object allOf: – #/definitions/checklistTemplateItemRecord minimum: 1 description: Lista de itens do checklist que será incluído responses: 200: description: Ok schema: type: object required: – items properties: items: type: array items: type: object allOf: – #/definitions/checklistTemplateItem minimum: 1 description: Items de checklists criados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/createChecklistWithAI: post: description: Gera uma lista de itens de checklist com IA a partir de um prompt do usuário tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – prompt – checklistType – questionCount properties: prompt: type: string maxLength: 500 description: Prompt do usuário checklistType: type: string allOf: – #/definitions/checklistType description: Tipo do checklist questionCount: type: integer format: int64 description: Quantidade de perguntas minimum: 1 maximum: 50 responses: 200: description: Ok schema: type: object required: – items properties: items: type: array items: type: object allOf: – #/definitions/checklistTemplateItemRecordIAssist minimum: 1 description: Lista de itens do checklist gerado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/createTrialUserData: post: description: Cria os dados básicos do usuário tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenant – companyName – firstName – lastName – email properties: tenant: type: string description: Tenant que será feito o cadastro do usuário, esse tenant precisa estar com o toggle trial-gestao-rotinas ativo companyName: type: string maxLength: 50 description: Nome da empresa firstName: type: string maxLength: 50 description: Primeiro nome do usuário lastName: type: string maxLength: 50 description: Sobrenome do usuário password: type: string description: Senha do usuário email: type: string description: e-mail do usuário responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /patrol/actions/acceptPrivacyTerm: post: description: Salva os dados do usuário que aceitou os termos da política de privacidade. tags: – Actions x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/createTourDetailsReport: post: description: Cria o relatório assinado para ser assinado digitalmente tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tourId properties: tourId: type: integer format: int64 description: Identificador da rotina responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/saveLoadGroupFilters: post: description: Salva ou remove a configuração de filtros do grupo de carga de um posto. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – positionId properties: positionId: type: integer format: int64 description: ID do plano de rotina addedFilters: type: array items: type: object allOf: – #/definitions/loadFilterRecord description: Filtros a adicionar removedFilters: type: array items: type: object allOf: – #/definitions/loadFilterRecord description: Filtros a remover responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/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 /patrol/actions/importPosition: 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 /patrol/actions/importRoutineTemplate: 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 /patrol/actions/importScheduling: 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 /patrol/actions/importContact: 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 /patrol/actions/importPositionContact: 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 /patrol/actions/importPhysicalLocation: 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 /patrol/actions/importChecklistTemplate: 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 /patrol/actions/importChecklistTemplateItem: 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 /patrol/actions/importCheckpoint: 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 /patrol/actions/importRouteCheckpoint: 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 /patrol/actions/importTour: 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 /patrol/actions/importTourCheckpoint: 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 /patrol/actions/importTourSign: 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 /patrol/actions/importChecklist: 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 /patrol/actions/importRejectedTour: 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 /patrol/actions/importPerson: 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 /patrol/actions/importDocument: 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 /patrol/actions/importDocumentType: 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 /patrol/actions/importMobileDevice: 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 /patrol/actions/importMobileDeviceActivation: 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 /patrol/actions/importChecklistAttachment: 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 /patrol/actions/importChecklistNotificationEmail: 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 /patrol/actions/importIncidentType: 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 /patrol/actions/importIncident: 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 /patrol/actions/importMobileDeviceStatus: 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 /patrol/actions/importHoliday: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/importHolidayList: 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 /patrol/actions/importPositionChecklistTemplate: 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 /patrol/actions/importRoutineAttachment: 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 /patrol/actions/importTimezone: 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 /patrol/actions/importLocalTimezone: 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 /patrol/actions/importChecklistAnswerType: 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 /patrol/actions/importAnswerOption: 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 /patrol/actions/importChecklistAnswer: 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 /patrol/actions/importPpeSupplier: 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 /patrol/actions/importPpeDeliveryMotive: 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 /patrol/actions/importChecklistPpeDelivery: 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 /patrol/actions/importPersonRole: 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 /patrol/actions/importRole: 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 /patrol/actions/importRangeIncidentType: 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 /patrol/actions/importUser: 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 /patrol/actions/importPrivacyPolicyRead: 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 /patrol/actions/importVehicle: 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 /patrol/actions/importLoadPersonFilter: 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 /patrol/actions/importOrganizationalStructureType: 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 /patrol/actions/importOrganizationalStructure: 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 /patrol/actions/importOrganizationalStructurePerson: 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 /patrol/actions/importGroup: 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 /patrol/actions/importGroupPerson: 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 /patrol/actions/importAsset: 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 /patrol/actions/importBiometricsTemplate: 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 /patrol/signals/findNotCarriedOutRoutines: post: description: Busca as rotinas não executadas ou pendentes tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /patrol/signals/signRoutine: post: description: Dispara o fluxo de assinatura facial para a rotina de forma assíncrona tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – routineId properties: routineId: type: integer format: int64 description: Identificador da rotina responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /patrol/signals/syncPersonalProtectiveEquipmentDelivery: post: description: Sincroniza as informações da entrega de EPI com o serviço face-dispatch-epi-backend tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – checklistIds properties: checklistIds: type: array items: type: string minimum: 1 description: responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /patrol/signals/enrollPersonFacialBiometry: post: description: Registra ou atualiza a biometria facial da pessoa na Gryfo, usando a foto da biometria replicada do Foundation, e grava a situação do registro (com o motivo, em caso de falha) tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – personIds properties: personIds: type: array items: type: integer format: int64 minimum: 1 description: Identificadores das pessoas no GRS responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /patrol/signals/removePersonFacialBiometry: post: description: Remove a biometria facial das pessoas na Gryfo tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – personIds properties: personIds: type: array items: type: integer format: int64 minimum: 1 description: Identificadores das pessoas no GRS responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /patrol/events/checklistThatGeneratesIncidentRegistered: post: description: Checklist configurado para registrar ocorrências registrado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – checklist properties: checklist: type: object allOf: – #/definitions/checklistThatGeneratesIncidentRecord description: Checklist em não conformidade responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/routineFinishWithoutSynchronization: post: description: Rotina finalizada e enviada com sincronização atrasada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – routine properties: routine: type: object allOf: – #/definitions/routineThatClosedIncidentRecord description: Rotina finalizada sem sincronização responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/routinesThatGeneratesIncident: post: description: Rotinas que gerarão incidentes x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object properties: ids: type: array items: type: integer format: int64 description: Lista de Ids das rotinas responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/finishedRoutines: post: description: Rotinas que foram concluídas ou finalizadas x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – finishedRoutines properties: finishedRoutines: type: array items: type: object allOf: – #/definitions/finishedRoutinesRecord minimum: 1 description: Lista das rotinas concluídas ou finalizadas responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/importPositionEvent: 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 /patrol/events/exportPositionEvent: 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 /patrol/events/importRoutineTemplateEvent: 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 /patrol/events/exportRoutineTemplateEvent: 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 /patrol/events/importSchedulingEvent: 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 /patrol/events/exportSchedulingEvent: 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 /patrol/events/importContactEvent: 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 /patrol/events/exportContactEvent: 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 /patrol/events/importPositionContactEvent: 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 /patrol/events/exportPositionContactEvent: 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 /patrol/events/importPhysicalLocationEvent: 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 /patrol/events/exportPhysicalLocationEvent: 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 /patrol/events/importChecklistTemplateEvent: 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 /patrol/events/exportChecklistTemplateEvent: 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 /patrol/events/importChecklistTemplateItemEvent: 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 /patrol/events/exportChecklistTemplateItemEvent: 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 /patrol/events/importCheckpointEvent: 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 /patrol/events/exportCheckpointEvent: 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 /patrol/events/importRouteCheckpointEvent: 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 /patrol/events/exportRouteCheckpointEvent: 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 /patrol/events/importTourEvent: 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 /patrol/events/exportTourEvent: 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 /patrol/events/importTourCheckpointEvent: 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 /patrol/events/exportTourCheckpointEvent: 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 /patrol/events/importTourSignEvent: 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 /patrol/events/exportTourSignEvent: 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 /patrol/events/importChecklistEvent: 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 /patrol/events/exportChecklistEvent: 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 /patrol/events/importRejectedTourEvent: 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 /patrol/events/exportRejectedTourEvent: 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 /patrol/events/importPersonEvent: 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 /patrol/events/exportPersonEvent: 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 /patrol/events/importDocumentEvent: 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 /patrol/events/exportDocumentEvent: 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 /patrol/events/importDocumentTypeEvent: 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 /patrol/events/exportDocumentTypeEvent: 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 /patrol/events/importMobileDeviceEvent: 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 /patrol/events/exportMobileDeviceEvent: 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 /patrol/events/importMobileDeviceActivationEvent: 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 /patrol/events/exportMobileDeviceActivationEvent: 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 /patrol/events/importChecklistAttachmentEvent: 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 /patrol/events/exportChecklistAttachmentEvent: 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 /patrol/events/importChecklistNotificationEmailEvent: 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 /patrol/events/exportChecklistNotificationEmailEvent: 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 /patrol/events/importIncidentTypeEvent: 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 /patrol/events/exportIncidentTypeEvent: 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 /patrol/events/importIncidentEvent: 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 /patrol/events/exportIncidentEvent: 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 /patrol/events/importMobileDeviceStatusEvent: 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 /patrol/events/exportMobileDeviceStatusEvent: 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 /patrol/events/importHolidayEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/exportHolidayEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/importHolidayListEvent: 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 /patrol/events/exportHolidayListEvent: 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 /patrol/events/importPositionChecklistTemplateEvent: 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 /patrol/events/exportPositionChecklistTemplateEvent: 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 /patrol/events/importRoutineAttachmentEvent: 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 /patrol/events/exportRoutineAttachmentEvent: 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 /patrol/events/importTimezoneEvent: 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 /patrol/events/exportTimezoneEvent: 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 /patrol/events/importLocalTimezoneEvent: 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 /patrol/events/exportLocalTimezoneEvent: 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 /patrol/events/importChecklistAnswerTypeEvent: 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 /patrol/events/exportChecklistAnswerTypeEvent: 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 /patrol/events/importAnswerOptionEvent: 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 /patrol/events/exportAnswerOptionEvent: 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 /patrol/events/importChecklistAnswerEvent: 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 /patrol/events/exportChecklistAnswerEvent: 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 /patrol/events/importPpeSupplierEvent: 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 /patrol/events/exportPpeSupplierEvent: 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 /patrol/events/importPpeDeliveryMotiveEvent: 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 /patrol/events/exportPpeDeliveryMotiveEvent: 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 /patrol/events/importChecklistPpeDeliveryEvent: 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 /patrol/events/exportChecklistPpeDeliveryEvent: 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 /patrol/events/importPersonRoleEvent: 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 /patrol/events/exportPersonRoleEvent: 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 /patrol/events/importRoleEvent: 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 /patrol/events/exportRoleEvent: 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 /patrol/events/importRangeIncidentTypeEvent: 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 /patrol/events/exportRangeIncidentTypeEvent: 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 /patrol/events/importUserEvent: 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 /patrol/events/exportUserEvent: 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 /patrol/events/importPrivacyPolicyReadEvent: 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 /patrol/events/exportPrivacyPolicyReadEvent: 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 /patrol/events/importVehicleEvent: 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 /patrol/events/exportVehicleEvent: 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 /patrol/events/importLoadPersonFilterEvent: 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 /patrol/events/exportLoadPersonFilterEvent: 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 /patrol/events/importOrganizationalStructureTypeEvent: 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 /patrol/events/exportOrganizationalStructureTypeEvent: 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 /patrol/events/importOrganizationalStructureEvent: 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 /patrol/events/exportOrganizationalStructureEvent: 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 /patrol/events/importOrganizationalStructurePersonEvent: 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 /patrol/events/exportOrganizationalStructurePersonEvent: 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 /patrol/events/importGroupEvent: 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 /patrol/events/exportGroupEvent: 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 /patrol/events/importGroupPersonEvent: 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 /patrol/events/exportGroupPersonEvent: 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 /patrol/events/importAssetEvent: 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 /patrol/events/exportAssetEvent: 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 /patrol/events/importBiometricsTemplateEvent: 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 /patrol/events/exportBiometricsTemplateEvent: 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 /patrol/apis/routineTemplate: post: description: Serviço de fachada para template de rotinas tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/routineTemplateFacadeInput responses: 200: description: Ok schema: #/definitions/routineTemplateFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Serviço de fachada para template de rotinas tags: – APIS x-senior-visibility: PUBLIC 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/routineTemplateFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/apis/routineTemplate/{id}: get: description: Serviço de fachada para template de rotinas tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/routineTemplateFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Serviço de fachada para template de rotinas tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/routineTemplateFacadeInput responses: 200: description: Ok schema: #/definitions/routineTemplateFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Serviço de fachada para template de rotinas tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/position: 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/position responses: 200: description: The created resource schema: #/definitions/position 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/position responses: 200: description: The created resource schema: #/definitions/position 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/position 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/position/{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/editPosition responses: 200: description: Ok schema: #/definitions/editPosition 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/position responses: 200: description: Ok schema: #/definitions/position 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/position 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 /patrol/entities/position/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/position responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/position/{parentId}/routineTemplates: 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/routineTemplate responses: 200: description: The created resources schema: type: array items: #/definitions/routineTemplate 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/routineTemplate responses: 200: description: The created resources schema: type: array items: #/definitions/routineTemplate 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/routineTemplate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/position/{parentId}/routineTemplates/{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/editRoutineTemplate responses: 200: description: Ok schema: #/definitions/editRoutineTemplate 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/routineTemplate responses: 200: description: Ok schema: #/definitions/routineTemplate 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/routineTemplate 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 /patrol/entities/routineTemplate/{parentId}/schedules: 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/scheduling responses: 200: description: The created resources schema: type: array items: #/definitions/scheduling 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/scheduling responses: 200: description: The created resources schema: type: array items: #/definitions/scheduling 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/scheduling 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/routineTemplate/{parentId}/schedules/{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/editScheduling responses: 200: description: Ok schema: #/definitions/editScheduling 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/scheduling responses: 200: description: Ok schema: #/definitions/scheduling 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/scheduling 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 /patrol/entities/contact: 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/contact responses: 200: description: The created resource schema: #/definitions/contact 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/contact responses: 200: description: The created resource schema: #/definitions/contact 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/contact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/contact/{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/editContact responses: 200: description: Ok schema: #/definitions/editContact 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/contact responses: 200: description: Ok schema: #/definitions/contact 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/contact 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 /patrol/entities/contact/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/contact responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/positionContact: 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/positionContact responses: 200: description: The created resource schema: #/definitions/positionContact 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/positionContact responses: 200: description: The created resource schema: #/definitions/positionContact 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/positionContact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/positionContact/{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/editPositionContact responses: 200: description: Ok schema: #/definitions/editPositionContact 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/positionContact responses: 200: description: Ok schema: #/definitions/positionContact 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/positionContact 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 /patrol/entities/position/{parentId}/positionContact: 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/positionContact responses: 200: description: The created resources schema: type: array items: #/definitions/positionContact 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/positionContact responses: 200: description: The created resources schema: type: array items: #/definitions/positionContact 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/positionContact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/contact/{parentId}/positionContact: 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/positionContact responses: 200: description: The created resources schema: type: array items: #/definitions/positionContact 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/positionContact responses: 200: description: The created resources schema: type: array items: #/definitions/positionContact 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/positionContact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/position/{parentId}/positionContact/{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/editPositionContact responses: 200: description: Ok schema: #/definitions/editPositionContact 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/positionContact responses: 200: description: Ok schema: #/definitions/positionContact 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/positionContact 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 /patrol/entities/contact/{parentId}/positionContact/{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/editPositionContact responses: 200: description: Ok schema: #/definitions/editPositionContact 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/positionContact responses: 200: description: Ok schema: #/definitions/positionContact 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/positionContact 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 /patrol/entities/positionContact/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/positionContact responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/physicalLocation: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/physicalLocation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/checklistTemplate: 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/checklistTemplate responses: 200: description: The created resource schema: #/definitions/checklistTemplate 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/checklistTemplate responses: 200: description: The created resource schema: #/definitions/checklistTemplate 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/checklistTemplate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/checklistTemplate/{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/editChecklistTemplate responses: 200: description: Ok schema: #/definitions/editChecklistTemplate 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/checklistTemplate responses: 200: description: Ok schema: #/definitions/checklistTemplate 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/checklistTemplate 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 /patrol/entities/checklistTemplate/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/checklistTemplate responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/checklistTemplateItem: 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/checklistTemplateItem responses: 200: description: The created resource schema: #/definitions/checklistTemplateItem 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/checklistTemplateItem responses: 200: description: The created resource schema: #/definitions/checklistTemplateItem 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/checklistTemplateItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/checklistTemplateItem/{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/editChecklistTemplateItem responses: 200: description: Ok schema: #/definitions/editChecklistTemplateItem 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/checklistTemplateItem responses: 200: description: Ok schema: #/definitions/checklistTemplateItem 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/checklistTemplateItem 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 /patrol/entities/checklistTemplate/{parentId}/items: 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/checklistTemplateItem responses: 200: description: The created resources schema: type: array items: #/definitions/checklistTemplateItem 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/checklistTemplateItem responses: 200: description: The created resources schema: type: array items: #/definitions/checklistTemplateItem 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/checklistTemplateItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/checklistTemplate/{parentId}/items/{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/editChecklistTemplateItem responses: 200: description: Ok schema: #/definitions/editChecklistTemplateItem 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/checklistTemplateItem responses: 200: description: Ok schema: #/definitions/checklistTemplateItem 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/checklistTemplateItem 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 /patrol/entities/checklistTemplateItem/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/checklistTemplateItem responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/checkpoint: 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/checkpoint responses: 200: description: The created resource schema: #/definitions/checkpoint 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/checkpoint responses: 200: description: The created resource schema: #/definitions/checkpoint 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/checkpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/checkpoint/{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/editCheckpoint responses: 200: description: Ok schema: #/definitions/editCheckpoint 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/checkpoint responses: 200: description: Ok schema: #/definitions/checkpoint 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/checkpoint 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 /patrol/entities/position/{parentId}/checkpoints: 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/checkpoint responses: 200: description: The created resources schema: type: array items: #/definitions/checkpoint 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/checkpoint responses: 200: description: The created resources schema: type: array items: #/definitions/checkpoint 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/checkpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/position/{parentId}/checkpoints/{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/editCheckpoint responses: 200: description: Ok schema: #/definitions/editCheckpoint 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/checkpoint responses: 200: description: Ok schema: #/definitions/checkpoint 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/checkpoint 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 /patrol/entities/checkpoint/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/checkpoint responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/routineTemplate/{parentId}/routeCheckpoint: 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/routeCheckpoint responses: 200: description: The created resources schema: type: array items: #/definitions/routeCheckpoint 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/routeCheckpoint responses: 200: description: The created resources schema: type: array items: #/definitions/routeCheckpoint 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/routeCheckpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/checkpoint/{parentId}/routeCheckpoint: 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/routeCheckpoint responses: 200: description: The created resources schema: type: array items: #/definitions/routeCheckpoint 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/routeCheckpoint responses: 200: description: The created resources schema: type: array items: #/definitions/routeCheckpoint 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/routeCheckpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/routineTemplate/{parentId}/routeCheckpoint/{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/editRouteCheckpoint responses: 200: description: Ok schema: #/definitions/editRouteCheckpoint 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/routeCheckpoint responses: 200: description: Ok schema: #/definitions/routeCheckpoint 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/routeCheckpoint 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 /patrol/entities/checkpoint/{parentId}/routeCheckpoint/{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/editRouteCheckpoint responses: 200: description: Ok schema: #/definitions/editRouteCheckpoint 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/routeCheckpoint responses: 200: description: Ok schema: #/definitions/routeCheckpoint 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/routeCheckpoint 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 /patrol/entities/tour: 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/tour responses: 200: description: The created resource schema: #/definitions/tour 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/tour responses: 200: description: The created resource schema: #/definitions/tour 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/tour 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/tour/{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/editTour responses: 200: description: Ok schema: #/definitions/editTour 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/tour responses: 200: description: Ok schema: #/definitions/tour 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/tour 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 /patrol/entities/routineTemplate/{parentId}/tours: 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/tour responses: 200: description: The created resources schema: type: array items: #/definitions/tour 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/tour responses: 200: description: The created resources schema: type: array items: #/definitions/tour 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/tour 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/scheduling/{parentId}/tours: 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/tour responses: 200: description: The created resources schema: type: array items: #/definitions/tour 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/tour responses: 200: description: The created resources schema: type: array items: #/definitions/tour 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/tour 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/routineTemplate/{parentId}/tours/{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/editTour responses: 200: description: Ok schema: #/definitions/editTour 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/tour responses: 200: description: Ok schema: #/definitions/tour 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/tour 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 /patrol/entities/scheduling/{parentId}/tours/{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/editTour responses: 200: description: Ok schema: #/definitions/editTour 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/tour responses: 200: description: Ok schema: #/definitions/tour 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/tour 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 /patrol/entities/tour/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/tour responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/checkpoint/{parentId}/tourCheckpoints: 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/tourCheckpoint responses: 200: description: The created resources schema: type: array items: #/definitions/tourCheckpoint 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/tourCheckpoint responses: 200: description: The created resources schema: type: array items: #/definitions/tourCheckpoint 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/tourCheckpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/tour/{parentId}/checkpoints: 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/tourCheckpoint responses: 200: description: The created resources schema: type: array items: #/definitions/tourCheckpoint 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/tourCheckpoint responses: 200: description: The created resources schema: type: array items: #/definitions/tourCheckpoint 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/tourCheckpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/checkpoint/{parentId}/tourCheckpoints/{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/editTourCheckpoint responses: 200: description: Ok schema: #/definitions/editTourCheckpoint 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/tourCheckpoint responses: 200: description: Ok schema: #/definitions/tourCheckpoint 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/tourCheckpoint 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 /patrol/entities/tour/{parentId}/checkpoints/{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/editTourCheckpoint responses: 200: description: Ok schema: #/definitions/editTourCheckpoint 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/tourCheckpoint responses: 200: description: Ok schema: #/definitions/tourCheckpoint 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/tourCheckpoint 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 /patrol/entities/tourSign: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/tourSign 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/tourCheckpoint/{parentId}/checklists: 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/checklist responses: 200: description: The created resources schema: type: array items: #/definitions/checklist 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/checklist responses: 200: description: The created resources schema: type: array items: #/definitions/checklist 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/checklist 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/tourCheckpoint/{parentId}/checklists/{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/editChecklist responses: 200: description: Ok schema: #/definitions/editChecklist 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/checklist responses: 200: description: Ok schema: #/definitions/checklist 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/checklist 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 /patrol/entities/rejectedTour: 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/rejectedTour 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/person: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/person 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/document: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/document responses: 200: description: The created resource schema: #/definitions/document 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/document responses: 200: description: The created resource schema: #/definitions/document 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/document 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/document/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editDocument responses: 200: description: Ok schema: #/definitions/editDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/document responses: 200: description: Ok schema: #/definitions/document 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/document 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/person/{parentId}/documents: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/document responses: 200: description: The created resources schema: type: array items: #/definitions/document 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/document responses: 200: description: The created resources schema: type: array items: #/definitions/document 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/document 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/person/{parentId}/documents/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editDocument responses: 200: description: Ok schema: #/definitions/editDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/document responses: 200: description: Ok schema: #/definitions/document 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/document 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/document/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/document responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/mobileDevice: 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/mobileDevice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/mobileDeviceActivation: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/mobileDeviceActivation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/mobileDevice/{parentId}/activations: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/mobileDeviceActivation responses: 200: description: The created resources schema: type: array items: #/definitions/mobileDeviceActivation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/mobileDeviceActivation responses: 200: description: The created resources schema: type: array items: #/definitions/mobileDeviceActivation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/mobileDeviceActivation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/mobileDevice/{parentId}/activations/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editMobileDeviceActivation responses: 200: description: Ok schema: #/definitions/editMobileDeviceActivation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/mobileDeviceActivation responses: 200: description: Ok schema: #/definitions/mobileDeviceActivation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/mobileDeviceActivation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/checklist/{parentId}/attachments: 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/checklistAttachment responses: 200: description: The created resources schema: type: array items: #/definitions/checklistAttachment 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/checklistAttachment responses: 200: description: The created resources schema: type: array items: #/definitions/checklistAttachment 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/checklistAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/checklist/{parentId}/attachments/{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/editChecklistAttachment responses: 200: description: Ok schema: #/definitions/editChecklistAttachment 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/checklistAttachment responses: 200: description: Ok schema: #/definitions/checklistAttachment 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/checklistAttachment 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 /patrol/entities/checklistNotificationEmail: 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/checklistNotificationEmail responses: 200: description: The created resource schema: #/definitions/checklistNotificationEmail 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/checklistNotificationEmail responses: 200: description: The created resource schema: #/definitions/checklistNotificationEmail 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/checklistNotificationEmail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/checklistNotificationEmail/{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/editChecklistNotificationEmail responses: 200: description: Ok schema: #/definitions/editChecklistNotificationEmail 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/checklistNotificationEmail responses: 200: description: Ok schema: #/definitions/checklistNotificationEmail 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/checklistNotificationEmail 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 /patrol/entities/checklistTemplate/{parentId}/checklistNotificationEmail: 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/checklistNotificationEmail responses: 200: description: The created resources schema: type: array items: #/definitions/checklistNotificationEmail 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/checklistNotificationEmail responses: 200: description: The created resources schema: type: array items: #/definitions/checklistNotificationEmail 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/checklistNotificationEmail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/checklistTemplate/{parentId}/checklistNotificationEmail/{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/editChecklistNotificationEmail responses: 200: description: Ok schema: #/definitions/editChecklistNotificationEmail 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/checklistNotificationEmail responses: 200: description: Ok schema: #/definitions/checklistNotificationEmail 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/checklistNotificationEmail 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 /patrol/entities/checklistNotificationEmail/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/checklistNotificationEmail responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/incidentType: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/incidentType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/mobileDeviceStatus: 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/mobileDeviceStatus 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/mobileDevice/{parentId}/mobileDeviceStatus: 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/mobileDeviceStatus responses: 200: description: The created resources schema: type: array items: #/definitions/mobileDeviceStatus 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/mobileDeviceStatus responses: 200: description: The created resources schema: type: array items: #/definitions/mobileDeviceStatus 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/mobileDeviceStatus 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/mobileDevice/{parentId}/mobileDeviceStatus/{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/editMobileDeviceStatus responses: 200: description: Ok schema: #/definitions/editMobileDeviceStatus 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/mobileDeviceStatus responses: 200: description: Ok schema: #/definitions/mobileDeviceStatus 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/mobileDeviceStatus 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 /patrol/entities/holiday: 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/holiday 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/holidayList/{parentId}/holiday: 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/holiday responses: 200: description: The created resources schema: type: array items: #/definitions/holiday 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/holiday responses: 200: description: The created resources schema: type: array items: #/definitions/holiday 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/holiday 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/holidayList/{parentId}/holiday/{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/editHoliday responses: 200: description: Ok schema: #/definitions/editHoliday 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/holiday responses: 200: description: Ok schema: #/definitions/holiday 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/holiday 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 /patrol/entities/holidayList: 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/holidayList 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/positionChecklistTemplate: 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/positionChecklistTemplate responses: 200: description: The created resource schema: #/definitions/positionChecklistTemplate 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/positionChecklistTemplate responses: 200: description: The created resource schema: #/definitions/positionChecklistTemplate 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/positionChecklistTemplate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/positionChecklistTemplate/{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/editPositionChecklistTemplate responses: 200: description: Ok schema: #/definitions/editPositionChecklistTemplate 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/positionChecklistTemplate responses: 200: description: Ok schema: #/definitions/positionChecklistTemplate 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/positionChecklistTemplate 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 /patrol/entities/position/{parentId}/positionChecklistTemplate: 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/positionChecklistTemplate responses: 200: description: The created resources schema: type: array items: #/definitions/positionChecklistTemplate 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/positionChecklistTemplate responses: 200: description: The created resources schema: type: array items: #/definitions/positionChecklistTemplate 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/positionChecklistTemplate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/checklistTemplate/{parentId}/positionChecklistTemplate: 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/positionChecklistTemplate responses: 200: description: The created resources schema: type: array items: #/definitions/positionChecklistTemplate 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/positionChecklistTemplate responses: 200: description: The created resources schema: type: array items: #/definitions/positionChecklistTemplate 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/positionChecklistTemplate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/position/{parentId}/positionChecklistTemplate/{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/editPositionChecklistTemplate responses: 200: description: Ok schema: #/definitions/editPositionChecklistTemplate 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/positionChecklistTemplate responses: 200: description: Ok schema: #/definitions/positionChecklistTemplate 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/positionChecklistTemplate 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 /patrol/entities/checklistTemplate/{parentId}/positionChecklistTemplate/{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/editPositionChecklistTemplate responses: 200: description: Ok schema: #/definitions/editPositionChecklistTemplate 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/positionChecklistTemplate responses: 200: description: Ok schema: #/definitions/positionChecklistTemplate 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/positionChecklistTemplate 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 /patrol/entities/positionChecklistTemplate/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/positionChecklistTemplate responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/tour/{parentId}/attachments: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/routineAttachment responses: 200: description: The created resources schema: type: array items: #/definitions/routineAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/routineAttachment responses: 200: description: The created resources schema: type: array items: #/definitions/routineAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/routineAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/tour/{parentId}/attachments/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editRoutineAttachment responses: 200: description: Ok schema: #/definitions/editRoutineAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/routineAttachment responses: 200: description: Ok schema: #/definitions/routineAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/routineAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/checklistAnswerType: 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/checklistAnswerType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/answerOption: 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/answerOption 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/checklistAnswerType/{parentId}/answerOptions: 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/answerOption responses: 200: description: The created resources schema: type: array items: #/definitions/answerOption 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/answerOption responses: 200: description: The created resources schema: type: array items: #/definitions/answerOption 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/answerOption 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/checklistAnswerType/{parentId}/answerOptions/{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/editAnswerOption responses: 200: description: Ok schema: #/definitions/editAnswerOption 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/answerOption responses: 200: description: Ok schema: #/definitions/answerOption 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/answerOption 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 /patrol/entities/checklistAnswer: 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/checklistAnswer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/checklist/{parentId}/checklistAnswer: 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/checklistAnswer responses: 200: description: The created resources schema: type: array items: #/definitions/checklistAnswer 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/checklistAnswer responses: 200: description: The created resources schema: type: array items: #/definitions/checklistAnswer 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/checklistAnswer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/checklist/{parentId}/checklistAnswer/{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/editChecklistAnswer responses: 200: description: Ok schema: #/definitions/editChecklistAnswer 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/checklistAnswer responses: 200: description: Ok schema: #/definitions/checklistAnswer 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/checklistAnswer 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 /patrol/entities/personRole: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/personRole responses: 200: description: The created resource schema: #/definitions/personRole 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/personRole responses: 200: description: The created resource schema: #/definitions/personRole 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/personRole 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/personRole/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editPersonRole responses: 200: description: Ok schema: #/definitions/editPersonRole 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/personRole responses: 200: description: Ok schema: #/definitions/personRole 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/personRole 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/person/{parentId}/personRoles: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/personRole responses: 200: description: The created resources schema: type: array items: #/definitions/personRole 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/personRole responses: 200: description: The created resources schema: type: array items: #/definitions/personRole 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/personRole 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/role/{parentId}/personRoles: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/personRole responses: 200: description: The created resources schema: type: array items: #/definitions/personRole 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/personRole responses: 200: description: The created resources schema: type: array items: #/definitions/personRole 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/personRole 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/person/{parentId}/personRoles/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editPersonRole responses: 200: description: Ok schema: #/definitions/editPersonRole 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/personRole responses: 200: description: Ok schema: #/definitions/personRole 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/personRole 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/role/{parentId}/personRoles/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editPersonRole responses: 200: description: Ok schema: #/definitions/editPersonRole 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/personRole responses: 200: description: Ok schema: #/definitions/personRole 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/personRole 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/personRole/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/personRole responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/role/{parentId}/rangeIncidentTypes: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/rangeIncidentType responses: 200: description: The created resources schema: type: array items: #/definitions/rangeIncidentType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/rangeIncidentType responses: 200: description: The created resources schema: type: array items: #/definitions/rangeIncidentType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/rangeIncidentType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/role/{parentId}/rangeIncidentTypes/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editRangeIncidentType responses: 200: description: Ok schema: #/definitions/editRangeIncidentType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/rangeIncidentType responses: 200: description: Ok schema: #/definitions/rangeIncidentType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/rangeIncidentType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/vehicle: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/vehicle 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/organizationalStructurePerson: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/organizationalStructurePerson 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/organizationalStructurePerson/{id}: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/organizationalStructurePerson 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/asset: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/asset 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/asset/{id}: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/asset 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/biometricsTemplate: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/biometricsTemplate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/biometricsTemplate/{id}: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/biometricsTemplate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: healthcheckStatus: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Executando normalmente * `DOWN` – Com problemas loadFilterType: type: string enum: – ROLE – ORGANIZATIONAL_STRUCTURE – GROUP – SITUATION – PHOTO_READY – LAST_LOCAL_ACCESS – PERSON_INCLUDED – PERSON_EXCLUDED description: Tipos de filtro para o grupo de carga do reconhecimento facial: * `ROLE` – Filtro por papel — valor = id do papel * `ORGANIZATIONAL_STRUCTURE` – Filtro por estrutura organizacional — valor = id da estrutura * `GROUP` – Filtro por grupo (agrupador) — valor = id do agrupador * `SITUATION` – Filtro por situação — valor = 0 (inativo) ou 1 (ativo) * `PHOTO_READY` – Filtro por foto apta ao reconhecimento — valor = 0 (inativo) ou 1 (ativo) * `LAST_LOCAL_ACCESS` – Filtro por último acesso no local — valor = id do local * `PERSON_INCLUDED` – Inclusão manual de pessoa — valor = id da pessoa * `PERSON_EXCLUDED` – Exclusão manual de pessoa — valor = id da pessoa platform: type: string enum: – ANDROID – IOS description: Plataforma do dispositivo móvel: * `ANDROID` – Android * `IOS` – IOS weekDay: type: string enum: – SUNDAY – MONDAY – TUESDAY – WEDNESDAY – THURSDAY – FRIDAY – SATURDAY description: Dias da semana: * `SUNDAY` – Domingo * `MONDAY` – Segunda-feira * `TUESDAY` – Terça-feira * `WEDNESDAY` – Quarta-feira * `THURSDAY` – Quinta-feira * `FRIDAY` – Sexta-feira * `SATURDAY` – Sábado weeklyOrdinal: type: string enum: – FIRST – SECOND – THIRD – FOURTH – LAST description: Ordinal de qual semana no mês: * `FIRST` – Primeira semana do mês * `SECOND` – Segunda semana do mês * `THIRD` – Terceira semana do mês * `FOURTH` – Quarta semana do mês * `LAST` – Última semana do mês complianceType: type: string enum: – COMPLIANCE – NOT_IN_COMPLIANCE – NEUTRAL description: Tipo de conformidade da opções de resposta do checklist: * `COMPLIANCE` – Conforme * `NOT_IN_COMPLIANCE` – Não conforme * `NEUTRAL` – Neutro validationType: type: string enum: – QRCODE – GEOLOCATION – BASIC description: Tipo de validação do Checkpoint: * `QRCODE` – QRCode * `GEOLOCATION` – Geolocalização * `BASIC` – Ponto de Controle sem validação checkpointType: type: string enum: – CUSTOM – ASSET – PHYSICAL_LOCATION – PERSON – VEHICLE description: Tipo do ponto de controle: * `CUSTOM` – Personalizado * `ASSET` – Ativos * `PHYSICAL_LOCATION` – Local físico * `PERSON` – Pessoa * `VEHICLE` – Veículo tourStatus: type: string enum: – PENDING – IN_PROGRESS – FINISHED_SUCCESSFULLY – INCOMPLETE – INTERRUPTED – NOT_CARRIED_OUT – FINISHED_PARTIALLY description: Status da rotina: * `PENDING` – Pendente * `IN_PROGRESS` – Em andamento * `FINISHED_SUCCESSFULLY` – Concluída com sucesso * `INCOMPLETE` – Incompleta * `INTERRUPTED` – Interrompida * `NOT_CARRIED_OUT` – Não realizada * `FINISHED_PARTIALLY` – Finalizada parcialmente recurrenceType: type: string enum: – DAILY – WEEKLY – HOLIDAY – MONTHLY description: Tipo de recorrência: * `DAILY` – Diária * `WEEKLY` – Semanal * `HOLIDAY` – Feriado * `MONTHLY` – Mensal checklistSituation: type: string enum: – OK – NOK description: Situação do checklist: * `OK` – OK * `NOK` – Não OK rejectedReason: type: string enum: – NOT_FOUND – EXECUTED – PERSON_NOT_FOUND – INVALID_DATE_TIME – OUTSIDE_OF_DEFINED_TIME – MOBILE_DEVICE_NOT_FOUND – INCONSISTENT_CHECKLISTS – ATTACHMENT_NOT_FOUND – NOTE_NOT_FOUND – ANSWER_OPTION_NOT_FOUND – CHECKLIST_WITHOUT_ANSWER – CHECKLIST_ANSWER_OUTSIDE_THE_RANGE – PERSON_NOT_LINKED_TO_CHECKPOINT – VEHICLE_NOT_LINKED_TO_CHECKPOINT – VEHICLE_NOT_FOUND – INVALID_JUSTIFICATION – PPE_DELIVERY_MOTIVE_NOT_FOUND – PPE_DELIVERY_SUPPLIER_NOT_FOUND – FINISHED_DATE_BEFORE_CHECKIN description: Motivos das rotinas serem rejeitadas: * `NOT_FOUND` – Rotina não encontrada * `EXECUTED` – Rotina já executada * `PERSON_NOT_FOUND` – Pessoa não encontrada * `INVALID_DATE_TIME` – Data/hora inválida * `OUTSIDE_OF_DEFINED_TIME` – Fora do tempo definido * `MOBILE_DEVICE_NOT_FOUND` – Dispositivo móvel não encontrado * `INCONSISTENT_CHECKLISTS` – Checklists enviados estão diferentes do que deveria ser * `ATTACHMENT_NOT_FOUND` – Não encontrado anexo obrigatório no checklist * `NOTE_NOT_FOUND` – Não encontrada observação obrigatória no checklist * `ANSWER_OPTION_NOT_FOUND` – Não encontrada a opção da resposta * `CHECKLIST_WITHOUT_ANSWER` – O Checklist está sem resposta * `CHECKLIST_ANSWER_OUTSIDE_THE_RANGE` – A resposta do checklist está fora do intervalo permitido * `PERSON_NOT_LINKED_TO_CHECKPOINT` – Pessoa inspecionada não vinculada ao ponto de controle * `VEHICLE_NOT_LINKED_TO_CHECKPOINT` – Veículo inspecionado não vinculado ao ponto de controle * `VEHICLE_NOT_FOUND` – Veículo não encontrado * `INVALID_JUSTIFICATION` – Justificativa inválida * `PPE_DELIVERY_MOTIVE_NOT_FOUND` – Motivo entrega de EPI não encontrado * `PPE_DELIVERY_SUPPLIER_NOT_FOUND` – Fornecedor de EPI não encontrado * `FINISHED_DATE_BEFORE_CHECKIN` – Data de finalização anterior à data de check-in fileType: type: string enum: – PHOTO – AUDIO – VIDEO description: Tipos de arquivos: * `PHOTO` – Foto * `AUDIO` – Áudio * `VIDEO` – Vídeo incidentPriority: type: string enum: – PLANNED – LOW – MEDIUM – HIGH – CRITICAL description: Prioridades do ocorrência: * `PLANNED` – Sem prioridade * `LOW` – Baixo * `MEDIUM` – Médio * `HIGH` – Alto * `CRITICAL` – Crítico routinePlanType: type: string enum: – OTHERS – PROPERTY_SECURITY – MAINTENANCE – OCCUPATIONAL_SAFETY – RISK_MANAGEMENT – FACILITIES – INDUSTRY – RECEPTION_FRONTDESK – TRANSPORTATION_LOGISTICS – ADMINISTRATIVE – FINANCIAL – HEALTHCARE – SERVICES – HUMAN_RESOURCES – STOCK – WAREHOUSE – CONSTRUCTION – AGRIBUSINESS – MINING – RETAIL – WHOLESALE_DISTRIBUITION – FOOD_BEVERAGE – CONSULTING – AUDIT description: Tipos de plano de rotina: * `OTHERS` – Outros * `PROPERTY_SECURITY` – Segurança patrimonial * `MAINTENANCE` – Manutenção * `OCCUPATIONAL_SAFETY` – Segurança do trabalho * `RISK_MANAGEMENT` – Gestão de riscos * `FACILITIES` – Facilities * `INDUSTRY` – Indústria * `RECEPTION_FRONTDESK` – Portaria e recepção * `TRANSPORTATION_LOGISTICS` – Transporte e logistica * `ADMINISTRATIVE` – Administrativo * `FINANCIAL` – Financeiro * `HEALTHCARE` – Saúde * `SERVICES` – Serviços * `HUMAN_RESOURCES` – Recursos humanos * `STOCK` – Estoque * `WAREHOUSE` – Almoxarifado * `CONSTRUCTION` – Construção * `AGRIBUSINESS` – Agronegócio * `MINING` – Mineração * `RETAIL` – Varejo * `WHOLESALE_DISTRIBUITION` – Atacado e distribuição * `FOOD_BEVERAGE` – Alimentação e bebidas * `CONSULTING` – Consultoria * `AUDIT` – Auditoria checklistType: type: string enum: – OTHERS – PERIMETER_TOUR – EQUIPMENT_MAINTENANCE – ASSETS_CONTROL – SURVEY_AUDIT – FIRE_PROTECTION_SYSTEMS – SECURITY_SYSTEMS_AUDIT – ISO – PDCA – TECHNICAL_STANDARDS_AUDIT – QUALITY – STOCK – CERTIFICATION – DELIVERIES – VEHICLES – LOAD_UNLOAD – INSPECTION – RECEIVINGS – SHIPPING – PPE – MAINTENANCE_CLEANING description: Tipos de checklist: * `OTHERS` – Outros * `PERIMETER_TOUR` – Ronda perimetral * `EQUIPMENT_MAINTENANCE` – Manutenção de ativos e equipamentos * `ASSETS_CONTROL` – Controle de ativos * `SURVEY_AUDIT` – Vistoria e auditoria * `FIRE_PROTECTION_SYSTEMS` – Sistemas de proteção contra incêndio * `SECURITY_SYSTEMS_AUDIT` – Auditoria de sistemas de segurança * `ISO` – ISO * `PDCA` – PDCA * `TECHNICAL_STANDARDS_AUDIT` – Auditoria de Normas Técnicas (NRs) * `QUALITY` – Qualidade * `STOCK` – Estoque * `CERTIFICATION` – Certificação * `DELIVERIES` – Entregas * `VEHICLES` – Veículos * `LOAD_UNLOAD` – Carga/descarga * `INSPECTION` – Inspeção * `RECEIVINGS` – Recebimentos * `SHIPPING` – Expedição * `PPE` – EPI (Equipamento de Proteção Individual) * `MAINTENANCE_CLEANING` – Manutenção e limpeza offsetDaylightSavingType: type: string enum: – NONE_OFFSET – MINUS_ONE_HOUR – PLUS_ONE_HOUR description: Tipo do horário de verão: * `NONE_OFFSET` – Sem configuração de horário de verão * `MINUS_ONE_HOUR` – Uma hora a menos no horário de verão * `PLUS_ONE_HOUR` – Uma hora a mais no horário de verão checklistConfig: type: string enum: – NOT_REQUIRED – NOT_OK – ALL description: Tipos de configurações para obrigatoriedades do checklist: * `NOT_REQUIRED` – Não obrigatório * `NOT_OK` – Quando a situação do checklist for Não conforme * `ALL` – Todos answerType: type: string enum: – LIST – INT – TEXT – DRAW_SIGNATURE – PERSONS – PPE_DELIVERY description: Tipos de respostas dos checklists: * `LIST` – Lista de opções * `INT` – Número inteiro * `TEXT` – Texto livre * `DRAW_SIGNATURE` – Assinatura desenhada * `PERSONS` – Pessoas * `PPE_DELIVERY` – Entrega de EPI ppeSynchronizedStatus: type: string enum: – PENDING – SUCCESS – ERROR – PPE_NOT_FOUND – MOTIVE_NOT_FOUND – EMPLOYEE_NOT_FOUND – DATA_INTEGRITY – SIGNATURE_ERROR description: Status de sincronização da entrega de EPI: * `PENDING` – Pendente * `SUCCESS` – Sincronizado com sucesso * `ERROR` – Erro na sincronização * `PPE_NOT_FOUND` – Erro na sincronização quando não tem um EPI vinculado * `MOTIVE_NOT_FOUND` – Erro na sincronização quando não tem um motivo vinculado * `EMPLOYEE_NOT_FOUND` – Erro na sincronização quando não tem um colaborador vinculado * `DATA_INTEGRITY` – Erro na sincronização quando os dados estão incorretos * `SIGNATURE_ERROR` – Erro ao atualizar a assinatura eletrônica da entrega já sincronizada userType: type: string enum: – USER – ADMINISTRATOR – MASTER description: Tipos de usuário do Ronda: * `USER` – Usuário comum do sistema * `ADMINISTRATOR` – Usuário com permissões de administrador * `MASTER` – Usuário com permissões master identificationMethod: type: string enum: – PRE_SELECTED – TYPED – FACIAL_RECOGNITION description: Forma de identificação utilizada no ponto de controle ou resposta de checklist: * `PRE_SELECTED` – Pré-selecionada * `TYPED` – Digitada * `FACIAL_RECOGNITION` – Reconhecimento facial gryfoRegistrationStatus: type: string enum: – PENDING – REGISTERED – ERROR – PENDING_REMOVAL – LOW_QUALITY_IMAGE – FACE_NOT_DETECTED – MULTIPLE_FACES – FACE_ALREADY_REGISTERED – PHOTO_UNAVAILABLE – COMMUNICATION_ERROR description: Situação do registro da biometria na plataforma de reconhecimento: * `PENDING` – Aguardando envio * `REGISTERED` – Registrado na plataforma * `ERROR` – Falha no envio * `PENDING_REMOVAL` – Aguardando remoção da plataforma * `LOW_QUALITY_IMAGE` – Foto com qualidade insuficiente para o reconhecimento * `FACE_NOT_DETECTED` – Nenhum rosto encontrado na foto * `MULTIPLE_FACES` – Mais de um rosto encontrado na foto * `FACE_ALREADY_REGISTERED` – Rosto já cadastrado para outra pessoa na plataforma * `PHOTO_UNAVAILABLE` – Foto da biometria indisponível para envio * `COMMUNICATION_ERROR` – Falha de comunicação com a plataforma de reconhecimento incidentStatus: type: string enum: – PENDING – IN_PROGRESS – STOPPED – DONE description: Status da Ocorrência: * `PENDING` – Pendente / Não iniciado * `IN_PROGRESS` – Iniciado / Em andamento * `STOPPED` – Parado * `DONE` – Finalizado vehicleColor: type: string enum: – UNDEFINED – BLACK – WHITE – SILVER – RED – GREY – BLUE – YELLOW – GREEN – ORANGE – OTHERS description: Cor do veículo: * `UNDEFINED` – Indefinido * `BLACK` – Preto * `WHITE` – Branco * `SILVER` – Prata * `RED` – Vermelho * `GREY` – Cinza * `BLUE` – Azul * `YELLOW` – Amarelo * `GREEN` – Verde * `ORANGE` – Laranja * `OTHERS` – Outros 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 checklistThatGeneratesIncidentRecord: description: Checklist configurado para registrar ocorrências type: object required: – checklistId – description – checkInDate – timezoneOffset – incidentTypeId – incidentPriority – physicalLocationId – latitude – longitude properties: checklistId: type: integer format: int64 description: ID description: type: string description: Descrição do checklist checkInDate: type: string format: date-time description: Data do checkIn timezoneOffset: type: integer format: int64 description: TimezoneOffset do checkIn incidentTypeId: type: integer format: int64 description: ID do Tipo de incident incidentPriority: type: string allOf: – #/definitions/incidentPriority description: Prioridade do ocorrência physicalLocationId: type: integer format: int64 description: ID do local físico latitude: type: number format: double description: Latitude longitude: type: number format: double description: Longitude finishedRoutinesRecord: description: Rotinas finalizadas type: object required: – routineId – status properties: routineId: type: integer format: int64 description: ID da rotina status: type: string allOf: – #/definitions/tourStatus description: Status da Rotina routineThatClosedIncidentRecord: description: Rotina configurada para finalizar incidentes type: object required: – routineId – description properties: routineId: type: integer format: int64 description: ID description: type: string description: Descrição do fechamento da ocorrêcia incident: type: object allOf: – #/definitions/incidentDetailsRecord description: Ocorrência healthcheckItem: description: Item verificado no healthcheck type: object required: – name – status properties: name: type: string description: Nome do item status: type: string allOf: – #/definitions/healthcheckStatus description: Status da saúde checklistTemplateItemRecord: description: Record para criação/atualização de itens do checklist type: object required: – description – attachmentConfig – noteConfig – checklistAnswerType properties: id: type: integer format: int64 description: ID description: type: string maxLength: 255 description: Descrição incidentType: type: object allOf: – #/definitions/incidentTypeRecord description: Tipo de ocorrência attachmentConfig: type: string allOf: – #/definitions/checklistConfig description: Tipos de configuração de anexos noteConfig: type: string allOf: – #/definitions/checklistConfig description: Tipos de configuração de observações notInComplianceValue: type: integer format: int64 description: Somente valores acima deste limite serão considerados conformes para respostas do tipo inteiro checklistAnswerType: type: object allOf: – #/definitions/checklistAnswerTypeRecord description: Tipo de resposta loadFilterRecord: description: Record do filtro do grupo de carga type: object required: – filterType – filterValue properties: filterType: type: string allOf: – #/definitions/loadFilterType description: Tipo do filtro filterValue: type: string description: Valor do filtro loadFilterDetailRecord: description: Filtro do grupo de carga com o objeto referenciado já resolvido (id e nome). Para SITUATION e PHOTO_READY, o objeto não se aplica e apenas o filterValue (0/1) é preenchido. type: object required: – filterType – filterValue properties: filterType: type: string allOf: – #/definitions/loadFilterType description: Tipo do filtro filterValue: type: string description: Valor bruto do filtro (id do objeto, ou 0/1 para SITUATION/PHOTO_READY) id: type: integer format: int64 description: Id do objeto referenciado. Ausente para SITUATION/PHOTO_READY name: type: string description: Nome do objeto referenciado. Ausente para SITUATION/PHOTO_READY ou quando o objeto não é encontrado organizationalStructureType: type: object allOf: – #/definitions/organizationalStructureTypeRecord description: Tipo da estrutura organizacional. Preenchido somente para o filtro ORGANIZATIONAL_STRUCTURE organizationalStructureTypeRecord: description: Tipo de estrutura organizacional type: object required: – id – name properties: id: type: integer format: int64 description: Id do tipo de estrutura organizacional name: type: string description: Nome do tipo de estrutura organizacional personForLoadRecord: description: Record de pessoa para configuração do grupo de carga type: object required: – id – name – document properties: id: type: integer format: int64 description: ID da pessoa name: type: string description: Nome da pessoa document: type: string description: Documento da pessoa gryfoPersonRecord: description: Record de pessoa com as informações da Gryfo para o SDK, resolvida pelo grupo de carga do plano de rotina type: object required: – id – name – document properties: id: type: integer format: int64 description: ID da pessoa no cadastro name: type: string description: Nome da pessoa no cadastro document: type: string description: Documento (CPF) da pessoa no cadastro biometricsStatus: type: string allOf: – #/definitions/gryfoRegistrationStatus description: Situação da biometria da pessoa no cadastro local. Ausente quando a pessoa não possui biometria cadastrada externalId: type: string description: External id da pessoa para o SDK (sem hifens), derivado do cadastro local. Preenchido apenas quando a pessoa possui biometria registrada (REGISTERED); nos demais casos é ausente nearbyPositionRecord: description: Informações básicas dos planos de rotina encontrados nas proximidades type: object required: – id – name – latitude – longitude – radius – distance properties: id: type: integer format: int64 description: ID name: type: string maxLength: 50 description: Nome do plano de rotina latitude: type: number format: double description: Latitude longitude: type: number format: double description: Longitude radius: type: integer format: int64 description: Raio (em metros) distance: type: number format: double description: Distância aproximada (em metros) incidentType: type: object allOf: – #/definitions/incidentType description: Tipo de ocorrência physicalLocation: type: object allOf: – #/definitions/physicalLocation description: Local físico registerCheckpointRecord: description: Informações do registro de ponto de controle type: object required: – id – tourId – personId – checkInDate properties: id: type: integer format: int64 description: ID tourId: type: integer format: int64 description: ID da rotina personId: type: integer format: int64 description: ID da pessoa que executou o ponto de controle checkpointPersonId: type: integer format: int64 description: ID da pessoa inspecionada no ponto de controle (obrigatório quando o checkpoint for do tipo PERSON sem pessoa vinculada) checkpointVehicleId: type: integer format: int64 description: ID do veículo inspecionado no ponto de controle (obrigatório quando o checkpoint for do tipo VEHICLE sem veículo vinculado) checkInDate: type: string description: Data/hora do checkIn no formato ISO8601 finishedInDate: type: string description: Data/hora de finalização no formato ISO8601 justification: type: string description: Justificativa para erros na leitura do ponto de controle latitude: type: number format: double description: Latitude minimum: -90.0 maximum: 90.0 longitude: type: number format: double description: Longitude minimum: -180.0 maximum: 180.0 identificationMethod: type: string allOf: – #/definitions/identificationMethod description: Forma de identificação utilizada no ponto de controle checklists: type: array items: type: object allOf: – #/definitions/registerChecklistRecord description: Checklists checkpointsSyncStatusRecord: description: Situação de sincronização de um ponto de controle que foi rejeitado type: object required: – reason properties: checkpointId: type: integer format: int64 description: ID do ponto de controle reason: type: string allOf: – #/definitions/rejectedReason description: Motivo da rejeição registerChecklistRecord: description: Informações do registro de checklist type: object required: – id properties: id: type: integer format: int64 description: ID note: type: string maxLength: 500 description: Observação situation: type: string allOf: – #/definitions/checklistSituation description: Situação answerOptions: type: array items: type: object allOf: – #/definitions/answerOptionsRecord description: Opções de respostas intValue: type: integer format: int64 description: valor de resposta inteiro textValue: type: string maxLength: 500 description: Valor texto answerAttachment: type: array items: type: object allOf: – #/definitions/checklistAnswerAttachmentRecord description: Anexos do checklist personIds: type: array items: type: integer format: int64 description: Id das pessoas ppeDeliveries: type: array items: type: object allOf: – #/definitions/checklistPpeDeliveryRecord description: Entregas de EPI identificationMethod: type: string allOf: – #/definitions/identificationMethod description: Forma de identificação utilizada na resposta do checklist checklistPpeDeliveryRecord: description: type: object required: – quantityDelivered – quantityDamaged – usageInstruction – ppeName properties: quantityDelivered: type: integer format: int64 description: Quantidade entregue minimum: 0 quantityDamaged: type: integer format: int64 description: Quantidade danificada minimum: 0 quantityReturned: type: integer format: int64 description: Quantidade devolvida minimum: 0 usageInstruction: type: boolean description: Recebeu instrução de uso ppeName: type: string description: Nome do EPI entregue note: type: string description: Observação externalGeneratedId: type: string description: Id gerado externamente motiveId: type: string maxLength: 32 description: Identificador do motivo de entrega supplierId: type: string maxLength: 32 description: Identificador do fornecedor employeeId: type: string maxLength: 32 description: Identificador do colaborador ppeId: type: string maxLength: 32 description: Identificador do EPI checklistAnswerAttachmentRecord: description: Informações do anexo do checklist quando é necessário uma imagem como resposta type: object properties: personId: type: integer format: int64 description: Identificador da pessoa para quando for tipo de resposta de assinatura digital fileName: type: string description: Nome do arquivo salvo no blob service personIds: type: array items: type: integer format: int64 description: Id das pessoas schedulingRecord: description: Agendamento type: object required: – startHour – endHour – recurrenceType – active properties: id: type: integer format: int64 description: ID startHour: type: string description: Hora inicial endHour: type: string description: Hora final recurrenceType: type: string allOf: – #/definitions/recurrenceType description: Recorrência interval: type: integer format: int64 description: Intervalo da recorrência minimum: 1 default: 1 monday: type: boolean description: Segunda default: false tuesday: type: boolean description: Terça default: false wednesday: type: boolean description: Quarta default: false thursday: type: boolean description: Quinta default: false friday: type: boolean description: Sexta default: false saturday: type: boolean description: Sábado default: false sunday: type: boolean description: Domingo default: false active: type: boolean description: Estado do agendamento createdBy: type: string description: Responsável pela criação createdDate: type: string format: date-time description: Data da criação lastModifiedBy: type: string description: Responssável pela ultima modificação lastModifiedDate: type: string format: date-time description: Data da ultima modificação executeInHoliday: type: boolean description: Executa em um feriado default: true quantityMaxRoutines: type: integer format: int64 description: Quantidade máxima de rotinas a serem geradas minimum: 1 dayOfMonth: type: integer format: int64 description: Dia do mês minimum: 1 maximum: 31 weekDay: type: string allOf: – #/definitions/weekDay description: Dia da semana weekOfMonth: type: string allOf: – #/definitions/weeklyOrdinal description: Semana do mês routeCheckpointRecord: description: Rota checkpoint type: object required: – order properties: id: type: integer format: int64 description: ID order: type: integer format: int64 description: Ordem minimum: 1 checkpoint: type: object allOf: – #/definitions/checkpointRecord description: Checkpoint checklist: type: object allOf: – #/definitions/checklistTemplateRecord description: Checklist checkpointRecord: description: Checkpoint type: object properties: id: type: integer format: int64 description: ID name: type: string maxLength: 50 description: Nome type: type: string allOf: – #/definitions/checkpointType description: Tipo do ponto de controle validationType: type: string allOf: – #/definitions/validationType description: Tipo de validação physicalLocationId: type: integer format: int64 description: Local físico checklistTemplateRecord: description: Modelo de checklist type: object properties: id: type: integer format: int64 description: ID name: type: string maxLength: 50 description: Nome tourRecord: description: Record da rotina type: object required: – startDate – endDate – schedulingName – routineTemplateName – status – tourCheckpoints properties: id: type: integer format: int64 description: ID startDate: type: string description: Data e hora inicial da rotina no formato ISO-8601 endDate: type: string description: Data e hora final da rotina no formato ISO-8601 schedulingName: type: string description: Nome do modelo de rotina routineTemplateName: type: string description: Nome do modelo de rotina status: type: string allOf: – #/definitions/tourStatus description: Status tourCheckpoints: type: array items: type: object allOf: – #/definitions/tourCheckpointRecord minimum: 1 description: Pontos de controle signFacial: type: boolean description: Indica se a execução da rotina exige coleta de assinatura tourCheckpointRecord: description: Record do ponto de controle da rotina type: object required: – order – checkpointId – checkInDate properties: id: type: integer format: int64 description: ID order: type: integer format: int64 description: Ordem minimum: 1 checkpointId: type: integer format: int64 description: Id do ponto de controle checkpointPersonId: type: integer format: int64 description: Identificador da pessoa vinculada ao ponto de controle checkpointVehicleId: type: integer format: int64 description: Identificador do veículo vinculado ao ponto de controle checklistTemplateName: type: string description: Nome do modelo de checklist checkInDate: type: string description: Data e hora do check in formato ISO-8601 latitude: type: number format: double description: Latitude no momento do check in minimum: -90.0 maximum: 90.0 longitude: type: number format: double description: Longitude no momento do check in minimum: -180.0 maximum: 180.0 checklists: type: array items: type: object allOf: – #/definitions/checklistRecord description: Checklists score: type: number format: double description: Score do ponto de controle physicalLocationPath: type: string description: Caminho hierárquico completo do local físico checklistRecord: description: Record do checklist type: object required: – situation – attachmentConfig – noteConfig – answerType – answerOptions properties: id: type: integer format: int64 description: ID description: type: string maxLength: 255 description: Descrição note: type: string maxLength: 500 description: Observação situation: type: string allOf: – #/definitions/checklistSituation description: Situação attachmentConfig: type: string allOf: – #/definitions/checklistConfig description: Tipos de configuração de anexos noteConfig: type: string allOf: – #/definitions/checklistConfig description: Tipos de configuração de observação answerType: type: string allOf: – #/definitions/answerType description: Tipo de resposta do checklist answerOptions: type: array items: type: object allOf: – #/definitions/answerOptionsRecord minimum: 1 description: Opções de respostas checklistAnswer: type: array items: type: object allOf: – #/definitions/checklistAnswerRecord description: Resposta do checklist minValue: type: integer format: int64 description: O menor valor permitido para o tipo de resposta número inteiro. maxValue: type: integer format: int64 description: O maior valor permitido para o tipo de resposta número inteiro. notInComplianceValue: type: integer format: int64 description: Somente valores acima deste limite serão considerados conformes para respostas do tipo inteiro order: type: integer format: int64 description: Ordem checklistAnswerRecord: description: Opções de respostas dos checklists type: object properties: id: type: integer format: int64 description: ID answerOption: type: object allOf: – #/definitions/answerOptionsRecord description: Opção de resposta intValue: type: integer format: int64 description: Valor inteiro answerOptionsRecord: description: Record do checklist type: object properties: id: type: integer format: int64 description: ID description: type: string maxLength: 255 description: Descrição complianceType: type: string allOf: – #/definitions/complianceType description: Tipo de conformidade mobileDeviceRecord: description: Record do dispositivo móvel type: object required: – name – active – platform – activationCodeCreatedBy – activationCodeCreatedDate – activatedBy – activationDate properties: id: type: integer format: int64 description: ID name: type: string maxLength: 255 description: Nome note: type: string maxLength: 255 description: Observação phoneNumber: type: string maxLength: 50 description: Número de telefone com o formato esperado E.164 active: type: boolean description: Estado do dispositivo móvel platform: type: string allOf: – #/definitions/platform description: Plataforma activationCode: type: string description: Código de ativação deviceUUID: type: string description: Identificador gerado para o dispositivo activationCodeCreatedBy: type: string description: Usuário que gerou o código de ativação activationCodeCreatedDate: type: string format: date-time description: Data da geração do código de ativação activatedBy: type: string description: Usuário que ativou o dispositivo activationDate: type: string format: date-time description: Data da ativação reportFilterData: description: Record relatorio filtro dados type: object required: – text – value properties: text: type: string description: Texto a ser apresentado value: type: string description: Valor armazenado no filtro lastStatusMobileDeviceRecord: description: Record último status de um dispositivo móvel type: object required: – mobileDeviceName – personName – collectDate – batteryLevel – latitude – longitude properties: mobileDeviceName: type: string description: Nome do dispositivo personName: type: string description: Nome da pessoa logada no dispositivo collectDate: type: string description: Data da Coleta batteryLevel: type: integer format: int64 description: Nível da Bateria latitude: type: number format: double description: Latitude da localização minimum: -90.0 maximum: 90.0 longitude: type: number format: double description: Longitude da localização minimum: -180.0 maximum: 180.0 mobileDeviceStatusRecord: description: Record do status do dispositivo móvel type: object required: – deviceUUID – batteryLevel – collectDate – personId properties: deviceUUID: type: string description: ID batteryLevel: type: integer format: int64 description: Bateria do dispositivo minimum: 0 maximum: 100 latitude: type: number format: double description: Latitude no momento da coleta do status minimum: -90.0 maximum: 90.0 longitude: type: number format: double description: Longitude no momento da coleta do status minimum: -180.0 maximum: 180.0 collectDate: type: string description: Data/hora da coleta do status no formato ISO8601 personId: type: integer format: int64 description: Identificador da pessoa logada no dispositivo tourDetailsRecord: description: Detalhes da rotina type: object required: – id – position – routineTemplate – startDate – endDate – startedIn – finishedIn – person – status – justification – tourCheckpoints – incidentId properties: id: type: integer format: int64 description: ID position: type: string description: Plano de rotina routineTemplate: type: string description: Modelo Rotina startDate: type: string description: Data início endDate: type: string description: Data fim startedIn: type: string description: Data e hora que a rotina foi iniciada finishedIn: type: string description: Data e hora que a rotina foi finalizada person: type: string description: Pessoa status: type: string allOf: – #/definitions/tourStatus description: Status justification: type: string description: Justificativa para finalizar a rotina tourCheckpoints: type: array items: type: object allOf: – #/definitions/tourCheckpointDetailsRecord minimum: 1 description: Pontos de controle score: type: number format: double description: Score da rotina incidentId: type: integer format: int64 description: Ocorrência ID tourCheckpointDetailsRecord: description: Detalhes do ponto de controle type: object required: – id – name – checkInDate – finishedInDate – latitude – longitude – canceled – justification – checklists properties: id: type: integer format: int64 description: ID name: type: string description: Nome checkpointType: type: string allOf: – #/definitions/checkpointType description: Tipo do ponto de controle inspectedName: type: string description: Nome do inspecionado (Ativo, Local Físico ou Pessoa) checkInDate: type: string description: Data e hora do check in finishedInDate: type: string description: Data e hora de finalização latitude: type: number format: double description: Latitude no momento do check in longitude: type: number format: double description: Longitude no momento do check in canceled: type: boolean description: Indica se o controle foi cancelada justification: type: string description: Justificativa para erros na leitura do ponto de controle checklists: type: array items: type: object allOf: – #/definitions/checklistDetailsRecord minimum: 1 description: Checklists score: type: number format: double description: Score do ponto de controle ppeDeliveryDetailsRecord: description: Detalhes da entrega de EPI type: object required: – quantityDelivered – quantityDamaged – usageInstruction properties: quantityDelivered: type: integer format: int64 description: Quantidade entregue quantityDamaged: type: integer format: int64 description: Quantidade danificada quantityReturned: type: integer format: int64 description: Quantidade devolvida usageInstruction: type: boolean description: Recebeu instrução de uso supplierName: type: string description: Nome do fornecedor motiveName: type: string description: Nome do motivo da entrega checklistDetailsRecord: description: Detalhes do checklist type: object required: – id – description – situation – note – attachments – answer properties: id: type: integer format: int64 description: ID description: type: string description: Descrição situation: type: string allOf: – #/definitions/checklistSituation description: Situação note: type: string description: Observação attachments: type: array items: type: object allOf: – #/definitions/attachmentDetailsRecord minimum: 1 description: Anexos incident: type: object allOf: – #/definitions/incidentDetailsRecord description: Ocorrência answer: type: string description: Opção de reposta signatures: type: array items: type: object allOf: – #/definitions/checklistSignatureRecord description: Assinaturas desenhadas (apenas para tipo DRAW_SIGNATURE) ppeDeliveryDetails: type: object allOf: – #/definitions/ppeDeliveryDetailsRecord description: Detalhes da entrega de EPI (somente para tipo PPE_DELIVERY) checklistSignatureRecord: description: Assinatura desenhada de um checklist type: object properties: personName: type: string description: Nome da pessoa que assinou imageUrl: type: string description: URL da imagem da assinatura desenhada fileName: type: string description: Nome do arquivo da assinatura (uso interno para resolução da URL) incidentDetailsRecord: description: Detalhes da ocorrência type: object required: – id – incidentePriority properties: id: type: integer format: int64 description: ID incidentePriority: type: string allOf: – #/definitions/incidentPriority description: Prioridade da ocorrência checklistAnswerTypeRecord: description: Tipo de resposta type: object required: – id properties: id: type: integer format: int64 description: ID attachmentDetailsRecord: description: Detalhes do anexo do checklist type: object required: – id – fileType – fileName – url properties: id: type: integer format: int64 description: ID fileType: type: string allOf: – #/definitions/fileType description: Tipo do arquivo fileName: type: string description: Nome do arquivo url: type: string description: URL do anexo searchParametersItens: description: Parâmetros de Pesquisa da Abrangência type: object required: – key – value properties: key: type: string description: Nome do campo filtro que está sendo enviado como parâmetro value: type: string description: Valor do campo filtro que está sendo enviado como parâmetro rangeItens: description: Itens da Abrangência type: object required: – text – value properties: text: type: string description: Texto a ser apresentado value: type: string description: Valor armazenado no filtro positionRecord: description: Record do plano de rotina type: object required: – id properties: id: type: integer format: int64 description: ID holidayListId: type: integer format: int64 description: Id da lista de feriados cadastrada incidentTypeRecord: description: Record do tipo de ocorrência type: object properties: id: type: integer format: int64 description: ID name: type: string maxLength: 50 description: Nome defaultPriority: type: string allOf: – #/definitions/incidentPriority description: Prioridade Padrão description: type: string maxLength: 200 description: Descrição do tipo do incidente unscheduledRoutineRecord: description: Record das rotinas não agendadas type: object required: – id – name – routinesCount properties: id: type: integer format: int64 description: ID name: type: string description: Nome da rotina endDate: type: string format: date description: Data fim da rotina routinesCount: type: integer format: int64 description: Quantidade de rotinas checklistNotificationEmailRecord: description: Record das notificações de email type: object required: – email properties: id: type: integer format: int64 description: ID email: type: string maxLength: 100 description: Email checklistTemplate: type: object allOf: – #/definitions/checklistTemplateRecord description: Checkist positionChecklistTemplateRecord: description: Record da relação plano de rotinas e modelos de checklists type: object properties: id: type: integer format: int64 description: ID position: type: object allOf: – #/definitions/positionRecord description: Plano de rotina checklistTemplate: type: object allOf: – #/definitions/checklistTemplateRecord description: Checkist checklistTemplateItemRecordIAssist: description: Record do item do checklist gerado por IA type: object required: – description – answerType properties: description: type: string maxLength: 255 description: Descrição do item answerType: type: object allOf: – #/definitions/checklistAnswerTypeRecord description: Tipo de resposta do item personRecord: description: Record da pessoa com a URL da foto de perfil type: object required: – name – photoUrl – document properties: id: type: integer format: int64 description: ID name: type: string maxLength: 100 description: Nome da pessoa photoUrl: type: string description: Url da foto document: type: string description: Documento de identificação da pessoa missingBirthday: type: boolean description: Indica se a pessoa não possui data de nascimento no GRS, exigida para criar o contato no Sign. Preenchido somente quando solicitado por includeSignRequirements missingContact: type: boolean description: Indica se a pessoa não possui e-mail nem telefone válido para o Sign (com DDI, no padrão internacional E.164) no GRS, exigidos para criar o contato no Sign. Preenchido somente quando solicitado por includeSignRequirements ppeDeliveryMotiveRecord: description: Motivo de entrega de EPI type: object required: – id – name properties: id: type: string description: ID name: type: string description: Nome personalProtectiveEquipmentRecord: description: Equipamento de Proteção Individual type: object required: – id – name properties: id: type: string description: ID do EPI name: type: string description: Nome do EPI ppeItemRecord: description: Item de EPI entregue a um colaborador type: object required: – id – name – deliveryDate – expirationDate properties: id: type: string description: ID do EPI name: type: string description: Nome do EPI deliveryDate: type: string format: date description: Data de entrega expirationDate: type: string format: date description: Data de expiração personPpeRecord: description: EPIs vinculados a um colaborador type: object required: – personId – personalProtectiveEquipments properties: personId: type: integer format: int64 description: ID da pessoa employeeId: type: string description: ID do colaborador no HCM. Nulo quando a pessoa não possui colaborador vinculado personalProtectiveEquipments: type: array items: type: object allOf: – #/definitions/ppeItemRecord minimum: 1 description: Lista de EPIs do colaborador ppeSupplierGroupRecord: description: Fornecedores de EPI agrupados pelo identificador do EPI type: object required: – ppeId – suppliers properties: ppeId: type: string description: ID do EPI suppliers: type: array items: type: object allOf: – #/definitions/ppeSupplier minimum: 1 description: Fornecedores vinculados ao EPI position: description: Plano de rotina type: object required: – name – physicalLocation – active properties: id: type: integer format: int64 description: ID name: type: string maxLength: 50 description: Nome do plano de rotina note: type: string maxLength: 255 description: Observação physicalLocation: type: object allOf: – #/definitions/physicalLocation description: Local físico latitude: type: number format: double description: Latitude minimum: -90.0 maximum: 90.0 longitude: type: number format: double description: Longitude minimum: -180.0 maximum: 180.0 radius: type: integer format: int64 description: Raio (em metros) minimum: 10 active: type: boolean description: Estado do plano de rotina positionContact: type: array items: type: object allOf: – #/definitions/positionContact description: Contatos do plano de rotina checkpoints: type: array items: type: object allOf: – #/definitions/checkpoint description: Checkpoints routineTemplates: type: array items: type: object allOf: – #/definitions/routineTemplate description: Rotinas incidentType: type: object allOf: – #/definitions/incidentType description: Tipo do ocorrência routinePlanType: type: string allOf: – #/definitions/routinePlanType description: Tipo do plano de rotina allowsManualSelection: type: boolean description: Seleção manual do plano de rotina default: false holidayList: type: object allOf: – #/definitions/holidayList description: Lista de Feriados positionChecklistTemplate: type: array items: type: object allOf: – #/definitions/positionChecklistTemplate description: Checklists do plano de rotina createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editPosition: type: object required: – id allOf: – #/definitions/position routineTemplate: description: Template da rotina type: object required: – name – startDate – endDate – active properties: id: type: integer format: int64 description: ID name: type: string maxLength: 50 description: Nome da rotina startDate: type: string format: date description: Data de início endDate: type: string format: date description: Data de fim active: type: boolean description: Estado da rotina position: type: object allOf: – #/definitions/position description: Plano de rotina routeCheckpoint: type: array items: type: object allOf: – #/definitions/routeCheckpoint description: Rota checkpoint tours: type: array items: type: object allOf: – #/definitions/tour description: Rotinas schedules: type: array items: type: object allOf: – #/definitions/scheduling description: Agendamentos scheduled: type: boolean description: Rotina agendada default: true maxRoutines: type: integer format: int64 description: Quantidade máxima de rotinas que podem ser executadas quando a rotina não é agendada minimum: 1 incidentType: type: object allOf: – #/definitions/incidentType description: Tipo de ocorrência signFacial: type: boolean description: Indica se a rotina exige coleta de assinatura default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editRoutineTemplate: type: object required: – id allOf: – #/definitions/routineTemplate scheduling: description: Agendamento type: object required: – startHour – endHour – recurrenceType – active – weekDay – weekOfMonth properties: id: type: integer format: int64 description: ID startHour: type: string description: Hora inicial endHour: type: string description: Hora final recurrenceType: type: string allOf: – #/definitions/recurrenceType description: Recorrência interval: type: integer format: int64 description: Intervalo da recorrência minimum: 1 monday: type: boolean description: Segunda default: false tuesday: type: boolean description: Terça default: false wednesday: type: boolean description: Quarta default: false thursday: type: boolean description: Quinta default: false friday: type: boolean description: Sexta default: false saturday: type: boolean description: Sábado default: false sunday: type: boolean description: Domingo default: false active: type: boolean description: Estado do agendamento tours: type: array items: type: object allOf: – #/definitions/tour description: Rotinas routineTemplate: type: object allOf: – #/definitions/routineTemplate description: Rotina lastGeneration: type: string format: date-time description: Data/hora da última geração de rotinas executeInHoliday: type: boolean description: Executa em um feriado default: true quantityMaxRoutines: type: integer format: int64 description: Quantidade máxima de rotinas a serem geradas minimum: 1 dayOfMonth: type: integer format: int64 description: Dia do mês minimum: 1 maximum: 31 weekDay: type: string allOf: – #/definitions/weekDay description: Dia da semana weekOfMonth: type: string allOf: – #/definitions/weeklyOrdinal description: Semana do mês createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editScheduling: type: object required: – id allOf: – #/definitions/scheduling contact: description: Contato type: object required: – name – phoneNumber properties: id: type: integer format: int64 description: ID name: type: string maxLength: 255 description: Nome phoneNumber: type: string maxLength: 50 description: Número de telefone com o formato esperado E.164 positionContact: type: array items: type: object allOf: – #/definitions/positionContact description: Plano de rotinas do contato createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editContact: type: object required: – id allOf: – #/definitions/contact positionContact: description: Relação Plano de Rotina Contato type: object properties: id: type: integer format: int64 description: ID contact: type: object allOf: – #/definitions/contact description: Contato position: type: object allOf: – #/definitions/position description: Plano de rotina editPositionContact: type: object required: – id allOf: – #/definitions/positionContact physicalLocation: description: Local Físico type: object required: – name – externalLocation – localTimezone properties: id: type: integer format: int64 description: ID name: type: string maxLength: 50 description: Nome parent: type: integer format: int64 description: ID do Pai fullHierarchicalPath: type: string description: Caminho hierárquico completo externalLocation: type: boolean description: Local externo localTimezone: type: object allOf: – #/definitions/localTimezone description: Local Timezone checklistTemplate: description: Modelo de checklist type: object required: – name – items – active – checklistType properties: id: type: integer format: int64 description: ID name: type: string maxLength: 50 description: Nome items: type: array items: type: object allOf: – #/definitions/checklistTemplateItem minimum: 1 description: Itens routeCheckpoint: type: array items: type: object allOf: – #/definitions/routeCheckpoint description: Rota checkpoint active: type: boolean description: Status do checklist checklistType: type: string allOf: – #/definitions/checklistType description: Tipo do checklist checklistNotificationEmail: type: array items: type: object allOf: – #/definitions/checklistNotificationEmail description: Email para notificação tourCheckpoint: type: array items: type: object allOf: – #/definitions/tourCheckpoint description: Rotina checkpoint positionChecklistTemplate: type: array items: type: object allOf: – #/definitions/positionChecklistTemplate description: Planos de rotinas do checklist createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editChecklistTemplate: type: object required: – id allOf: – #/definitions/checklistTemplate checklistTemplateItem: description: Item do modelo de checklist type: object required: – description – attachmentConfig – noteConfig – checklistAnswerType – order properties: id: type: integer format: int64 description: ID description: type: string maxLength: 255 description: Descrição checklistTemplate: type: object allOf: – #/definitions/checklistTemplate description: Modelo de checklist incidentType: type: object allOf: – #/definitions/incidentType description: Tipo de ocorrência attachmentConfig: type: string allOf: – #/definitions/checklistConfig description: Tipos de configuração de anexos noteConfig: type: string allOf: – #/definitions/checklistConfig description: Tipos de configuração de observações checklists: type: array items: type: object allOf: – #/definitions/checklist description: Checklists que foram gerados a partir desse modelo active: type: boolean description: Status do item do checklist default: true checklistAnswerType: type: object allOf: – #/definitions/checklistAnswerType description: Tipo de resposta notInComplianceValue: type: integer format: int64 description: Somente valores acima deste limite serão considerados conformes para respostas do tipo inteiro order: type: integer format: int64 description: Ordem createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editChecklistTemplateItem: type: object required: – id allOf: – #/definitions/checklistTemplateItem checkpoint: description: Ponto de controle type: object required: – name – type – validationType – active properties: id: type: integer format: int64 description: ID name: type: string maxLength: 50 description: Nome position: type: object allOf: – #/definitions/position description: Plano de rotina type: type: string allOf: – #/definitions/checkpointType description: Tipo do ponto de controle checkpointType: type: string allOf: – #/definitions/validationType description: Tipo de validação do ponto de controle para evitar quebra de compatibilidade validationType: type: string allOf: – #/definitions/validationType description: Tipo de validação do ponto de controle latitude: type: number format: double description: Latitude minimum: -90.0 maximum: 90.0 longitude: type: number format: double description: Longitude minimum: -180.0 maximum: 180.0 radius: type: integer format: int64 description: Raio (em metros) minimum: 10 maximum: 50 active: type: boolean description: Estado do checkpoint routeCheckpoint: type: array items: type: object allOf: – #/definitions/routeCheckpoint description: Rota checkpoint tourCheckpoints: type: array items: type: object allOf: – #/definitions/tourCheckpoint description: Checkpoint de rotina physicalLocation: type: object allOf: – #/definitions/physicalLocation description: Local físico note: type: string maxLength: 255 description: Observação asset: type: object allOf: – #/definitions/asset description: Ativo vinculado person: type: object allOf: – #/definitions/person description: Pessoa vinculada vehicle: type: object allOf: – #/definitions/vehicle description: Veículo vinculado createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editCheckpoint: type: object required: – id allOf: – #/definitions/checkpoint routeCheckpoint: description: Rota da rotina type: object required: – order properties: id: type: integer format: int64 description: ID order: type: integer format: int64 description: Ordem minimum: 1 checkpoint: type: object allOf: – #/definitions/checkpoint description: Checkpoint routineTemplate: type: object allOf: – #/definitions/routineTemplate description: Rotina checklist: type: object allOf: – #/definitions/checklistTemplate description: Checklist createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editRouteCheckpoint: type: object required: – id allOf: – #/definitions/routeCheckpoint tour: description: Rotina type: object required: – startDate – startDateTimezoneOffset – endDate – endDateTimezoneOffset – status properties: id: type: integer format: int64 description: ID startDate: type: string format: date-time description: Data e hora inicial da rotina startDateTimezoneOffset: type: integer format: int64 description: Offset da data inicial da rotina endDate: type: string format: date-time description: Data e hora final da rotina endDateTimezoneOffset: type: integer format: int64 description: Offset da data final da rotina scheduling: type: object allOf: – #/definitions/scheduling description: Agendamento routineTemplate: type: object allOf: – #/definitions/routineTemplate description: Rotina checkpoints: type: array items: type: object allOf: – #/definitions/tourCheckpoint description: Checkpoints status: type: string allOf: – #/definitions/tourStatus description: Status da rotina person: type: object allOf: – #/definitions/person description: Pessoa que executou a rotina startedIn: type: string format: date-time description: Data e hora que a rotina foi iniciada startedInTimezoneOffset: type: integer format: int64 description: Offset da data e hora que a rotina foi iniciada finishedIn: type: string format: date-time description: Data e hora que a rotina foi finalizada finishedInTimezoneOffset: type: integer format: int64 description: Offset da data e hora que a rotina foi finalizada justification: type: string maxLength: 500 description: Justificativa para finalizar a rotina mobileDevice: type: object allOf: – #/definitions/mobileDevice description: Dispositivo móvel score: type: number format: double description: Score da rotina attachments: type: array items: type: object allOf: – #/definitions/routineAttachment description: Anexos incident: type: object allOf: – #/definitions/incident description: Ocorrência reportTicket: type: string format: uuid description: Ticket do relatório gerado gedId: type: string format: uuid description: ID do documento no GED createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editTour: type: object required: – id allOf: – #/definitions/tour tourCheckpoint: description: Ponto de controle da rotina type: object required: – order – checkInDate – timezoneOffset properties: id: type: integer format: int64 description: ID order: type: integer format: int64 description: Ordem minimum: 1 checkInDate: type: string format: date-time description: Data e hora do check in timezoneOffset: type: integer format: int64 description: Offset do check In finishedIn: type: string format: date-time description: Data/hora de finalização do ponto de controle finishedInOffset: type: integer format: int64 description: Offset do fuso horário de finalização em minutos latitude: type: number format: double description: Latitude no momento do check in minimum: -90.0 maximum: 90.0 longitude: type: number format: double description: Longitude no momento do check in minimum: -180.0 maximum: 180.0 checkpoint: type: object allOf: – #/definitions/checkpoint description: Checkpoint tour: type: object allOf: – #/definitions/tour description: Rotina checklists: type: array items: type: object allOf: – #/definitions/checklist description: Checklists justification: type: string maxLength: 500 description: Justificativa para erros na leitura do ponto de controle checklistTemplate: type: object allOf: – #/definitions/checklistTemplate description: Modelo do checklist asset: type: object allOf: – #/definitions/asset description: Ativo vinculado ao ponto de controle physicalLocation: type: object allOf: – #/definitions/physicalLocation description: Local físico vinculado ao ponto de controle person: type: object allOf: – #/definitions/person description: Pessoa vinculada ao ponto de controle vehicle: type: object allOf: – #/definitions/vehicle description: Veículo vinculado ao ponto de controle insideGeofence: type: boolean description: Leitura do ponto de controle foi feita dentro do perímetro score: type: number format: double description: Score do ponto de controle identificationMethod: type: string allOf: – #/definitions/identificationMethod description: Forma de identificação utilizada no ponto de controle canceled: type: boolean description: Cancelado default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editTourCheckpoint: type: object required: – id allOf: – #/definitions/tourCheckpoint tourSign: description: Assinatura da ronda type: object required: – tour properties: id: type: integer format: int64 description: ID tour: type: object allOf: – #/definitions/tour description: Ronda assinada signContactId: type: string format: uuid description: ID do contato assinante personId: type: integer format: int64 description: ID da pessoa createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: checklist: description: Checklist do ponto de controle type: object required: – description – situation – attachmentConfig – noteConfig – checklistTemplateItem properties: id: type: integer format: int64 description: ID description: type: string maxLength: 255 description: Descrição note: type: string maxLength: 500 description: Observação situation: type: string allOf: – #/definitions/checklistSituation description: Situação tourCheckpoint: type: object allOf: – #/definitions/tourCheckpoint description: Checkpoint attachments: type: array items: type: object allOf: – #/definitions/checklistAttachment description: Anexos incidentType: type: object allOf: – #/definitions/incidentType description: Tipo de ocorrência incident: type: object allOf: – #/definitions/incident description: Ocorrência attachmentConfig: type: string allOf: – #/definitions/checklistConfig description: Tipos de configuração de anexos noteConfig: type: string allOf: – #/definitions/checklistConfig description: Tipos de configuração de observações checklistTemplateItem: type: object allOf: – #/definitions/checklistTemplateItem description: Template do item que foi usado para gerar esse checklist checklistAnswer: type: array items: type: object allOf: – #/definitions/checklistAnswer description: Respostas do checklist externalGeneratedId: type: string format: uuid description: ID gerado externamente createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editChecklist: type: object required: – id allOf: – #/definitions/checklist rejectedTour: description: Rotina rejeitada type: object required: – reason – personName properties: id: type: integer format: int64 description: ID checkInDate: type: string format: date-time description: Data e hora do check in timezoneOffset: type: integer format: int64 description: Offset da rotina rejeitada reason: type: string allOf: – #/definitions/rejectedReason description: Motivo tour: type: integer format: int64 description: Rotina tourCheckpoint: type: integer format: int64 description: Checkpoint personId: type: integer format: int64 description: Id da pessoa que executou a rotina personName: type: string maxLength: 255 description: Nome da pessoa que executou a rotina createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: person: description: Pessoa type: object required: – name properties: id: type: integer format: int64 description: ID name: type: string maxLength: 100 description: Nome personRoles: type: array items: type: object allOf: – #/definitions/personRole description: Papéis da Pessoa documents: type: array items: type: object allOf: – #/definitions/document description: Documentos lastPhysicalLocationId: type: integer format: int64 description: Ultimo local fisico situation: type: integer format: int64 description: Situação document: description: Documento type: object required: – document – documentType properties: id: type: integer format: int64 description: ID person: type: object allOf: – #/definitions/person description: Pessoa document: type: string maxLength: 30 description: Documento documentType: type: object allOf: – #/definitions/documentType description: Tipo do documento editDocument: type: object required: – id allOf: – #/definitions/document documentType: description: Tipo do documento type: object required: – label properties: id: type: integer format: int64 description: ID label: type: string description: Rotulo mobileDevice: description: Dispositivo móvel type: object required: – name – active – platform properties: id: type: integer format: int64 description: ID name: type: string maxLength: 255 description: Nome note: type: string maxLength: 255 description: Observação phoneNumber: type: string maxLength: 50 description: Número de telefone com o formato esperado E.164 active: type: boolean description: Estado do dispositivo móvel platform: type: string allOf: – #/definitions/platform description: Plataforma activationCode: type: string description: Código de ativação deviceUUID: type: string description: Identificador gerado para o dispositivo activationCodeCreatedBy: type: string description: Usuário que gerou o código de ativação activationCodeCreatedDate: type: string format: date-time description: Data da geração do código de ativação activatedBy: type: string description: Usuário que ativou o dispositivo activationDate: type: string format: date-time description: Data da ativação activations: type: array items: type: object allOf: – #/definitions/mobileDeviceActivation description: Ativações do dispositivo mobileDeviceStatus: type: array items: type: object allOf: – #/definitions/mobileDeviceStatus description: Status do dispositivo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: mobileDeviceActivation: description: Ativação do dispositivo móvel type: object required: – deviceUUID – activationCodeCreatedBy – activationCodeCreatedDate – activatedBy – activationDate properties: id: type: integer format: int64 description: ID deviceUUID: type: string maxLength: 255 description: Identificador gerado para dispositivo activationCodeCreatedBy: type: string description: Usuário que gerou o código de ativação activationCodeCreatedDate: type: string format: date-time description: Data da geração do código de ativação activatedBy: type: string description: Usuário ativou o dispositivo activationDate: type: string format: date-time description: Data da ativação mobileDevice: type: object allOf: – #/definitions/mobileDevice description: Dispositivo móvel createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editMobileDeviceActivation: type: object required: – id allOf: – #/definitions/mobileDeviceActivation checklistAttachment: description: Anexo de checklist type: object required: – fileName – fileType properties: id: type: integer format: int64 description: ID fileName: type: string maxLength: 255 description: Nome do arquivo fileType: type: string allOf: – #/definitions/fileType description: Tipo do arquivo checklist: type: object allOf: – #/definitions/checklist description: Checklist createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editChecklistAttachment: type: object required: – id allOf: – #/definitions/checklistAttachment checklistNotificationEmail: description: Notificacao de emails type: object required: – email properties: id: type: integer format: int64 description: ID email: type: string maxLength: 100 description: Email checklistTemplate: type: object allOf: – #/definitions/checklistTemplate description: Checkist createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editChecklistNotificationEmail: type: object required: – id allOf: – #/definitions/checklistNotificationEmail incidentType: description: Tipo de ocorrências type: object required: – name – defaultPriority – description properties: id: type: integer format: int64 description: ID name: type: string maxLength: 50 description: Nome defaultPriority: type: string allOf: – #/definitions/incidentPriority description: Prioridade Padrão description: type: string maxLength: 200 description: Descrição do tipo do ocorrência incident: description: Ocorrência type: object required: – priority – status properties: id: type: integer format: int64 description: ID userId: type: integer format: int64 description: Usuário que criou a ocorrência priority: type: string allOf: – #/definitions/incidentPriority description: Prioridade ocorrência status: type: string allOf: – #/definitions/incidentStatus description: Status ocorrência createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: mobileDeviceStatus: description: Status do dispositivo móvel type: object required: – collectDate – collectDateTimezoneOffset – batteryLevel properties: id: type: integer format: int64 description: ID collectDate: type: string format: date-time description: Data/hora collectDateTimezoneOffset: type: integer format: int64 description: Offset da data batteryLevel: type: integer format: int64 description: Nível de bateria minimum: 0 maximum: 100 latitude: type: number format: double description: Latitude minimum: -90.0 maximum: 90.0 longitude: type: number format: double description: Longitude minimum: -180.0 maximum: 180.0 mobileDevice: type: object allOf: – #/definitions/mobileDevice description: Dispositivo móvel person: type: object allOf: – #/definitions/person description: Pessoa logada no dispositivo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editMobileDeviceStatus: type: object required: – id allOf: – #/definitions/mobileDeviceStatus holiday: description: Feriado type: object required: – name – holidayDate – recurrent properties: id: type: integer format: int64 description: ID holidayList: type: object allOf: – #/definitions/holidayList description: Lista de Feriados name: type: string maxLength: 60 description: Nome do feriado holidayDate: type: string format: date description: Data do Feriado recurrent: type: boolean description: Feriado Recorrente editHoliday: type: object required: – id allOf: – #/definitions/holiday holidayList: description: Lista de Feriados type: object required: – name properties: id: type: integer format: int64 description: ID name: type: string maxLength: 60 description: Nome da Lista de Feriados holiday: type: array items: type: object allOf: – #/definitions/holiday description: Lista de Feriados positionChecklistTemplate: description: Relacao plano de rotinas e modelos de checklists type: object properties: id: type: integer format: int64 description: ID position: type: object allOf: – #/definitions/position description: Plano de rotina checklistTemplate: type: object allOf: – #/definitions/checklistTemplate description: Checkist editPositionChecklistTemplate: type: object required: – id allOf: – #/definitions/positionChecklistTemplate routineAttachment: description: Anexo de rotina type: object required: – fileType properties: id: type: integer format: int64 description: ID fileName: type: string description: Nome do arquivo tour: type: object allOf: – #/definitions/tour description: Rotina fileType: type: string allOf: – #/definitions/fileType description: Tipo do arquivo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editRoutineAttachment: type: object required: – id allOf: – #/definitions/routineAttachment timezone: description: Timezones da Aplicação type: object required: – name – timezoneOffset properties: id: type: integer format: int64 description: ID name: type: string maxLength: 80 description: Nome do Timezone timezoneOffset: type: integer format: int64 description: Offset em Minutos do Timezone localTimezone: description: Fuso Horário Local type: object required: – name – timezone – daylightSaving properties: id: type: integer format: int64 description: ID name: type: string maxLength: 50 description: Nome do Local timezone: type: object allOf: – #/definitions/timezone description: Fuso horário daylightSaving: type: boolean description: Horário de verão offsetDaylightSaving: type: string allOf: – #/definitions/offsetDaylightSavingType description: Tipo do horário de verão daylightSavingStartDate: type: string format: date description: Data início do horário de verão daylightSavingFinishDate: type: string format: date description: Data fim do horário de verão checklistAnswerType: description: Tipos de respostas dos checklists type: object required: – description – answerType properties: id: type: integer format: int64 description: ID description: type: string maxLength: 255 description: Descrição do tipo de resposta answerType: type: string allOf: – #/definitions/answerType description: Tipo de respostas do checklist answerOptions: type: array items: type: object allOf: – #/definitions/answerOption description: Opções de respostas checklistTemplateItem: type: array items: type: object allOf: – #/definitions/checklistTemplateItem description: Itens de checklist minValue: type: integer format: int64 description: O menor valor permitido para o tipo de resposta número inteiro. maxValue: type: integer format: int64 description: O maior valor permitido para o tipo de resposta número inteiro. createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: answerOption: description: Opções de respostas dos checklists type: object required: – description – complianceType properties: id: type: integer format: int64 description: ID description: type: string maxLength: 255 description: Descrição da opção de resposta complianceType: type: string allOf: – #/definitions/complianceType description: Tipo de conformidade checklistAnswerType: type: object allOf: – #/definitions/checklistAnswerType description: Tipo de respostas do checklist checklistAnswer: type: array items: type: object allOf: – #/definitions/checklistAnswer description: Respostas do checklist createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editAnswerOption: type: object required: – id allOf: – #/definitions/answerOption checklistAnswer: description: Opções de respostas dos checklists type: object properties: id: type: integer format: int64 description: ID checklist: type: object allOf: – #/definitions/checklist description: Checklist à qual esta resposta está associada answerOption: type: object allOf: – #/definitions/answerOption description: Opção de resposta intValue: type: integer format: int64 description: Valor inteiro textValue: type: string maxLength: 500 description: Valor texto fileName: type: string maxLength: 255 description: nome do arquivo anexado para resposta do checklist person: type: object allOf: – #/definitions/person description: Pessoa vinculado a resposta checklistPpeDelivery: type: object allOf: – #/definitions/checklistPpeDelivery description: Resposta de entrega de EPI identificationMethod: type: string allOf: – #/definitions/identificationMethod description: Forma de identificação utilizada na resposta do checklist createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editChecklistAnswer: type: object required: – id allOf: – #/definitions/checklistAnswer ppeSupplier: description: Fornecedor de EPI type: object required: – id – name properties: id: type: string description: ID name: type: string description: Nome ppeDeliveryMotive: description: Motivo de entrega de EPI type: object required: – id – name properties: id: type: string description: ID name: type: string description: Nome checklistPpeDelivery: description: Resposta de entrega de EPI type: object required: – quantityDelivered – quantityDamaged – usageInstruction properties: id: type: integer format: int64 description: ID quantityDelivered: type: integer format: int64 description: Quantidade entregue quantityDamaged: type: integer format: int64 description: Quantidade danificada quantityReturned: type: integer format: int64 description: Quantidade devolvida usageInstruction: type: boolean description: Recebeu instrução de uso supplier: type: object allOf: – #/definitions/ppeSupplier description: Fornecedor do EPI motive: type: object allOf: – #/definitions/ppeDeliveryMotive description: Motivo da entrega employeeId: type: string description: ID do colaborador ppeId: type: string description: ID do EPI externalGeneratedId: type: string description: ID no SM syncStatus: type: string allOf: – #/definitions/ppeSynchronizedStatus description: Status de sincronização da entrega checklistAnswer: type: array items: type: object allOf: – #/definitions/checklistAnswer description: Respostas do checklist associadas a esta entrega de EPI createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: personRole: description: Papéis da Pessoa type: object required: – startDate properties: id: type: integer format: int64 description: ID person: type: object allOf: – #/definitions/person description: Pessoa role: type: object allOf: – #/definitions/role description: Papel startDate: type: string format: date-time description: Data Início endDate: type: string format: date-time description: Data Fim editPersonRole: type: object required: – id allOf: – #/definitions/personRole role: description: Papel type: object required: – name properties: id: type: integer format: int64 description: ID name: type: string description: Nome personRoles: type: array items: type: object allOf: – #/definitions/personRole description: Relação Pessoa Papel rangeIncidentTypes: type: array items: type: object allOf: – #/definitions/rangeIncidentType description: Relação Pessoa Papel rangeIncidentType: description: Abrangências de tipos de ocorrência type: object properties: id: type: integer format: int64 description: ID role: type: object allOf: – #/definitions/role description: Pessoa incidentType: type: object allOf: – #/definitions/incidentType description: Papel editRangeIncidentType: type: object required: – id allOf: – #/definitions/rangeIncidentType user: description: Usuário type: object required: – person – login – userType properties: id: type: integer format: int64 description: ID person: type: object allOf: – #/definitions/person description: Pessoa login: type: string description: Login userType: type: string allOf: – #/definitions/userType description: Tipo do usuário privacyPolicyRead: description: Politica de privacidade type: object required: – userName – readAt – version properties: id: type: integer format: int64 description: ID userName: type: string maxLength: 255 description: Nome do usuário readAt: type: string format: date-time description: Data lido type: integer format: int64 description: Versão createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: vehicle: description: Veículo type: object required: – manufacturer – model – plate properties: id: type: integer format: int64 description: ID manufacturer: type: string maxLength: 100 description: Fabricante model: type: string maxLength: 100 description: Modelo plate: type: string maxLength: 15 description: Placa color: type: string allOf: – #/definitions/vehicleColor description: Cor do veículo loadPersonFilter: description: Filtro do grupo de carga do reconhecimento facial type: object required: – position – filterType – filterValue properties: id: type: integer format: int64 description: ID position: type: object allOf: – #/definitions/position description: Plano de rotina (posto) filterType: type: string allOf: – #/definitions/loadFilterType description: Tipo do filtro filterValue: type: string maxLength: 50 description: Valor do filtro createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: organizationalStructureType: description: Tipo estrutura organizacional (Entidade externa) type: object required: – name properties: id: type: integer format: int64 description: ID name: type: string maxLength: 50 description: Nome organizationalStructure: description: Estrutura organizacional (Entidade externa) type: object required: – parent – organizationalStructureType – description – integrated properties: id: type: integer format: int64 description: ID parent: type: integer format: int64 description: Estrutura organizacional pai organizationalStructureType: type: object allOf: – #/definitions/organizationalStructureType description: Tipo da estrutura organizacional description: type: string maxLength: 200 description: Descrição integrated: type: boolean description: Integrado com GAS organizationalStructurePerson: description: Pessoas da estrutura organizacional type: object properties: id: type: integer format: int64 description: ID organizationalStructure: type: object allOf: – #/definitions/organizationalStructure description: Estrutura organizacional person: type: object allOf: – #/definitions/person description: Pessoa group: description: Grupo (Entidade externa) type: object required: – name properties: id: type: integer format: int64 description: ID parent: type: object allOf: – #/definitions/group description: ID do Pai name: type: string maxLength: 50 description: Nome do Grupo people: type: array items: type: object allOf: – #/definitions/groupPerson description: Pessoas do Grupo fullHierarchicalPath: type: string description: Caminho hierárquico completo groupPerson: description: Relação Grupo Pessoa (Entidade externa) type: object properties: id: type: integer format: int64 description: ID person: type: object allOf: – #/definitions/person description: Pessoa group: type: object allOf: – #/definitions/group description: Grupo asset: description: Entidade externa replicada de ativos type: object required: – active properties: id: type: string format: uuid description: ID active: type: boolean description: Estado do ativo description: type: string description: Descrição do ativo extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração deleted: type: boolean description: Mostra se a entidade foi excluída logicamente default: false biometricsTemplate: description: Entidade externa replicada de biometria type: object properties: id: type: string format: uuid description: ID person: type: object allOf: – #/definitions/person description: Pessoa vinculada à biometria gryfoStatus: type: string allOf: – #/definitions/gryfoRegistrationStatus description: Situação do registro da biometria na plataforma de reconhecimento extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração deleted: type: boolean description: Mostra se a entidade foi excluída logicamente default: false 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 routineTemplateFacadeInput: description: Serviço de fachada para template de rotinas type: object required: – name – startDate – active – position – routeCheckpoint properties: id: type: integer format: int64 description: ID name: type: string maxLength: 50 description: Nome do template startDate: type: string format: date description: Data de início endDate: type: string format: date description: Data final active: type: boolean description: Estado do template position: type: object allOf: – #/definitions/positionRecord description: Plano de rotina schedules: type: array items: type: object allOf: – #/definitions/schedulingRecord description: Agendamentos routeCheckpoint: type: array items: type: object allOf: – #/definitions/routeCheckpointRecord minimum: 1 description: Rota checkpoint incidentType: type: object allOf: – #/definitions/incidentTypeRecord description: Tipo de ocorrência scheduled: type: boolean description: Rotina agendada default: true maxRoutines: type: integer format: int64 description: Quantidade máxima de rotinas que podem ser executadas quando a rotina não é agendada minimum: 1 signFacial: type: boolean description: Indica se a rotina exige coleta de assinatura default: false routineTemplateFacadeOutput: description: Serviço de fachada para template de rotinas type: object required: – name – startDate – endDate – active – position – maxRoutines – routinesCount properties: id: type: integer format: int64 description: ID name: type: string maxLength: 50 description: Nome do template startDate: type: string format: date description: Data de início endDate: type: string format: date description: Data final active: type: boolean description: Estado do template position: type: object allOf: – #/definitions/positionRecord description: Plano de rotina schedules: type: array items: type: object allOf: – #/definitions/schedulingRecord description: Agendamentos routeCheckpoint: type: array items: type: object allOf: – #/definitions/routeCheckpointRecord description: Rota checkpoint scheduled: type: boolean description: Rotina agendada default: true maxRoutines: type: integer format: int64 description: Quantidade máxima de rotinas que podem ser executadas quando a rotina não é agendada routinesCount: type: integer format: int64 description: Quantidade de rotinas createdBy: type: string description: Responsável pela criação createdDate: type: string format: date-time description: Data da criação lastModifiedBy: type: string description: Responsável pela ultima modificação lastModifiedDate: type: string format: date-time description: Data da ultima modificação incidentType: type: object allOf: – #/definitions/incidentTypeRecord description: Tipo de ocorrência signFacial: type: boolean description: Indica se a rotina exige coleta de assinatura 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