Mais pesquisados:Customização, Tutorial, Documentação

background_processor

129 views 0 28/08/2019 Atualizado em 21/10/2024 integrador

2.0info: 1.23.0 background_processor description: Serviço para processamentos em plano de fundo no backend do Ronda senior X x-senior-domain: sam x-senior-domain-path: sam x-senior-service-path: background_processor 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: /background_processor/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 /background_processor/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 /background_processor/queries/exportPendency: 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 /background_processor/queries/exportDriver: 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 /background_processor/queries/exportDevice: 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 /background_processor/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 /background_processor/queries/exportTimeslotList: 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 /background_processor/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 /background_processor/queries/exportManagerDevice: 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 /background_processor/queries/exportRepProperty: 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 /background_processor/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 /background_processor/actions/cancelPendency: post: description: Cancela uma pendência que ainda não está em execução tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pendencyId properties: pendencyId: type: integer format: int64 description: Id da pendência responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /background_processor/actions/createDeviceStatusPendency: post: description: Cria uma pendência de status do dispositivo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – managerDeviceIdList properties: managerDeviceIdList: type: array items: type: integer format: int64 minimum: 1 description: Lista de id dos gerenciadores responses: 200: description: Ok schema: type: object required: – pendencyIdList properties: pendencyIdList: type: array items: type: integer format: int64 minimum: 1 description: Lista de id das pendências 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /background_processor/actions/createUpdateFirmwarePendency: post: description: Cria uma pendência de atualização de firmware tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – managerDeviceIdList properties: managerDeviceIdList: type: array items: type: integer format: int64 minimum: 1 description: Lista de id dos gerenciadores responses: 200: description: Ok schema: type: object required: – pendencyIdList properties: pendencyIdList: type: array items: type: integer format: int64 minimum: 1 description: Lista de id das pendências 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /background_processor/actions/createInputStatusPendency: post: description: Cria uma pendência de status das entradas digitais tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – managerDeviceIdList properties: managerDeviceIdList: type: array items: type: integer format: int64 minimum: 1 description: Lista de id dos gerenciadores responses: 200: description: Ok schema: type: object required: – pendencyIdList properties: pendencyIdList: type: array items: type: integer format: int64 minimum: 1 description: Lista de id das pendências 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /background_processor/actions/createDeviceDateTimePendency: post: description: Cria uma pendência de atualização de data/hora tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – managerDeviceIdList properties: managerDeviceIdList: type: array items: type: integer format: int64 minimum: 1 description: Lista de id dos gerenciadores responses: 200: description: Ok schema: type: object required: – pendencyIdList properties: pendencyIdList: type: array items: type: integer format: int64 minimum: 1 description: Lista de id das pendências 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /background_processor/actions/createResetDevicePendency: post: description: Cria uma pendência de reset do dispositivo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – managerDeviceIdList properties: managerDeviceIdList: type: array items: type: integer format: int64 minimum: 1 description: Lista de id dos gerenciadores responses: 200: description: Ok schema: type: object required: – pendencyIdList properties: pendencyIdList: type: array items: type: integer format: int64 minimum: 1 description: Lista de id das pendências 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /background_processor/actions/createLoadCardListPendency: post: description: Cria uma pendência de carga da lista de liberação para uma lista de dispositivos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – managerDeviceIdList properties: managerDeviceIdList: type: array items: type: integer format: int64 minimum: 1 description: Lista de id dos gerenciadores responses: 200: description: Ok schema: type: object required: – pendencyIdList properties: pendencyIdList: type: array items: type: integer format: int64 minimum: 1 description: Id da pendência 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /background_processor/actions/createRemoveCardListPendency: post: description: Cria uma pendência de remoção da lista de liberação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – managerDeviceIdList properties: managerDeviceIdList: type: array items: type: integer format: int64 minimum: 1 description: Lista de id dos gerenciadores responses: 200: description: Ok schema: type: object required: – pendencyIdList properties: pendencyIdList: type: array items: type: integer format: int64 minimum: 1 description: Lista de id das pendências 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /background_processor/actions/createLoadBiometryListPendency: post: description: Cria uma pendência de carga da lista de biometria para uma lista de dispositivos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – managerDeviceIdList properties: managerDeviceIdList: type: array items: type: integer format: int64 minimum: 1 description: Lista de id dos gerenciadores responses: 200: description: Ok schema: type: object required: – pendencyIdList properties: pendencyIdList: type: array items: type: integer format: int64 minimum: 1 description: Id da pendência 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /background_processor/actions/createLoadFacialListPendency: post: description: Cria uma pendência de carga da lista de facial para uma lista de dispositivos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – managerDeviceIdList properties: managerDeviceIdList: type: array items: type: integer format: int64 minimum: 1 description: Lista de ids dos gerenciadores responses: 200: description: Ok schema: type: object required: – pendencyIdList properties: pendencyIdList: type: array items: type: integer format: int64 minimum: 1 description: Id das pendências 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /background_processor/actions/createRemoveBiometryListPendency: post: description: Cria uma pendência de remoção da lista de biometria tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – managerDeviceIdList properties: managerDeviceIdList: type: array items: type: integer format: int64 minimum: 1 description: Lista de id dos gerenciadores responses: 200: description: Ok schema: type: object required: – pendencyIdList properties: pendencyIdList: type: array items: type: integer format: int64 minimum: 1 description: Lista de id das pendências 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /background_processor/actions/createBlockDevicePendency: post: description: Cria uma pendência para bloquear um dispositivo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – managerDeviceIdList properties: managerDeviceIdList: type: array items: type: integer format: int64 minimum: 1 description: Lista de id dos gerenciadores responses: 200: description: Ok schema: type: object required: – pendencyIdList properties: pendencyIdList: type: array items: type: integer format: int64 minimum: 1 description: Lista de id das pendências 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /background_processor/actions/createUnblockDevicePendency: post: description: Cria uma pendência para desbloquear um dispositivo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – managerDeviceIdList properties: managerDeviceIdList: type: array items: type: integer format: int64 minimum: 1 description: Lista de id dos gerenciadores responses: 200: description: Ok schema: type: object required: – pendencyIdList properties: pendencyIdList: type: array items: type: integer format: int64 minimum: 1 description: Lista de id das pendências 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /background_processor/actions/createSetDeviceEmergencyPendency: post: description: Cria uma pendência para setar o dispositivo em modo de emergência tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – managerDeviceIdList properties: managerDeviceIdList: type: array items: type: integer format: int64 minimum: 1 description: Lista de id dos gerenciadores responses: 200: description: Ok schema: type: object required: – pendencyIdList properties: pendencyIdList: type: array items: type: integer format: int64 minimum: 1 description: Lista de id das pendências 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /background_processor/actions/createUnsetDeviceEmergencyPendency: post: description: Cria uma pendência para retirar o dispositivo do modo de emergência tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – managerDeviceIdList properties: managerDeviceIdList: type: array items: type: integer format: int64 minimum: 1 description: Lista de id dos gerenciadores responses: 200: description: Ok schema: type: object required: – pendencyIdList properties: pendencyIdList: type: array items: type: integer format: int64 minimum: 1 description: Lista de id das pendências 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /background_processor/actions/createConfigDevicePendency: post: description: Cria uma pendência para configurar o dispositivo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – managerDeviceIdList properties: managerDeviceIdList: type: array items: type: integer format: int64 minimum: 1 description: Lista de id dos gerenciadores responses: 200: description: Ok schema: type: object required: – pendencyIdList properties: pendencyIdList: type: array items: type: integer format: int64 minimum: 1 description: Lista de id das pendências 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /background_processor/actions/createLoadHolidayListPendency: post: description: Cria uma pendência para carregar a lista de feriados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – managerDeviceIdList properties: managerDeviceIdList: type: array items: type: integer format: int64 minimum: 1 description: Lista de id dos gerenciadores responses: 200: description: Ok schema: type: object required: – pendencyIdList properties: pendencyIdList: type: array items: type: integer format: int64 minimum: 1 description: Lista de id das pendências 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /background_processor/actions/createRemoveHolidayListPendency: post: description: Cria uma pendência para remover a lista de feriados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – managerDeviceIdList properties: managerDeviceIdList: type: array items: type: integer format: int64 minimum: 1 description: Lista de id dos gerenciadores responses: 200: description: Ok schema: type: object required: – pendencyIdList properties: pendencyIdList: type: array items: type: integer format: int64 minimum: 1 description: Lista de id das pendências 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /background_processor/actions/createActivateDeviceOutputPendency: post: description: Cria uma pendência para ativar uma saída do dispositivo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – deviceId properties: deviceId: type: integer format: int64 description: Id da saída que será ativada activationTime: type: integer format: int64 description: Tempo de ativação da saída, em milissegundos responses: 200: description: Ok schema: type: object required: – pendencyId properties: pendencyId: type: integer format: int64 description: Id da pendência 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /background_processor/actions/createDeactivateDeviceOutputPendency: post: description: Cria uma pendência para desativar uma saída do dispositivo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – deviceId properties: deviceId: type: integer format: int64 description: Id da saída que será desativada responses: 200: description: Ok schema: type: object required: – pendencyId properties: pendencyId: type: integer format: int64 description: Id da pendência 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /background_processor/actions/createCollectEventsPendency: post: description: Cria uma pendência para coletar eventos do dispositivo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – managerDeviceId – initialDate – finalDate – initialNsr – finalNsr properties: managerDeviceId: type: integer format: int64 description: Id do gerenciador initialDate: type: string format: date-time description: Data de início do filtro finalDate: type: string format: date-time description: Data de fim do filtro initialNsr: type: integer format: int64 description: NSR Inicial do filtro finalNsr: type: integer format: int64 description: NSR Final do filtro responses: 200: description: Ok schema: type: object required: – pendencyId properties: pendencyId: type: integer format: int64 description: Id da pendência 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /background_processor/actions/importPendency: 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 /background_processor/actions/importDriver: 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 /background_processor/actions/importDevice: 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 /background_processor/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 /background_processor/actions/importTimeslotList: 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 /background_processor/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 /background_processor/actions/importManagerDevice: 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 /background_processor/actions/importRepProperty: 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 /background_processor/signals/cardFormatUpdated: post: description: Recebe o sinal de formato de cartão atualizado para geração das pendências tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /background_processor/signals/holidayUpdated: post: description: Recebe o sinal de feriado atualizado para geração das pendências tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /background_processor/signals/roleUpdated: post: description: Recebe o sinal de papel atualizado para geração das pendências tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /background_processor/signals/timeslotUpdated: post: description: Recebe o sinal de faixa horária atualizada para geração das pendências tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /background_processor/signals/physicalLocationUpdated: post: description: Recebe o sinal de local físico atualizado para geração das pendências tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /background_processor/signals/timeZoneUpdated: post: description: Recebe o sinal de fuso horário atualizado para geração das pendências tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /background_processor/signals/driverDeleted: post: description: Recebe o sinal de driver atualizado para exclusão das pendências tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – driverId properties: driverId: type: integer format: int64 description: Id do driver responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /background_processor/signals/repPropertyUpdated: post: description: Sinaliza alteração de uma propriedade rep tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – repPropertyId properties: repPropertyId: type: integer format: int64 description: Id da propriedade rep responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /background_processor/signals/deletePendencyProcessingControl: post: description: Deleta registros das últimas 24 horas da tabela Controle Processamento Pendência tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /background_processor/events/pendencyCreated: post: description: Evento de pendência criada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – driverId – deviceId – pendencyType properties: driverId: type: integer format: int64 description: ID do driver deviceId: type: integer format: int64 description: ID do dispositivo pendencyType: type: string allOf: – #/definitions/pendencyType description: Tipo da pendência responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /background_processor/events/importPendencyEvent: 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 /background_processor/events/exportPendencyEvent: 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 /background_processor/events/importDriverEvent: 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 /background_processor/events/exportDriverEvent: 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 /background_processor/events/importDeviceEvent: 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 /background_processor/events/exportDeviceEvent: 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 /background_processor/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 /background_processor/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 /background_processor/events/importTimeslotListEvent: 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 /background_processor/events/exportTimeslotListEvent: 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 /background_processor/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 /background_processor/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 /background_processor/events/importManagerDeviceEvent: 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 /background_processor/events/exportManagerDeviceEvent: 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 /background_processor/events/importRepPropertyEvent: 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 /background_processor/events/exportRepPropertyEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError definitions: healthcheckStatus: description: Status do healthcheck type: string enum: – UP – DOWN pendencyStatus: description: Status da pendência type: string enum: – PENDING – EXECUTED – EXECUTED_WITH_ERROR – PENDING_WITH_ERROR – CANCELED – TIMEOUT – DUPLICATE – LIST_GENERATION driverType: description: Tipo de driver type: string enum: – APOLLO – SDK – HEAD deviceType: description: Tipo do dispositivo type: string enum: – MANAGER – READER – MODULE – INPUT – OUTPUT deviceSituation: description: Situação do dispositivo type: string enum: – INACTIVE – ACTIVE pendencyType: description: Tipo de pendência type: string enum: – UNKNOWN – DEVICE_STATUS – DEVICE_DATE_TIME – BLOCK_DEVICE – UNBLOCK_DEVICE – SET_DEVICE_EMERGENCY – UNSET_DEVICE_EMERGENCY – APOLLO_INCLUDE_CARD – APOLLO_EXCLUDE_CARD – INCLUDE_BIOMETRY – EXCLUDE_BIOMETRY – RESET_DEVICE – DEVICE_CONFIG – LOAD_HOLIDAY_LIST – REMOVE_HOLIDAY_LIST – ACTIVATE_DEVICE_OUTPUT – DEACTIVATE_DEVICE_OUTPUT – PERSON_AREA_UPDATED – DATAMART_UPDATED – COLLECT_EVENTS – DEVICE_INPUT_STATUS – REP_MANUFACTURER_UPDATED – UPDATE_PERSON_REP – ALLOW_CARD_LIST – BIOMETRY_LIST – REMOVE_ALLOW_CARD_LIST – REMOVE_BIOMETRY_LIST – INCLUDE_CARD – EXCLUDE_CARD – DEVICE_DISPLAY_MESSAGE – UPDATE_FIRMWARE – INCLUDE_PHOTO – EXCLUDE_PHOTO – CREDENTIAL_FACIAL_LIST pendencyPriority: description: Prioridade da pendência type: string enum: – UNKNOWN – VERY_HIGH – HIGH – NORMAL – LOW – VERY_LOW managerDeviceType: description: Tipo de dispositivo gerenciador type: string enum: – ACCESS_CONTROLLER – REP – COLLECTOR – REP_P processingStatus: description: Status do Processamento type: string enum: – WAITING_EXECUTION – IN_EXECUTION – EXECUTED – ERROR – DUPLICATED operation: description: Operação type: string enum: – PERSON_NAME_CHANGED – PERSON_DOCUMENT_CHANGED – FINISHED_ROLE – ADDED_ROLE – ADDED_CREDENTIAL – FINISHED_CREDENTIAL – SUSPENSION_CREATED – FINISHED_SUSPENSION – RELEASE_LIST – BIOMETRY_LIST – FACIAL_LIST userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR 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 pendency: description: Pendência type: object required: – pendencyType – generationDate – executionAttempts – priority – status properties: id: type: integer format: int64 description: ID pendencyType: type: string allOf: – #/definitions/pendencyType description: Tipo da pendência generationDate: type: string format: date-time description: Data de geração executionAttempts: type: integer format: int64 description: Tentativas de execução priority: type: string allOf: – #/definitions/pendencyPriority description: Prioridade status: type: string allOf: – #/definitions/pendencyStatus description: Status parentDevice: type: integer format: int64 description: Id do gerenciador driver: type: object allOf: – #/definitions/driver description: Driver do fabricante param: type: string description: Parâmetros default: {} response: type: string description: Resposta default: {} driver: description: Driver type: object required: – driverType properties: id: type: integer format: int64 description: Identificador driverType: type: string allOf: – #/definitions/driverType description: Tipo do driver device: description: Dispositivo type: object required: – deviceType – situation – physicalLocation properties: id: type: integer format: int64 description: Identificador parent: type: integer format: int64 description: Identificador do dispositivo pai deviceType: type: string allOf: – #/definitions/deviceType description: Tipo de dispositivo situation: type: string allOf: – #/definitions/deviceSituation description: Situação do dispositivo physicalLocation: type: object allOf: – #/definitions/physicalLocation description: Local físico do dispositivo physicalLocation: description: Local físico type: object required: – timeslotList properties: id: type: integer format: int64 description: Identificador timeslotList: type: object allOf: – #/definitions/timeslotList description: Lista de faixas horárias timeslotList: description: Lista de faixa horária type: object required: – holidayList properties: id: type: integer format: int64 description: Identificador holidayList: type: object allOf: – #/definitions/holidayList description: Lista de faixas horárias holidayList: description: Lista de faixa horária type: object properties: id: type: integer format: int64 description: Identificador managerDevice: description: Dispositivo type: object required: – driver – automaticDateTimeUpdate – managerType properties: id: type: integer format: int64 description: Identificador driver: type: object allOf: – #/definitions/driver description: Driver automaticDateTimeUpdate: type: boolean description: Atualização automatica de data e hora repProperty: type: object allOf: – #/definitions/repProperty description: Propriedades do REP managerType: type: string allOf: – #/definitions/managerDeviceType description: Tipo do Gerenciador repProperty: description: Propriedade do REP type: object required: – address – socialName properties: id: type: integer format: int64 description: ID address: type: string maxLength: 100 description: Endereço socialName: type: string maxLength: 100 description: Razão Social cnpj: type: string maxLength: 14 description: CNPJ cpf: type: string maxLength: 11 description: CPF cei: type: string maxLength: 12 description: CEI notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE

Este artigo foi útil para você?

 
Leave A Comment
Mais pesquisados:Customização, Tutorial, Documentação