2.0info: 1.20.1 telemetry_hub description: Serviço para regras de bloqueio e telemetria do XT x-senior-domain: tecnologia_xt x-senior-domain-path: tecnologia_xt x-senior-service-path: telemetry_hub 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/tecnologia_xtsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /telemetry_hub/queries/environmentClientConfig: post: description: Obter configuração para o client tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: environment: type: object allOf: – #/definitions/environmentDTO description: Ambiente responses: 200: description: Ok schema: type: object required: – runTasksImmediatelyOnStartup – ttlAgentStatusIntervalMinutes – configFetchIntervalMinutes – blockingRulesSyncIntervalMinutes – telemetrySendIntervalMinutes – updateCheckIntervalMinutes – queryExecutionCheckIntervalMinutes – queryExecutionTimeoutSeconds – queryExecutionMaxFileMb – telemetryUploadBatchSize properties: runTasksImmediatelyOnStartup: type: boolean description: Indica se as ScheduledTasks (exceto verificação de atualização e busca de configuração) devem rodar imediatamente na inicialização ttlAgentStatusIntervalMinutes: type: integer format: int64 description: Tempo de heartbeat (TTL) do agente em minutos configFetchIntervalMinutes: type: integer format: int64 description: Tempo de intervalo para busca de configuração blockingRulesSyncIntervalMinutes: type: integer format: int64 description: Tempo de intervalo para sincronização das regras de bloqueio telemetrySendIntervalMinutes: type: integer format: int64 description: Tempo de intervalo para envio de telemetria updateCheckIntervalMinutes: type: integer format: int64 description: Tempo de intervalo para verificação de atualização do agent queryExecutionCheckIntervalMinutes: type: integer format: int64 description: Intervalo de verificação de novas query executions (em minutos) queryExecutionTimeoutSeconds: type: integer format: int64 description: Timeout de execução de query execution (em segundos) queryExecutionMaxFileMb: type: number format: double description: Tamanho máximo do arquivo ZIP do resultado da query execution (em MB) telemetryUploadBatchSize: type: integer format: int64 description: Quantidade de registros por lote de upload de telemetria 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/queries/blockingRulesModifiedSince: post: description: Consultar regras de bloqueio modificadas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – environment – referenceDate properties: environment: type: object allOf: – #/definitions/environmentDTO description: Ambiente referenceDate: type: string format: date-time description: Data de referência responses: 200: description: Ok schema: type: object properties: actives: type: array items: type: object allOf: – #/definitions/activeBlockingRuleDTO description: Regras de bloqueio ativas desde a data de referência inactives: type: array items: type: object allOf: – #/definitions/inactiveBlockingRuleDTO description: Regras de bloqueio inativas desde a data de referência 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/queries/blockingRulesModifiedSinceGrouped: post: description: Consultar regras de bloqueio modificadas agrupadas por categoria tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – environment – referenceDate properties: environment: type: object allOf: – #/definitions/environmentDTO description: Ambiente referenceDate: type: string format: date-time description: Data de referência responses: 200: description: Ok schema: type: object properties: news: type: array items: type: object allOf: – #/definitions/activeBlockingRuleDTO description: Regras novas criadas após a data de referência (objeto completo) changes: type: array items: type: object allOf: – #/definitions/activeBlockingRuleDTO description: Regras preexistentes com alterações após a data de referência (objeto completo) unchanged: type: array items: type: string description: IDs de regras ativas sem nenhuma alteração desde a data de referência inactives: type: array items: type: string description: IDs de regras inativadas, expiradas ou removidas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/queries/getUploadProcessStatus: post: description: Status de uploads pelo fileId, para o agente resolver no boot as linhas presas em IN_PROCESS (G3, agente 2.8.0). Só os uploads do cliente do ambiente. Exige telemetry/Incluir, como o upload tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – environment – fileIds properties: environment: type: object allOf: – #/definitions/environmentDTO description: Ambiente fileIds: type: array items: type: string minimum: 1 description: IDs dos arquivos (fileId devolvido no pedido do upload), de 1 a 50 responses: 200: description: Ok schema: type: object required: – items properties: items: type: array items: type: object allOf: – #/definitions/uploadProcessStatusItemDTO minimum: 1 description: Um item por fileId pedido, na ordem do pedido, sem repetição 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/queries/getRestoreExecution: post: description: Consultar status e dados de uma execução de restauração histórica tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/getRestoreExecutionInputDTO responses: 200: description: Ok schema: type: object allOf: – #/definitions/getRestoreExecutionOutputDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Consultar status e dados de uma execução de restauração histórica tags: – Queries x-senior-visibility: PRIVATE parameters: – name: executionId description: Identificador da execução de restauração (UUID) in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/getRestoreExecutionOutputDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/queries/listQueryExecutions: post: description: Listar query executions com filtros e paginação (exclui CANCELLED) tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/listQueryExecutionsInputDTO responses: 200: description: Ok schema: type: object allOf: – #/definitions/listQueryExecutionsOutputDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Listar query executions com filtros e paginação (exclui CANCELLED) tags: – Queries x-senior-visibility: PRIVATE parameters: – name: executionId description: Filtrar por execução específica in: query type: string – name: customerId description: Filtrar por cliente in: query type: string – name: environmentId description: Filtrar por ambiente in: query type: string – name: createdFrom description: Início do período de solicitação in: query type: string format: date-time – name: createdTo description: Fim do período de solicitação in: query type: string format: date-time – name: createdBy description: Filtrar por autor da solicitação in: query type: string – name: updatedFrom description: Início do período de atualização in: query type: string format: date-time – name: updatedTo description: Fim do período de atualização in: query type: string format: date-time – name: sqlCommand description: Filtrar por trecho do comando SQL (busca parcial, case-insensitive) in: query type: string – name: status description: Filtrar por status agregado da execução (PENDING, PROCESSING ou FINISHED) in: query type: string allOf: – #/definitions/queryExecutionStatus – name: phase description: Filtrar por fase (RECEIPT, EXECUTION ou UPLOAD) in: query type: string allOf: – #/definitions/queryExecutionPhase – name: phaseStatus description: Filtrar por status da fase (SUCCESS ou FAILED) in: query type: string allOf: – #/definitions/queryExecutionPhaseStatus – name: pageNumber description: Número da página (base 0); padrão 0 in: query type: integer format: int64 – name: pageSize description: Tamanho da página; padrão 20 in: query type: integer format: int64 responses: 200: description: Ok schema: type: object allOf: – #/definitions/listQueryExecutionsOutputDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/queries/listQueryExecutionCreatedByValues: post: description: Listar valores distintos de createdBy em query executions (exclui CANCELLED) tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/listQueryExecutionCreatedByValuesInputDTO responses: 200: description: Ok schema: type: object allOf: – #/definitions/listQueryExecutionCreatedByValuesOutputDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Listar valores distintos de createdBy em query executions (exclui CANCELLED) tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object allOf: – #/definitions/listQueryExecutionCreatedByValuesOutputDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/queries/listEnvironmentsByCustomer: post: description: Listar os ambientes do cliente agrupados por produto, pelo catálogo de contato do agente (agent_last_seen), com a situação, o último contato, o último arquivo de telemetria processado e o tipo e a versão do banco (apoio ao cadastro de queryExecution e ao extrator). Ambientes substituídos (REPLACED) nunca vêm tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/listEnvironmentsByCustomerInputDTO responses: 200: description: Ok schema: type: object allOf: – #/definitions/listEnvironmentsByCustomerOutputDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Listar os ambientes do cliente agrupados por produto, pelo catálogo de contato do agente (agent_last_seen), com a situação, o último contato, o último arquivo de telemetria processado e o tipo e a versão do banco (apoio ao cadastro de queryExecution e ao extrator). Ambientes substituídos (REPLACED) nunca vêm tags: – Queries x-senior-visibility: PRIVATE parameters: – name: customerId description: Código do cliente (codcli); obrigatório in: query required: true type: string – name: productName description: Filtro opcional pelo nome do produto (product_config.product_name, ex.: HCM_XT) in: query type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/listEnvironmentsByCustomerOutputDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/queries/getTelemetryDailyOverview: post: description: Visão geral da telemetria por dia, da chegada dos arquivos (dia no fuso timeZone) ao envio ao SBS (dia de referência, UTC) (página Monitoramento). Exige telemetryMonitoring/Visualizar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate properties: startDate: type: string format: date description: Primeiro dia do período endDate: type: string format: date description: Último dia do período, inclusive. Não passa de hoje, e o período tem até sbs.upload.dedupwindowdays dias timeZone: type: string description: Fuso do usuário (nome IANA, por exemplo America/Sao_Paulo), para o período e os dias de chegada; vazio ou inválido usa UTC. O dia de referência do envio ao SBS é sempre UTC telemetryType: type: string allOf: – #/definitions/telemetryType description: Filtra só os arquivos pelo tipo de telemetria. Os números de clientes e do envio ao SBS são por cliente e dia, sem tipo responses: 200: description: Ok schema: type: object required: – days properties: days: type: array items: type: object allOf: – #/definitions/telemetryDailyOverviewDTO minimum: 1 description: Um item por dia do período, do mais antigo ao mais recente, inclusive os dias sem movimento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Visão geral da telemetria por dia, da chegada dos arquivos (dia no fuso timeZone) ao envio ao SBS (dia de referência, UTC) (página Monitoramento). Exige telemetryMonitoring/Visualizar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: startDate description: Primeiro dia do período in: query required: true type: string format: date – name: endDate description: Último dia do período, inclusive. Não passa de hoje, e o período tem até sbs.upload.dedupwindowdays dias in: query required: true type: string format: date – name: timeZone description: Fuso do usuário (nome IANA, por exemplo America/Sao_Paulo), para o período e os dias de chegada; vazio ou inválido usa UTC. O dia de referência do envio ao SBS é sempre UTC in: query type: string – name: telemetryType description: Filtra só os arquivos pelo tipo de telemetria. Os números de clientes e do envio ao SBS são por cliente e dia, sem tipo in: query type: string allOf: – #/definitions/telemetryType responses: 200: description: Ok schema: type: object required: – days properties: days: type: array items: type: object allOf: – #/definitions/telemetryDailyOverviewDTO minimum: 1 description: Um item por dia do período, do mais antigo ao mais recente, inclusive os dias sem movimento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/queries/listCustomerTelemetryDays: post: description: Linha do tempo de um cliente por dia: uploads e arquivos brutos pelo dia de chegada no fuso timeZone, e envio ao SBS e telemetria na base pelo dia de referência (UTC) (aba Clientes da página Monitoramento). Exige telemetryMonitoring/Visualizar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – customerId – startDate – endDate properties: customerId: type: string description: Código do cliente (codcli) startDate: type: string format: date description: Primeiro dia do período endDate: type: string format: date description: Último dia do período, inclusive. Não passa de hoje, e o período tem até sbs.upload.dedupwindowdays dias timeZone: type: string description: Fuso do usuário (nome IANA, por exemplo America/Sao_Paulo), para o período e os dias de chegada; vazio ou inválido usa UTC. O dia de referência do envio ao SBS é sempre UTC responses: 200: description: Ok schema: type: object required: – days properties: days: type: array items: type: object allOf: – #/definitions/customerTelemetryDayDTO minimum: 1 description: Um item por dia do período, do mais antigo ao mais recente, inclusive os dias sem movimento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Linha do tempo de um cliente por dia: uploads e arquivos brutos pelo dia de chegada no fuso timeZone, e envio ao SBS e telemetria na base pelo dia de referência (UTC) (aba Clientes da página Monitoramento). Exige telemetryMonitoring/Visualizar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: customerId description: Código do cliente (codcli) in: query required: true type: string – name: startDate description: Primeiro dia do período in: query required: true type: string format: date – name: endDate description: Último dia do período, inclusive. Não passa de hoje, e o período tem até sbs.upload.dedupwindowdays dias in: query required: true type: string format: date – name: timeZone description: Fuso do usuário (nome IANA, por exemplo America/Sao_Paulo), para o período e os dias de chegada; vazio ou inválido usa UTC. O dia de referência do envio ao SBS é sempre UTC in: query type: string responses: 200: description: Ok schema: type: object required: – days properties: days: type: array items: type: object allOf: – #/definitions/customerTelemetryDayDTO minimum: 1 description: Um item por dia do período, do mais antigo ao mais recente, inclusive os dias sem movimento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/queries/listUploadProcesses: post: description: Lista paginada de uploads com motivo do erro, versões, contagens e situação do arquivo bruto (aba Uploads da página Monitoramento), dos mais recentes aos mais antigos. Exige telemetryMonitoring/Visualizar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate properties: startDate: type: string format: date description: Primeiro dia do período de chegada endDate: type: string format: date description: Último dia do período de chegada, inclusive. Não passa de hoje, e o período tem até sbs.upload.dedupwindowdays dias timeZone: type: string description: Fuso do usuário (nome IANA, por exemplo America/Sao_Paulo), para o período e os dias de chegada; vazio ou inválido usa UTC. O dia de referência do envio ao SBS é sempre UTC customerId: type: string description: Código do cliente (codcli) telemetryType: type: string allOf: – #/definitions/telemetryType description: Tipo de telemetria status: type: string allOf: – #/definitions/uploadMonitoringStatus description: Status no monitoramento; o órfão é o upload aguardando processamento há mais de 24 h agentVersion: type: string description: Versão do agente que enviou o arquivo (igualdade exata) pageNumber: type: integer format: int64 description: Número da página (base 0); padrão 0 pageSize: type: integer format: int64 description: Tamanho da página; padrão 20, máximo 100 responses: 200: description: Ok schema: type: object required: – items – total properties: items: type: array items: type: object allOf: – #/definitions/uploadProcessItemDTO minimum: 1 description: Uploads da página total: type: integer format: int64 description: Total de uploads com os filtros (sem paginação) 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista paginada de uploads com motivo do erro, versões, contagens e situação do arquivo bruto (aba Uploads da página Monitoramento), dos mais recentes aos mais antigos. Exige telemetryMonitoring/Visualizar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: startDate description: Primeiro dia do período de chegada in: query required: true type: string format: date – name: endDate description: Último dia do período de chegada, inclusive. Não passa de hoje, e o período tem até sbs.upload.dedupwindowdays dias in: query required: true type: string format: date – name: timeZone description: Fuso do usuário (nome IANA, por exemplo America/Sao_Paulo), para o período e os dias de chegada; vazio ou inválido usa UTC. O dia de referência do envio ao SBS é sempre UTC in: query type: string – name: customerId description: Código do cliente (codcli) in: query type: string – name: telemetryType description: Tipo de telemetria in: query type: string allOf: – #/definitions/telemetryType – name: status description: Status no monitoramento; o órfão é o upload aguardando processamento há mais de 24 h in: query type: string allOf: – #/definitions/uploadMonitoringStatus – name: agentVersion description: Versão do agente que enviou o arquivo (igualdade exata) in: query type: string – name: pageNumber description: Número da página (base 0); padrão 0 in: query type: integer format: int64 – name: pageSize description: Tamanho da página; padrão 20, máximo 100 in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – items – total properties: items: type: array items: type: object allOf: – #/definitions/uploadProcessItemDTO minimum: 1 description: Uploads da página total: type: integer format: int64 description: Total de uploads com os filtros (sem paginação) 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/queries/listSbsPendingDays: post: description: Lista paginada dos pares (cliente, dia) da aba Envios SBS da página Monitoramento, do dia mais antigo ao mais recente e, no mesmo dia, por cliente: as pendências (dado processado e sem envio aceito pelo SBS, classificadas), os concluídos (envio SENT ou NO_DATA) ou os dois, conforme a situação. Só dias cujo envio diário já rodou; o dia de hoje não conta. Exige telemetryMonitoring/Visualizar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate properties: startDate: type: string format: date description: Primeiro dia de referência (UTC) endDate: type: string format: date description: Último dia de referência (UTC), inclusive. Não passa de hoje, e o período tem até sbs.upload.dedupwindowdays dias customerId: type: string description: Código do cliente (codcli) situation: type: string allOf: – #/definitions/sbsSendSituation description: Situação do envio; vazio para as pendências classification: type: string allOf: – #/definitions/sbsPendingClassification description: Classificação da pendência. Só as pendências têm classificação: com este filtro, os concluídos ficam de fora pageNumber: type: integer format: int64 description: Número da página (base 0); padrão 0 pageSize: type: integer format: int64 description: Tamanho da página; padrão 20, máximo 100 responses: 200: description: Ok schema: type: object required: – items – total – counts properties: items: type: array items: type: object allOf: – #/definitions/sbsPendingDayDTO minimum: 1 description: Pares da página total: type: integer format: int64 description: Total de pares com os filtros (sem paginação): as pendências e os concluídos da situação counts: type: array items: type: object allOf: – #/definitions/sbsPendingCountDTO minimum: 1 description: Pendências por classificação no período e no cliente, sem os filtros de situação e de classificação; todas as classificações, inclusive as zeradas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista paginada dos pares (cliente, dia) da aba Envios SBS da página Monitoramento, do dia mais antigo ao mais recente e, no mesmo dia, por cliente: as pendências (dado processado e sem envio aceito pelo SBS, classificadas), os concluídos (envio SENT ou NO_DATA) ou os dois, conforme a situação. Só dias cujo envio diário já rodou; o dia de hoje não conta. Exige telemetryMonitoring/Visualizar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: startDate description: Primeiro dia de referência (UTC) in: query required: true type: string format: date – name: endDate description: Último dia de referência (UTC), inclusive. Não passa de hoje, e o período tem até sbs.upload.dedupwindowdays dias in: query required: true type: string format: date – name: customerId description: Código do cliente (codcli) in: query type: string – name: situation description: Situação do envio; vazio para as pendências in: query type: string allOf: – #/definitions/sbsSendSituation – name: classification description: Classificação da pendência. Só as pendências têm classificação: com este filtro, os concluídos ficam de fora in: query type: string allOf: – #/definitions/sbsPendingClassification – name: pageNumber description: Número da página (base 0); padrão 0 in: query type: integer format: int64 – name: pageSize description: Tamanho da página; padrão 20, máximo 100 in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – items – total – counts properties: items: type: array items: type: object allOf: – #/definitions/sbsPendingDayDTO minimum: 1 description: Pares da página total: type: integer format: int64 description: Total de pares com os filtros (sem paginação): as pendências e os concluídos da situação counts: type: array items: type: object allOf: – #/definitions/sbsPendingCountDTO minimum: 1 description: Pendências por classificação no período e no cliente, sem os filtros de situação e de classificação; todas as classificações, inclusive as zeradas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/queries/listAgents: post: description: Lista paginada dos ambientes do catálogo de contato dos agentes (aba Agentes da página Monitoramento): uma linha por cliente, ambiente e sistema, com versões, banco, contatos, situação e último upload por tipo, mais o agregado por versão do agente. Ordem: cliente; dentro dele, ACTIVE, SILENT e REPLACED, cada grupo do contato mais recente ao mais antigo. Exige telemetryMonitoring/Visualizar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: customerId: type: string description: Código do cliente (codcli) situation: type: string allOf: – #/definitions/environmentSituation description: Situação do ambiente agentVersion: type: string description: Versão do agente (igualdade exata) withProblem: type: boolean description: Só os ambientes com problema no status reportado pelo agente (agentProblem); ambientes substituídos nunca entram pageNumber: type: integer format: int64 description: Número da página (base 0); padrão 0 pageSize: type: integer format: int64 description: Tamanho da página; padrão 20, máximo 100 responses: 200: description: Ok schema: type: object required: – items – total – versions properties: items: type: array items: type: object allOf: – #/definitions/agentEnvironmentDTO minimum: 1 description: Ambientes da página total: type: integer format: int64 description: Total de ambientes com os filtros (sem paginação) versions: type: array items: type: object allOf: – #/definitions/agentVersionCountDTO minimum: 1 description: Ambientes por versão do agente e situação, com o filtro de cliente e sem os de situação e versão; da versão mais nova à mais antiga, sem versão por último 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista paginada dos ambientes do catálogo de contato dos agentes (aba Agentes da página Monitoramento): uma linha por cliente, ambiente e sistema, com versões, banco, contatos, situação e último upload por tipo, mais o agregado por versão do agente. Ordem: cliente; dentro dele, ACTIVE, SILENT e REPLACED, cada grupo do contato mais recente ao mais antigo. Exige telemetryMonitoring/Visualizar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: customerId description: Código do cliente (codcli) in: query type: string – name: situation description: Situação do ambiente in: query type: string allOf: – #/definitions/environmentSituation – name: agentVersion description: Versão do agente (igualdade exata) in: query type: string – name: withProblem description: Só os ambientes com problema no status reportado pelo agente (agentProblem); ambientes substituídos nunca entram in: query type: boolean – name: pageNumber description: Número da página (base 0); padrão 0 in: query type: integer format: int64 – name: pageSize description: Tamanho da página; padrão 20, máximo 100 in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – items – total – versions properties: items: type: array items: type: object allOf: – #/definitions/agentEnvironmentDTO minimum: 1 description: Ambientes da página total: type: integer format: int64 description: Total de ambientes com os filtros (sem paginação) versions: type: array items: type: object allOf: – #/definitions/agentVersionCountDTO minimum: 1 description: Ambientes por versão do agente e situação, com o filtro de cliente e sem os de situação e versão; da versão mais nova à mais antiga, sem versão por último 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/queries/listReportAnomalies: post: description: Lista paginada das anomalias reportadas pelos agentes (aba Anomalias da página Monitoramento), das mais recentes às mais antigas, mais o agregado por dia e tipo para o gráfico. Exige telemetryMonitoring/Visualizar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate properties: startDate: type: string format: date description: Primeiro dia do período do registro da anomalia endDate: type: string format: date description: Último dia do período do registro da anomalia, inclusive. Não passa de hoje, e o período tem até sbs.upload.dedupwindowdays dias timeZone: type: string description: Fuso do usuário (nome IANA, por exemplo America/Sao_Paulo), para o período e os dias de chegada; vazio ou inválido usa UTC. O dia de referência do envio ao SBS é sempre UTC customerId: type: string description: Código do cliente (codcli) environment: type: string description: Ambiente (igualdade exata) kind: type: string description: Tipo da anomalia (igualdade exata), como INTEGRITY, DATABASE_SCHEMA ou TBS dismissed: type: boolean description: true: só as anomalias descartadas; vazio ou false: só as ativas. Vale para a lista e para o agregado pageNumber: type: integer format: int64 description: Número da página (base 0); padrão 0 pageSize: type: integer format: int64 description: Tamanho da página; padrão 20, máximo 100 responses: 200: description: Ok schema: type: object required: – items – total – daily properties: items: type: array items: type: object allOf: – #/definitions/reportAnomalyItemDTO minimum: 1 description: Anomalias da página total: type: integer format: int64 description: Total de anomalias com os filtros (sem paginação) daily: type: array items: type: object allOf: – #/definitions/reportAnomalyDailyDTO minimum: 1 description: Anomalias por dia (no fuso timeZone) e tipo, no período, no cliente e no ambiente, sem o filtro de tipo; do dia mais antigo ao mais recente e, no dia, por tipo. Dias sem anomalia ficam de fora 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista paginada das anomalias reportadas pelos agentes (aba Anomalias da página Monitoramento), das mais recentes às mais antigas, mais o agregado por dia e tipo para o gráfico. Exige telemetryMonitoring/Visualizar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: startDate description: Primeiro dia do período do registro da anomalia in: query required: true type: string format: date – name: endDate description: Último dia do período do registro da anomalia, inclusive. Não passa de hoje, e o período tem até sbs.upload.dedupwindowdays dias in: query required: true type: string format: date – name: timeZone description: Fuso do usuário (nome IANA, por exemplo America/Sao_Paulo), para o período e os dias de chegada; vazio ou inválido usa UTC. O dia de referência do envio ao SBS é sempre UTC in: query type: string – name: customerId description: Código do cliente (codcli) in: query type: string – name: environment description: Ambiente (igualdade exata) in: query type: string – name: kind description: Tipo da anomalia (igualdade exata), como INTEGRITY, DATABASE_SCHEMA ou TBS in: query type: string – name: dismissed description: true: só as anomalias descartadas; vazio ou false: só as ativas. Vale para a lista e para o agregado in: query type: boolean – name: pageNumber description: Número da página (base 0); padrão 0 in: query type: integer format: int64 – name: pageSize description: Tamanho da página; padrão 20, máximo 100 in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – items – total – daily properties: items: type: array items: type: object allOf: – #/definitions/reportAnomalyItemDTO minimum: 1 description: Anomalias da página total: type: integer format: int64 description: Total de anomalias com os filtros (sem paginação) daily: type: array items: type: object allOf: – #/definitions/reportAnomalyDailyDTO minimum: 1 description: Anomalias por dia (no fuso timeZone) e tipo, no período, no cliente e no ambiente, sem o filtro de tipo; do dia mais antigo ao mais recente e, no dia, por tipo. Dias sem anomalia ficam de fora 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/queries/listRestoreExecutions: post: description: Lista paginada das restaurações de arquivos brutos (aba Histórico da página Monitoramento), das mais recentes às mais antigas, pela data da solicitação. Não traz o link do ZIP: ele sai pela getRestoreExecution, protegida pelo recurso telemetry. Exige telemetryMonitoring/Visualizar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate properties: startDate: type: string format: date description: Primeiro dia do período da solicitação endDate: type: string format: date description: Último dia do período da solicitação, inclusive. Não passa de hoje, e o período tem até sbs.upload.dedupwindowdays dias timeZone: type: string description: Fuso do usuário (nome IANA, por exemplo America/Sao_Paulo), para o período e os dias de chegada; vazio ou inválido usa UTC. O dia de referência do envio ao SBS é sempre UTC customerId: type: string description: Código do cliente (codcli) status: type: string allOf: – #/definitions/restoreExecutionStatus description: Situação da restauração pageNumber: type: integer format: int64 description: Número da página (base 0); padrão 0 pageSize: type: integer format: int64 description: Tamanho da página; padrão 20, máximo 100 responses: 200: description: Ok schema: type: object required: – items – total properties: items: type: array items: type: object allOf: – #/definitions/restoreExecutionItemDTO minimum: 1 description: Restaurações da página total: type: integer format: int64 description: Total de restaurações com os filtros (sem paginação) 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista paginada das restaurações de arquivos brutos (aba Histórico da página Monitoramento), das mais recentes às mais antigas, pela data da solicitação. Não traz o link do ZIP: ele sai pela getRestoreExecution, protegida pelo recurso telemetry. Exige telemetryMonitoring/Visualizar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: startDate description: Primeiro dia do período da solicitação in: query required: true type: string format: date – name: endDate description: Último dia do período da solicitação, inclusive. Não passa de hoje, e o período tem até sbs.upload.dedupwindowdays dias in: query required: true type: string format: date – name: timeZone description: Fuso do usuário (nome IANA, por exemplo America/Sao_Paulo), para o período e os dias de chegada; vazio ou inválido usa UTC. O dia de referência do envio ao SBS é sempre UTC in: query type: string – name: customerId description: Código do cliente (codcli) in: query type: string – name: status description: Situação da restauração in: query type: string allOf: – #/definitions/restoreExecutionStatus – name: pageNumber description: Número da página (base 0); padrão 0 in: query type: integer format: int64 – name: pageSize description: Tamanho da página; padrão 20, máximo 100 in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – items – total properties: items: type: array items: type: object allOf: – #/definitions/restoreExecutionItemDTO minimum: 1 description: Restaurações da página total: type: integer format: int64 description: Total de restaurações com os filtros (sem paginação) 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/queries/listRestoreExecutionFiles: post: description: Lista paginada dos arquivos de uma restauração (o detalhe dela na aba Histórico), do mais antigo ao mais recente pela chegada, com o resultado de cada um: incluído no ZIP, bruto vencido ou falha ao baixar. A restauração que falha por inteiro (volume acima do limite, erro no envio do ZIP) não lista arquivos. Exige telemetryMonitoring/Visualizar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – executionId properties: executionId: type: string description: Identificador da restauração (UUID) status: type: string allOf: – #/definitions/restoreHistoricalFileStatus description: Resultado do arquivo pageNumber: type: integer format: int64 description: Número da página (base 0); padrão 0 pageSize: type: integer format: int64 description: Tamanho da página; padrão 20, máximo 100 responses: 200: description: Ok schema: type: object required: – items – total properties: items: type: array items: type: object allOf: – #/definitions/restoreHistoricalFileStatusDTO minimum: 1 description: Arquivos da página total: type: integer format: int64 description: Total de arquivos com o filtro (sem paginação) 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista paginada dos arquivos de uma restauração (o detalhe dela na aba Histórico), do mais antigo ao mais recente pela chegada, com o resultado de cada um: incluído no ZIP, bruto vencido ou falha ao baixar. A restauração que falha por inteiro (volume acima do limite, erro no envio do ZIP) não lista arquivos. Exige telemetryMonitoring/Visualizar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: executionId description: Identificador da restauração (UUID) in: query required: true type: string – name: status description: Resultado do arquivo in: query type: string allOf: – #/definitions/restoreHistoricalFileStatus – name: pageNumber description: Número da página (base 0); padrão 0 in: query type: integer format: int64 – name: pageSize description: Tamanho da página; padrão 20, máximo 100 in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – items – total properties: items: type: array items: type: object allOf: – #/definitions/restoreHistoricalFileStatusDTO minimum: 1 description: Arquivos da página total: type: integer format: int64 description: Total de arquivos com o filtro (sem paginação) 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/queries/listReprocessRequests: post: description: Lista paginada das solicitações de reenvio ao SBS e de reprocessamento (aba Histórico da página Monitoramento), das mais recentes às mais antigas, pela data da solicitação. Exige telemetryMonitoring/Visualizar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – startDate – endDate properties: startDate: type: string format: date description: Primeiro dia do período da solicitação endDate: type: string format: date description: Último dia do período da solicitação, inclusive. Não passa de hoje, e o período tem até sbs.upload.dedupwindowdays dias timeZone: type: string description: Fuso do usuário (nome IANA, por exemplo America/Sao_Paulo), para o período e os dias de chegada; vazio ou inválido usa UTC. O dia de referência do envio ao SBS é sempre UTC customerId: type: string description: Código do cliente (codcli): solicitações com algum item do cliente kind: type: string allOf: – #/definitions/reprocessRequestKind description: Tipo da solicitação status: type: string allOf: – #/definitions/reprocessRequestStatus description: Situação da solicitação pageNumber: type: integer format: int64 description: Número da página (base 0); padrão 0 pageSize: type: integer format: int64 description: Tamanho da página; padrão 20, máximo 100 responses: 200: description: Ok schema: type: object required: – items – total properties: items: type: array items: type: object allOf: – #/definitions/reprocessRequestDTO minimum: 1 description: Solicitações da página total: type: integer format: int64 description: Total de solicitações com os filtros (sem paginação) 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista paginada das solicitações de reenvio ao SBS e de reprocessamento (aba Histórico da página Monitoramento), das mais recentes às mais antigas, pela data da solicitação. Exige telemetryMonitoring/Visualizar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: startDate description: Primeiro dia do período da solicitação in: query required: true type: string format: date – name: endDate description: Último dia do período da solicitação, inclusive. Não passa de hoje, e o período tem até sbs.upload.dedupwindowdays dias in: query required: true type: string format: date – name: timeZone description: Fuso do usuário (nome IANA, por exemplo America/Sao_Paulo), para o período e os dias de chegada; vazio ou inválido usa UTC. O dia de referência do envio ao SBS é sempre UTC in: query type: string – name: customerId description: Código do cliente (codcli): solicitações com algum item do cliente in: query type: string – name: kind description: Tipo da solicitação in: query type: string allOf: – #/definitions/reprocessRequestKind – name: status description: Situação da solicitação in: query type: string allOf: – #/definitions/reprocessRequestStatus – name: pageNumber description: Número da página (base 0); padrão 0 in: query type: integer format: int64 – name: pageSize description: Tamanho da página; padrão 20, máximo 100 in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – items – total properties: items: type: array items: type: object allOf: – #/definitions/reprocessRequestDTO minimum: 1 description: Solicitações da página total: type: integer format: int64 description: Total de solicitações com os filtros (sem paginação) 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/queries/listReprocessRequestItems: post: description: Lista paginada dos itens de uma solicitação de reenvio ou de reprocessamento, por cliente e dia ou arquivo. Exige telemetryMonitoring/Visualizar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – requestId properties: requestId: type: string description: Identificador da solicitação (UUID) status: type: string allOf: – #/definitions/reprocessItemStatus description: Situação do item pageNumber: type: integer format: int64 description: Número da página (base 0); padrão 0 pageSize: type: integer format: int64 description: Tamanho da página; padrão 20, máximo 100 responses: 200: description: Ok schema: type: object required: – items – total properties: items: type: array items: type: object allOf: – #/definitions/reprocessRequestItemDTO minimum: 1 description: Itens da página total: type: integer format: int64 description: Total de itens com o filtro (sem paginação) 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista paginada dos itens de uma solicitação de reenvio ou de reprocessamento, por cliente e dia ou arquivo. Exige telemetryMonitoring/Visualizar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: requestId description: Identificador da solicitação (UUID) in: query required: true type: string – name: status description: Situação do item in: query type: string allOf: – #/definitions/reprocessItemStatus – name: pageNumber description: Número da página (base 0); padrão 0 in: query type: integer format: int64 – name: pageSize description: Tamanho da página; padrão 20, máximo 100 in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – items – total properties: items: type: array items: type: object allOf: – #/definitions/reprocessRequestItemDTO minimum: 1 description: Itens da página total: type: integer format: int64 description: Total de itens com o filtro (sem paginação) 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/queries/getPendingQueryExecutions: post: description: Obter query executions pendentes do ambiente (status PENDING; não altera status) tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/getPendingQueryExecutionsInputDTO responses: 200: description: Ok schema: type: object allOf: – #/definitions/getPendingQueryExecutionsOutputDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/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 /telemetry_hub/queries/exportBlockingRule: 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 /telemetry_hub/queries/exportBlockingRulePattern: 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 /telemetry_hub/queries/exportBlockingRuleContext: 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 /telemetry_hub/queries/exportBlockingRuleLimit: 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 /telemetry_hub/queries/exportBlockingRuleCustomer: 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 /telemetry_hub/queries/exportBlockingRuleEnvironment: 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 /telemetry_hub/queries/exportStringPool: 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 /telemetry_hub/queries/exportTelemetry: 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 /telemetry_hub/queries/exportTelemetryWebservice: 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 /telemetry_hub/queries/exportTelemetryWeb50: 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 /telemetry_hub/queries/exportTelemetryBusiness: 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 /telemetry_hub/queries/exportUploadProcess: 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 /telemetry_hub/queries/exportEnvironment: 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 /telemetry_hub/queries/exportReportAnomaly: 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 /telemetry_hub/queries/exportProductConfig: 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 /telemetry_hub/queries/exportQueryExecutionBlobService: 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 /telemetry_hub/queries/exportQueryExecution: 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 /telemetry_hub/queries/exportQueryExecutionPhaseLog: 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 /telemetry_hub/queries/exportProcessedEvent: 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 /telemetry_hub/queries/exportProcessedBatch: 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 /telemetry_hub/queries/exportEventPartStaging: 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 /telemetry_hub/queries/exportExternalPolicyLink: 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 /telemetry_hub/queries/exportRestoreExecution: 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 /telemetry_hub/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 /telemetry_hub/queries/healthcheck: post: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/actions/requestWebserviceUpload: post: description: API DEPRECIADA: Utilizar requestWebserviceUpload__2 com wsUploadRequestInputDTO__2. | DATA: 2026-12-31 | Solicitar URL pré-assinada para upload dos dados – webservice tags: – Actions deprecated : true x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/uploadRequestInputDTO responses: 200: description: Ok schema: type: object allOf: – #/definitions/uploadRequestResultDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/actions/requestWebserviceUpload__2: post: description: Solicitar URL pré-assinada para upload dos dados – webservice tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/wsUploadRequestInputDTO__2 responses: 200: description: Ok schema: type: object allOf: – #/definitions/uploadRequestResultDTO__2 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/actions/requestClientServerUpload__2: post: description: Solicitar URL pré-assinada para upload dos dados – client-server tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/csUploadRequestInputDTO__2 responses: 200: description: Ok schema: type: object allOf: – #/definitions/uploadRequestResultDTO__2 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/actions/requestWeb50Upload__2: post: description: Solicitar URL pré-assinada para upload dos dados – web 5.0 tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/w50UploadRequestInputDTO__2 responses: 200: description: Ok schema: type: object allOf: – #/definitions/uploadRequestResultDTO__2 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/actions/createReportAnomaly: post: description: Registrar anomalia detectada pelo agente tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/createReportAnomalyInputDTO responses: 200: description: Ok schema: type: object allOf: – #/definitions/createReportAnomalyOutputDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/actions/reportAgentStatus: post: description: Registrar o estado do agente (G1): a fila R904URS, o último upload, os modos e o início do processo. Chamada pelo agente 2.8.0 a cada ciclo do job de upload, como melhor esforço. Guarda só o estado atual do ambiente. Exige telemetry/Incluir, como o upload tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – environment – pendingRows – failedRows – inProcessRows – maintenanceMode – withoutCryptographyKey – startedAt properties: environment: type: object allOf: – #/definitions/environmentDTO description: Ambiente pendingRows: type: integer format: int64 description: Linhas pendentes de envio na R904URS (STATUS 0) failedRows: type: integer format: int64 description: Linhas descartadas na R904URS (STATUS -1), por falha de decrypt ou parse inProcessRows: type: integer format: int64 description: Linhas em envio na R904URS (STATUS 1), medidas antes de o ciclo marcar qualquer linha: são as linhas presas lastSuccessfulUploadAt: type: string format: date-time description: Último upload de telemetria concluído pelo agente; vazio se ainda não houve desde a 2.8.0 maintenanceMode: type: boolean description: Base em manutenção: enquanto durar, o agente não envia withoutCryptographyKey: type: boolean description: Agente sem a chave de criptografia da instalação (modo degradado): não lê as linhas gravadas criptografadas, que vão para descarte startedAt: type: string format: date-time description: Início do processo do agente responses: 200: description: Ok schema: type: object required: – reportedAt properties: reportedAt: type: string format: date-time description: Instante em que o Hub registrou o estado (UTC) 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/actions/cancelQueryExecution: post: description: Cancelar uma query execution ainda pendente tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/cancelQueryExecutionInputDTO responses: 200: description: Ok schema: type: object allOf: – #/definitions/cancelQueryExecutionOutputDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/actions/requestRestoreHistoricalData: post: description: Solicitar restauração assíncrona dos arquivos brutos de um cliente, só para baixá-los: arquivos escolhidos (fileIds, de 1 a 100) ou todos os do período (startDate e endDate), de qualquer situação com o bruto ainda disponível tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/requestRestoreHistoricalDataInputDTO responses: 200: description: Ok schema: type: object allOf: – #/definitions/requestRestoreHistoricalDataOutputDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/actions/dismissReportAnomalies: post: description: Descarta anomalias falso positivo (soft delete): saem da lista e do gráfico e são apagadas pela retenção diária depois de sbs.upload.dedupwindowdays dias. Dois modos, exclusivos: seleção (ids) ou lote pelos filtros da listReportAnomalies com o total esperado (expectedCount). Anomalias já descartadas são ignoradas. Exige telemetryMonitoring/DescartarAnomalias tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – reason properties: ids: type: array items: type: string description: Seleção: IDs das anomalias, até 100 startDate: type: string format: date description: Lote: primeiro dia do período do registro endDate: type: string format: date description: Lote: último dia do período do registro, inclusive; mesmas regras da listReportAnomalies timeZone: type: string description: Fuso do usuário (nome IANA, por exemplo America/Sao_Paulo), para o período e os dias de chegada; vazio ou inválido usa UTC. O dia de referência do envio ao SBS é sempre UTC customerId: type: string description: Lote: código do cliente (codcli) environment: type: string description: Lote: ambiente (igualdade exata) kind: type: string description: Lote: tipo da anomalia (igualdade exata) expectedCount: type: integer format: int64 description: Lote: anomalias ativas com os filtros, como a tela mostrou (de 1 a 10.000). Se o total atual for outro, nada é descartado reason: type: string description: Motivo do descarte, até 1.000 caracteres responses: 200: description: Ok schema: type: object required: – dismissed properties: dismissed: type: integer format: int64 description: Anomalias descartadas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/actions/requestSbsResend: post: description: Reenvia ao SBS um dia de referência, inclusive os pares (cliente, dia) já enviados. Dois modos, exclusivos: seleção (customerIds) ou lote pelos filtros da listSbsPendingDays no dia, com o total esperado (expectedCount). Só dia cujo envio diário já rodou. Cada par com dado processado passa pelas guardas S1 (janela), S2 (conteúdo), S3 (bruto disponível, se o dia precisa ser reconstruído) e S6 (em andamento). Se a telemetria do dia já foi purgada (no todo ou em parte), o dia é reconstruído a partir dos brutos de todos os uploads processados dele, com a data original, e enviado uma vez, quando o último termina; o envio sai idêntico ao primeiro, e o SBS deduplica. Despacha em fila LOW e grava a solicitação na auditoria. Exige telemetryMonitoring/Reprocessar tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – referenceDate – reason properties: referenceDate: type: string format: date description: Dia de referência (UTC); anterior ao dia cujo envio diário ainda não rodou customerIds: type: array items: type: string description: Seleção: clientes (codcli) do dia, ao menos um situation: type: string allOf: – #/definitions/sbsSendSituation description: Lote: situação do envio, como na listSbsPendingDays; vazio para as pendências classification: type: string allOf: – #/definitions/sbsPendingClassification description: Lote: classificação da pendência, como na listSbsPendingDays customerId: type: string description: Lote: código do cliente (codcli) expectedCount: type: integer format: int64 description: Lote: pares do dia com os filtros, como a tela mostrou (a partir de 1). Se o total atual for outro, nada é reenviado reason: type: string allOf: – #/definitions/reprocessReason description: Categoria do motivo reasonText: type: string description: Texto do motivo; obrigatório em OTHER, até 500 caracteres responses: 200: description: Ok schema: type: object required: – requestId – accepted – blocked – items properties: requestId: type: string description: Identificador da solicitação na auditoria (UUID) accepted: type: integer format: int64 description: Pares aceitos e despachados blocked: type: integer format: int64 description: Pares bloqueados pelas guardas items: type: array items: type: object allOf: – #/definitions/sbsResendItemDTO minimum: 1 description: Cada par considerado, por cliente 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/actions/requestFileReprocess: post: description: Reprocessa uploads em ERROR a partir do bruto no BlobService, pelos arquivos informados (de 1 a 100, uma página da lista de uploads). Aceita só arquivos em ERROR com o bruto ainda disponível, sem solicitação em andamento para o cliente e o dia (S6). As linhas entram com a data do reprocessamento (created_date e persistedAt): vão ao SBS no envio diário seguinte, como dado novo, sem reabrir nem reenviar o dia do arquivo. Um signal por arquivo, em fila LOW, e a solicitação vai para a auditoria. Exige telemetryMonitoring/Reprocessar tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fileIds – reason properties: fileIds: type: array items: type: string minimum: 1 description: Arquivos (fileId), de 1 a 100; repetidos contam uma vez reason: type: string allOf: – #/definitions/reprocessReason description: Categoria do motivo reasonText: type: string description: Texto do motivo; obrigatório em OTHER, até 500 caracteres responses: 200: description: Ok schema: type: object required: – requestId – accepted – blocked – items properties: requestId: type: string description: Identificador da solicitação na auditoria (UUID) accepted: type: integer format: int64 description: Arquivos aceitos e despachados blocked: type: integer format: int64 description: Arquivos bloqueados pelas guardas items: type: array items: type: object allOf: – #/definitions/fileReprocessItemDTO minimum: 1 description: Cada arquivo considerado, do mais antigo ao mais recente 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/actions/requestQueryExecutionResultUrl: post: description: Solicitar URL de download do resultado de uma query execution (somente BlobService) tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/requestQueryExecutionResultUrlInputDTO responses: 200: description: Ok schema: type: object allOf: – #/definitions/requestQueryExecutionResultUrlOutputDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/actions/requestQueryExecutionUploadUrl: post: description: Solicitar URL pré-assinada para upload do resultado de uma query execution (BlobService) tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/requestQueryExecutionUploadUrlInputDTO responses: 200: description: Ok schema: type: object allOf: – #/definitions/requestQueryExecutionUploadUrlOutputDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/actions/shbsClientResourcesUpdated: post: description: Webhook SHBS: recebe atualização de recursos do cliente para absorção em blocking_rule. Bearer (loginWithKey) + @SecureResource shbsWebhook/Executar tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/shbsClientResourcesEnvelopeDTO responses: 200: description: Ok schema: type: object allOf: – #/definitions/shbsClientResourcesUpdatedAckDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/actions/shbsClientThrottled: post: description: Webhook SHBS: ativa throttling global do cliente em blocking_rule. Bearer (loginWithKey) + @SecureResource shbsWebhook/Executar tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/shbsClientThrottledEnvelopeDTO responses: 200: description: Ok schema: type: object allOf: – #/definitions/shbsWebhookAckDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/actions/shbsClientUnthrottled: post: description: Webhook SHBS: desativa throttling global do cliente em blocking_rule. Bearer (loginWithKey) + @SecureResource shbsWebhook/Executar tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/shbsClientUnthrottledEnvelopeDTO responses: 200: description: Ok schema: type: object allOf: – #/definitions/shbsWebhookAckDTO 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/actions/syncShbsClientResources: post: description: Sincronização/reconciliação SHBS via GET: escopo explícito (seniorId/productId) ou sweep de todos os elegíveis (ambos omitidos). Autenticação via Bearer; sem @SecureResource tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: productId: type: string description: Produto SHBS; se omitido, processa todos os produtos mapeados (com seniorId informado) ou os produtos com lotes elegíveis (com seniorId omitido) seniorId: type: integer format: int64 description: Código do cliente; se informado, força a sincronização mesmo sem falha pendente (uso ops) responses: 200: description: Ok schema: type: object properties: processed: type: array items: type: object allOf: – #/definitions/syncShbsClientResourcesProcessedItemDTO description: failed: type: array items: type: object allOf: – #/definitions/syncShbsClientResourcesFailedItemDTO description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/actions/importBlockingRule: 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 /telemetry_hub/actions/importBlockingRulePattern: 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 /telemetry_hub/actions/importBlockingRuleContext: 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 /telemetry_hub/actions/importBlockingRuleLimit: 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 /telemetry_hub/actions/importBlockingRuleCustomer: 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 /telemetry_hub/actions/importBlockingRuleEnvironment: 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 /telemetry_hub/actions/importStringPool: 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 /telemetry_hub/actions/importTelemetry: 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 /telemetry_hub/actions/importTelemetryWebservice: 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 /telemetry_hub/actions/importTelemetryWeb50: 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 /telemetry_hub/actions/importTelemetryBusiness: 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 /telemetry_hub/actions/importUploadProcess: 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 /telemetry_hub/actions/importEnvironment: 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 /telemetry_hub/actions/importReportAnomaly: 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 /telemetry_hub/actions/importProductConfig: 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 /telemetry_hub/actions/importQueryExecutionBlobService: 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 /telemetry_hub/actions/importQueryExecution: 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 /telemetry_hub/actions/importQueryExecutionPhaseLog: 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 /telemetry_hub/actions/importProcessedEvent: 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 /telemetry_hub/actions/importProcessedBatch: 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 /telemetry_hub/actions/importEventPartStaging: 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 /telemetry_hub/actions/importExternalPolicyLink: 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 /telemetry_hub/actions/importRestoreExecution: 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 /telemetry_hub/signals/commitWebserviceFile: post: description: Confirmar a gravação do arquivo no serviço na versão em que ocorreu o upload tags: – Signals parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/fileCommitInputDTO responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /telemetry_hub/signals/commitFile: post: description: Confirmar a gravação do arquivo e iniciar processamento (genérico) tags: – Signals parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/commitFileInputDTO responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /telemetry_hub/signals/sbsClientUpload: post: description: Disparo assíncrono de upload SBS por cliente — consumido internamente pelo pipeline tags: – Signals parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/sbsClientUploadInput responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /telemetry_hub/signals/sbsDailyUpload: post: description: Gatilho diário do pipeline de upload SBS — acionado pelo agendador da plataforma tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: referenceDate: type: string format: date description: Data de referência ISO_LOCAL_DATE responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /telemetry_hub/signals/telemetryRetention: post: description: Gatilho diário da retenção — acionado pelo agendador da plataforma: limpa as tabelas de controle vencidas tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /telemetry_hub/signals/telemetryHourlyPurge: post: description: Gatilho horário do purge da telemetria — acionado pelo agendador da plataforma: apaga, até o volume da hora, a telemetria dos dias confirmados no envio SBS e mais antigos que a retenção tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /telemetry_hub/signals/clientBlocked: post: description: Webhook: cliente bloqueado na plataforma tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – seniorId properties: seniorId: type: string description: ID Senior do cliente responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /telemetry_hub/signals/clientUnblocked: post: description: Webhook: cliente desbloqueado na plataforma tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – seniorId properties: seniorId: type: string description: ID Senior do cliente responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /telemetry_hub/signals/developerDeactivated: post: description: Webhook: parceiro/desenvolvedor desativado na plataforma tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: ID do desenvolvedor responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /telemetry_hub/signals/developerActivated: post: description: Webhook: parceiro/desenvolvedor ativado na plataforma tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: ID do desenvolvedor responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /telemetry_hub/signals/processRestoreExecution: post: description: Signal interno para processamento assíncrono em background de uma restauração histórica tags: – Signals parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/processRestoreExecutionInputDTO responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /telemetry_hub/signals/processFileReprocess: post: description: Reprocessa um arquivo de uma solicitação da requestFileReprocess a partir do bruto no BlobService — consumido internamente tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – requestId – fileId – rebuildDay properties: requestId: type: string description: Identificador da solicitação na auditoria (UUID) fileId: type: string description: Arquivo no BlobService rebuildDay: type: boolean description: Reconstrução de um dia para o reenvio ao SBS: o arquivo entra com a data original e o dia é enviado quando o último arquivo dele termina; falso reprocessa com a data de agora (arquivo em ERROR) responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /telemetry_hub/signals/reportQueryExecutionPhase: post: description: Reportar fase de execução de uma query execution tags: – Signals parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/reportQueryExecutionPhaseInputDTO responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /telemetry_hub/signals/shbsOrphanBatchSweep: post: description: Varredura periódica SHBS: classifica lotes STAGING incompletos além do TTL como ORPHAN e sincroniza pares elegíveis (ORPHAN/FAILED) via GET/rebuild, marcando-os RESOLVED_BY_SYNC no sucesso — acionado pelo agendador da plataforma tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: ttlHours: type: integer format: int64 description: TTL em horas para considerar um lote órfão; se omitido, usa o valor configurado (shbs.batch.orphanttlhours) responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /telemetry_hub/events/importBlockingRuleEvent: 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 /telemetry_hub/events/exportBlockingRuleEvent: 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 /telemetry_hub/events/importBlockingRulePatternEvent: 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 /telemetry_hub/events/exportBlockingRulePatternEvent: 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 /telemetry_hub/events/importBlockingRuleContextEvent: 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 /telemetry_hub/events/exportBlockingRuleContextEvent: 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 /telemetry_hub/events/importBlockingRuleLimitEvent: 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 /telemetry_hub/events/exportBlockingRuleLimitEvent: 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 /telemetry_hub/events/importBlockingRuleCustomerEvent: 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 /telemetry_hub/events/exportBlockingRuleCustomerEvent: 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 /telemetry_hub/events/importBlockingRuleEnvironmentEvent: 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 /telemetry_hub/events/exportBlockingRuleEnvironmentEvent: 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 /telemetry_hub/events/importStringPoolEvent: 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 /telemetry_hub/events/exportStringPoolEvent: 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 /telemetry_hub/events/importTelemetryEvent: 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 /telemetry_hub/events/exportTelemetryEvent: 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 /telemetry_hub/events/importTelemetryWebserviceEvent: 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 /telemetry_hub/events/exportTelemetryWebserviceEvent: 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 /telemetry_hub/events/importTelemetryWeb50Event: 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 /telemetry_hub/events/exportTelemetryWeb50Event: 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 /telemetry_hub/events/importTelemetryBusinessEvent: 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 /telemetry_hub/events/exportTelemetryBusinessEvent: 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 /telemetry_hub/events/importUploadProcessEvent: 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 /telemetry_hub/events/exportUploadProcessEvent: 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 /telemetry_hub/events/importEnvironmentEvent: 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 /telemetry_hub/events/exportEnvironmentEvent: 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 /telemetry_hub/events/importReportAnomalyEvent: 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 /telemetry_hub/events/exportReportAnomalyEvent: 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 /telemetry_hub/events/importProductConfigEvent: 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 /telemetry_hub/events/exportProductConfigEvent: 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 /telemetry_hub/events/importQueryExecutionBlobServiceEvent: 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 /telemetry_hub/events/exportQueryExecutionBlobServiceEvent: 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 /telemetry_hub/events/importQueryExecutionEvent: 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 /telemetry_hub/events/exportQueryExecutionEvent: 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 /telemetry_hub/events/importQueryExecutionPhaseLogEvent: 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 /telemetry_hub/events/exportQueryExecutionPhaseLogEvent: 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 /telemetry_hub/events/importProcessedEventEvent: 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 /telemetry_hub/events/exportProcessedEventEvent: 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 /telemetry_hub/events/importProcessedBatchEvent: 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 /telemetry_hub/events/exportProcessedBatchEvent: 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 /telemetry_hub/events/importEventPartStagingEvent: 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 /telemetry_hub/events/exportEventPartStagingEvent: 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 /telemetry_hub/events/importExternalPolicyLinkEvent: 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 /telemetry_hub/events/exportExternalPolicyLinkEvent: 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 /telemetry_hub/events/importRestoreExecutionEvent: 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 /telemetry_hub/events/exportRestoreExecutionEvent: 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 /telemetry_hub/entities/blockingRule: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/blockingRule responses: 200: description: The created resource schema: #/definitions/blockingRule 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/blockingRule responses: 200: description: The created resource schema: #/definitions/blockingRule 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/blockingRule 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/entities/blockingRule/{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/editBlockingRule responses: 200: description: Ok schema: #/definitions/editBlockingRule 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/blockingRule responses: 200: description: Ok schema: #/definitions/blockingRule 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/blockingRule 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 /telemetry_hub/entities/blockingRule/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/blockingRule responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/entities/blockingRulePattern: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/blockingRulePattern responses: 200: description: The created resource schema: #/definitions/blockingRulePattern 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/blockingRulePattern responses: 200: description: The created resource schema: #/definitions/blockingRulePattern 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/blockingRulePattern 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/entities/blockingRulePattern/{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/editBlockingRulePattern responses: 200: description: Ok schema: #/definitions/editBlockingRulePattern 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/blockingRulePattern responses: 200: description: Ok schema: #/definitions/blockingRulePattern 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/blockingRulePattern 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 /telemetry_hub/entities/blockingRule/{parentId}/patterns: 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/blockingRulePattern responses: 200: description: The created resources schema: type: array items: #/definitions/blockingRulePattern 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/blockingRulePattern responses: 200: description: The created resources schema: type: array items: #/definitions/blockingRulePattern 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/blockingRulePattern 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/entities/blockingRule/{parentId}/patterns/{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/editBlockingRulePattern responses: 200: description: Ok schema: #/definitions/editBlockingRulePattern 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/blockingRulePattern responses: 200: description: Ok schema: #/definitions/blockingRulePattern 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/blockingRulePattern 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 /telemetry_hub/entities/blockingRulePattern/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/blockingRulePattern responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/entities/blockingRuleContext: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/blockingRuleContext responses: 200: description: The created resource schema: #/definitions/blockingRuleContext 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/blockingRuleContext responses: 200: description: The created resource schema: #/definitions/blockingRuleContext 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/blockingRuleContext 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/entities/blockingRuleContext/{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/editBlockingRuleContext responses: 200: description: Ok schema: #/definitions/editBlockingRuleContext 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/blockingRuleContext responses: 200: description: Ok schema: #/definitions/blockingRuleContext 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/blockingRuleContext 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 /telemetry_hub/entities/blockingRule/{parentId}/contexts: 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/blockingRuleContext responses: 200: description: The created resources schema: type: array items: #/definitions/blockingRuleContext 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/blockingRuleContext responses: 200: description: The created resources schema: type: array items: #/definitions/blockingRuleContext 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/blockingRuleContext 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/entities/blockingRule/{parentId}/contexts/{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/editBlockingRuleContext responses: 200: description: Ok schema: #/definitions/editBlockingRuleContext 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/blockingRuleContext responses: 200: description: Ok schema: #/definitions/blockingRuleContext 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/blockingRuleContext 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 /telemetry_hub/entities/blockingRuleContext/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/blockingRuleContext responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/entities/blockingRuleLimit: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/blockingRuleLimit responses: 200: description: The created resource schema: #/definitions/blockingRuleLimit 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/blockingRuleLimit responses: 200: description: The created resource schema: #/definitions/blockingRuleLimit 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/blockingRuleLimit 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/entities/blockingRuleLimit/{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/editBlockingRuleLimit responses: 200: description: Ok schema: #/definitions/editBlockingRuleLimit 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/blockingRuleLimit responses: 200: description: Ok schema: #/definitions/blockingRuleLimit 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/blockingRuleLimit 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 /telemetry_hub/entities/blockingRule/{parentId}/limits: 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/blockingRuleLimit responses: 200: description: The created resources schema: type: array items: #/definitions/blockingRuleLimit 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/blockingRuleLimit responses: 200: description: The created resources schema: type: array items: #/definitions/blockingRuleLimit 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/blockingRuleLimit 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/entities/blockingRule/{parentId}/limits/{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/editBlockingRuleLimit responses: 200: description: Ok schema: #/definitions/editBlockingRuleLimit 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/blockingRuleLimit responses: 200: description: Ok schema: #/definitions/blockingRuleLimit 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/blockingRuleLimit 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 /telemetry_hub/entities/blockingRuleLimit/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/blockingRuleLimit responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/entities/blockingRuleCustomer: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/blockingRuleCustomer responses: 200: description: The created resource schema: #/definitions/blockingRuleCustomer 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/blockingRuleCustomer responses: 200: description: The created resource schema: #/definitions/blockingRuleCustomer 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/blockingRuleCustomer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/entities/blockingRuleCustomer/{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/editBlockingRuleCustomer responses: 200: description: Ok schema: #/definitions/editBlockingRuleCustomer 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/blockingRuleCustomer responses: 200: description: Ok schema: #/definitions/blockingRuleCustomer 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/blockingRuleCustomer 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 /telemetry_hub/entities/blockingRule/{parentId}/customers: 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/blockingRuleCustomer responses: 200: description: The created resources schema: type: array items: #/definitions/blockingRuleCustomer 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/blockingRuleCustomer responses: 200: description: The created resources schema: type: array items: #/definitions/blockingRuleCustomer 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/blockingRuleCustomer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/entities/blockingRule/{parentId}/customers/{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/editBlockingRuleCustomer responses: 200: description: Ok schema: #/definitions/editBlockingRuleCustomer 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/blockingRuleCustomer responses: 200: description: Ok schema: #/definitions/blockingRuleCustomer 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/blockingRuleCustomer 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 /telemetry_hub/entities/blockingRuleCustomer/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/blockingRuleCustomer responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/entities/blockingRuleEnvironment: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/blockingRuleEnvironment responses: 200: description: The created resource schema: #/definitions/blockingRuleEnvironment 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/blockingRuleEnvironment responses: 200: description: The created resource schema: #/definitions/blockingRuleEnvironment 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/blockingRuleEnvironment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/entities/blockingRuleEnvironment/{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/editBlockingRuleEnvironment responses: 200: description: Ok schema: #/definitions/editBlockingRuleEnvironment 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/blockingRuleEnvironment responses: 200: description: Ok schema: #/definitions/blockingRuleEnvironment 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/blockingRuleEnvironment 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 /telemetry_hub/entities/blockingRule/{parentId}/environments: 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/blockingRuleEnvironment responses: 200: description: The created resources schema: type: array items: #/definitions/blockingRuleEnvironment 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/blockingRuleEnvironment responses: 200: description: The created resources schema: type: array items: #/definitions/blockingRuleEnvironment 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/blockingRuleEnvironment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/entities/blockingRule/{parentId}/environments/{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/editBlockingRuleEnvironment responses: 200: description: Ok schema: #/definitions/editBlockingRuleEnvironment 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/blockingRuleEnvironment responses: 200: description: Ok schema: #/definitions/blockingRuleEnvironment 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/blockingRuleEnvironment 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 /telemetry_hub/entities/blockingRuleEnvironment/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/blockingRuleEnvironment responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/entities/telemetry: 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/telemetry 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/entities/telemetry/{parentId}/telemetryWebservice: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/telemetryWebservice responses: 200: description: The created resource schema: #/definitions/telemetryWebservice 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: object allOf: – #/definitions/telemetryWebservice responses: 200: description: The created resource schema: #/definitions/telemetryWebservice 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/telemetryWebservice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/entities/telemetry/{parentId}/telemetryWebservice/{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/editTelemetryWebservice responses: 200: description: Ok schema: #/definitions/editTelemetryWebservice 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/telemetryWebservice responses: 200: description: Ok schema: #/definitions/telemetryWebservice 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/telemetryWebservice 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 /telemetry_hub/entities/telemetry/{parentId}/telemetryWeb50: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/telemetryWeb50 responses: 200: description: The created resource schema: #/definitions/telemetryWeb50 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: object allOf: – #/definitions/telemetryWeb50 responses: 200: description: The created resource schema: #/definitions/telemetryWeb50 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/telemetryWeb50 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/entities/telemetry/{parentId}/telemetryWeb50/{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/editTelemetryWeb50 responses: 200: description: Ok schema: #/definitions/editTelemetryWeb50 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/telemetryWeb50 responses: 200: description: Ok schema: #/definitions/telemetryWeb50 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/telemetryWeb50 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 /telemetry_hub/entities/telemetry/{parentId}/telemetryBusiness: 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/telemetryBusiness responses: 200: description: The created resources schema: type: array items: #/definitions/telemetryBusiness 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/telemetryBusiness responses: 200: description: The created resources schema: type: array items: #/definitions/telemetryBusiness 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/telemetryBusiness 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/entities/telemetry/{parentId}/telemetryBusiness/{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/editTelemetryBusiness responses: 200: description: Ok schema: #/definitions/editTelemetryBusiness 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/telemetryBusiness responses: 200: description: Ok schema: #/definitions/telemetryBusiness 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/telemetryBusiness 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 /telemetry_hub/entities/queryExecutionBlobService: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/queryExecutionBlobService responses: 200: description: The created resource schema: #/definitions/queryExecutionBlobService 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/queryExecutionBlobService responses: 200: description: The created resource schema: #/definitions/queryExecutionBlobService 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/queryExecutionBlobService 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/entities/queryExecutionBlobService/{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/editQueryExecutionBlobService responses: 200: description: Ok schema: #/definitions/editQueryExecutionBlobService 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/queryExecutionBlobService responses: 200: description: Ok schema: #/definitions/queryExecutionBlobService 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/queryExecutionBlobService 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 /telemetry_hub/entities/queryExecutionBlobService/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/queryExecutionBlobService responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/entities/queryExecution: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/queryExecution responses: 200: description: The created resource schema: #/definitions/queryExecution 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/queryExecution responses: 200: description: The created resource schema: #/definitions/queryExecution 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/queryExecution 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/entities/queryExecution/{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/editQueryExecution responses: 200: description: Ok schema: #/definitions/editQueryExecution 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/queryExecution responses: 200: description: Ok schema: #/definitions/queryExecution 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/queryExecution 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 /telemetry_hub/entities/queryExecution/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/queryExecution responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/entities/queryExecution/{parentId}/phaseLogs: 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/queryExecutionPhaseLog responses: 200: description: The created resources schema: type: array items: #/definitions/queryExecutionPhaseLog 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/queryExecutionPhaseLog responses: 200: description: The created resources schema: type: array items: #/definitions/queryExecutionPhaseLog 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/queryExecutionPhaseLog 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /telemetry_hub/entities/queryExecution/{parentId}/phaseLogs/{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/editQueryExecutionPhaseLog responses: 200: description: Ok schema: #/definitions/editQueryExecutionPhaseLog 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/queryExecutionPhaseLog responses: 200: description: Ok schema: #/definitions/queryExecutionPhaseLog 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/queryExecutionPhaseLog 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: systemType: type: string enum: – VETORH – SAPIENS – SEGURANCA – TECNOLOGIA – UNKNOWN description: Tipo de sistema: * `VETORH` – Sistema VetorH * `SAPIENS` – Sistema Sapiens * `SEGURANCA` – Sistema de Segurança * `TECNOLOGIA` – Sistema Tecnologia * `UNKNOWN` – Sistema Desconhecido databaseType: type: string enum: – ORACLE – SQLSERVER – POSTGRESQL description: Tipo do banco de dados do cliente, informado pelo agente. Sem valor para desconhecido: o campo fica nulo. Um tipo novo entra aqui antes de qualquer agente enviá-lo, porque um valor fora da lista invalida a mensagem inteira: * `ORACLE` – Oracle * `SQLSERVER` – Microsoft SQL Server * `POSTGRESQL` – PostgreSQL blockingRuleContextType: type: string enum: – INTERNAL – SENIOR_SISTEMAS – LSP_PROVIDER – EXTERNAL – PARTNER description: Tipo de contexto para regra de bloqueio: * `INTERNAL` – Chamada interna * `SENIOR_SISTEMAS` – Chamada Senior Sistemas * `LSP_PROVIDER` – Chamada LSP * `EXTERNAL` – Chamada externa * `PARTNER` – Parceiro blockingRuleLimitType: type: string enum: – EXECUTIONS – INPUT_PAYLOAD – OUTPUT_PAYLOAD – BLOCKED description: Tipo de limite para regra de bloqueio: * `EXECUTIONS` – Limite de quantidade de execuções * `INPUT_PAYLOAD` – Limite de tamanho do payload de entrada * `OUTPUT_PAYLOAD` – Limite de tamanho do payload de saída * `BLOCKED` – Bloqueio total timeInterval: type: string enum: – MINUTE – HOUR – DAY – WEEK – MONTH description: Intervalo de tempo: * `MINUTE` – Por minuto * `HOUR` – Por hora * `DAY` – Por dia * `WEEK` – Por semana * `MONTH` – Por mês blockingRuleType: type: string enum: – WEBSERVICE – BUSINESS description: Tipo de regra de bloqueio: * `WEBSERVICE` – Webservice * `BUSINESS` – Negócio blockingRuleOrigin: type: string enum: – MANUAL – CLIENT_BLOCK – PARTNER_BLOCK – SHBS_RESOURCE_BLOCK_HCM_XT – SHBS_RESOURCE_BLOCK_ERP_XT – SHBS_RESOURCE_BLOCK_GRS_XT – SHBS_CLIENT_THROTTLE description: Origem da regra de bloqueio: * `MANUAL` – Inserida manualmente * `CLIENT_BLOCK` – Inserida pela rotina de bloqueio de clientes * `PARTNER_BLOCK` – Inserida pela rotina de bloqueio de parceiros * `SHBS_RESOURCE_BLOCK_HCM_XT` – Absorção do webhook SHBS client.resources.updated — produto HCM_XT * `SHBS_RESOURCE_BLOCK_ERP_XT` – Absorção do webhook SHBS client.resources.updated — produto ERP_XT * `SHBS_RESOURCE_BLOCK_GRS_XT` – Absorção do webhook SHBS client.resources.updated — produto GRS_XT * `SHBS_CLIENT_THROTTLE` – Absorção do webhook SHBS client.throttled — throttling global do cliente partnerScope: type: string enum: – ALL – TRUSTED – UNTRUSTED description: Escopo do parceiro para regra de bloqueio: * `ALL` – Todos os parceiros * `TRUSTED` – Confiáveis * `UNTRUSTED` – Não confiáveis dataFormatVersion: type: string enum: – V_00 – V_01 description: Versão do formato de dados (formato de transporte do arquivo): * `V_00` – Versão 00 – CSV * `V_01` – Versão 01 – ZIP com CSV uploadProcessStatus: type: string enum: – REQUESTED – PROCESSED – ERROR description: Status do processo de upload: * `REQUESTED` – Aguardando processamento * `PROCESSED` – Processado com sucesso * `ERROR` – Erro no processamento webserviceDataLayoutVersion: type: string enum: – V_00 – V_01 – V_02 description: Versão do layout dos dados enviados via webservice (campos do CSV): * `V_00` – Versão 00 * `V_01` – Versão 01 * `V_02` – Versão 02 clientServerDataLayoutVersion: type: string enum: – V_00 description: Versão do layout dos dados enviados via client-server (campos do CSV): * `V_00` – Versão 00 web50DataLayoutVersion: type: string enum: – V_00 description: Versão do layout dos dados enviados via web 5.0 (campos do CSV): * `V_00` – Versão 00 businessDataLayoutVersion: type: string enum: – V_00 description: Versão do layout dos dados enviados via negócio (campos do CSV): * `V_00` – Versão 00 uploadMonitoringStatus: type: string enum: – IN_PROGRESS – ORPHAN – PROCESSED – ERROR description: Status de um upload no monitoramento: o aguardando processamento aparece como em andamento ou órfão (mais de 24 h): * `IN_PROGRESS` – Aguardando processamento há até 24 h * `ORPHAN` – Aguardando processamento há mais de 24 h (órfão) * `PROCESSED` – Processado com sucesso * `ERROR` – Erro no processamento sbsPendingClassification: type: string enum: – OUT_OF_WINDOW – ERROR – DISPATCHED – NO_DISPATCH_RECORD description: Classificação de um dia pendente de envio ao SBS. Fora da janela tem precedência sobre as demais: * `OUT_OF_WINDOW` – Fora da janela de reenvio: o primeiro aceite passou de sbs.upload.dedupwindowdays menos sbs.upload.dedupsafetymargindays dias, e o dia não pode mais ser reenviado * `ERROR` – O último envio terminou em erro * `DISPATCHED` – Despachado, sem resultado do envio: mensagem perdida, falha antes de gravar o resultado ou envio ainda em andamento * `NO_DISPATCH_RECORD` – Sem registro de despacho: dia anterior ao registro do envio ou em que o envio diário não rodou sbsSendSituation: type: string enum: – PENDING – COMPLETED – ALL description: Situação do envio ao SBS dos pares (cliente, dia) na aba Envios SBS: * `PENDING` – Pendências: os pares sem envio aceito, classificados (padrão) * `COMPLETED` – Concluídos: os pares com envio SENT ou NO_DATA na sbs_upload_status * `ALL` – Pendências e concluídos environmentSituation: type: string enum: – ACTIVE – SILENT – REPLACED description: Situação de um ambiente no catálogo de contato dos agentes. O limite de silêncio é 3 vezes o menor intervalo de contato que o agente recebe (environmentclient.fetch.intervalminutes, environmentclient.blockingrules.intervalminutes e queryexecution.check.intervalminutes): * `ACTIVE` – Com contato dentro do limite de silêncio * `SILENT` – Sem contato além do limite de silêncio e sem substituto * `REPLACED` – Sem contato além do limite de silêncio e com substituto: outro ambiente do mesmo cliente e sistema cujo primeiro contato é posterior ao último contato deste (por exemplo, a troca de id do Oracle no agente 2.7.0) agentProblem: type: string enum: – DISCARDED_ROWS – STUCK_ROWS – MAINTENANCE – WITHOUT_CRYPTOGRAPHY_KEY – UPLOAD_OVERDUE description: Problema no estado reportado pelo agente (M30): * `DISCARDED_ROWS` – Linhas descartadas na R904URS * `STUCK_ROWS` – Linhas presas em envio na R904URS * `MAINTENANCE` – Base em manutenção * `WITHOUT_CRYPTOGRAPHY_KEY` – Agente sem a chave de criptografia da instalação * `UPLOAD_OVERDUE` – Linhas pendentes e nenhum upload concluído há mais de 48 h reprocessReason: type: string enum: – DAILY_SEND_FAILURE – PROCESSING_ERROR – SBS_REQUEST – BACKLOG_CLEANUP – OTHER description: Categoria do motivo de uma solicitação de reenvio ao SBS ou de reprocessamento. O texto do motivo é obrigatório só em OTHER: * `DAILY_SEND_FAILURE` – Falha no envio diário: dia com erro ou não despachado * `PROCESSING_ERROR` – Erro no processamento do arquivo, como um bug corrigido ou um layout novo * `SBS_REQUEST` – Pedido do SBS ou da DATI, por perda ou correção do lado deles * `BACKLOG_CLEANUP` – Saneamento de passivo * `OTHER` – Outro motivo, descrito no texto reprocessRequestKind: type: string enum: – SBS_RESEND – FILE_REPROCESS description: Tipo de uma solicitação auditada: * `SBS_RESEND` – Reenvio ao SBS de pares (cliente, dia) * `FILE_REPROCESS` – Reprocessamento de arquivos a partir do bruto no BlobService reprocessRequestStatus: type: string enum: – IN_PROGRESS – COMPLETED – COMPLETED_WITH_FAILURES – BLOCKED description: Situação de uma solicitação auditada: * `IN_PROGRESS` – Itens aceitos ainda em execução * `COMPLETED` – Todos os itens aceitos concluídos * `COMPLETED_WITH_FAILURES` – Todos os itens aceitos terminaram, e ao menos um falhou * `BLOCKED` – Nenhum item aceito: todos bloqueados pelas guardas reprocessItemStatus: type: string enum: – ACCEPTED – BLOCKED – COMPLETED – FAILED description: Situação de um item de uma solicitação de reenvio ou de reprocessamento: * `ACCEPTED` – Aceito pelas guardas e em execução * `BLOCKED` – Bloqueado por uma guarda * `COMPLETED` – Aceito e concluído * `FAILED` – Aceito e terminado com falha sbsResendBlockReason: type: string enum: – OUT_OF_WINDOW – CONTENT_CHANGED – RAW_EXPIRED – IN_PROGRESS description: Guarda que bloqueou o reenvio de um par (cliente, dia) ao SBS: * `OUT_OF_WINDOW` – S1: o primeiro aceite no SBS passou de sbs.upload.dedupwindowdays menos sbs.upload.dedupsafetymargindays dias; reenviar contaria em dobro * `CONTENT_CHANGED` – S2: o dia foi aceito com outra versão de geração do CSV ou outra product_config; as linhas novas entrariam além das antigas * `RAW_EXPIRED` – S3: o dia não tem mais toda a telemetria no Hub (purgada, no todo ou em parte) e o bruto de algum upload processado dele já venceu; não dá para reconstruí-lo completo * `IN_PROGRESS` – S6: já há uma solicitação em andamento para o mesmo cliente e dia fileReprocessBlockReason: type: string enum: – NOT_FOUND – NOT_REPROCESSABLE – RAW_EXPIRED – IN_PROGRESS description: Guarda que bloqueou um arquivo no reprocessamento a partir do bruto: * `NOT_FOUND` – O arquivo não existe no upload_process * `NOT_REPROCESSABLE` – O arquivo não está em ERROR: só upload com erro é reprocessado (o PROCESSED sai pelo reenvio do dia) * `RAW_EXPIRED` – O bruto não está mais disponível no BlobService (blobExpiresAt vencido ou sem registro) * `IN_PROGRESS` – S6: já há uma solicitação em andamento para o mesmo cliente e dia sbsSendStatus: type: string enum: – DISPATCHED – SENT – NO_DATA – ERROR description: Status do envio ao SBS de um cliente num dia de referência: * `DISPATCHED` – Despachado, aguardando o resultado do envio * `SENT` – Todos os chunks entregues ao SBS (201, 200 ou 409) * `NO_DATA` – Nada a enviar no dia * `ERROR` – Erro no envio ou no despacho telemetryType: type: string enum: – WEBSERVICE – CLIENT_SERVER – WEB50 – BUSINESS description: Tipo de telemetria: * `WEBSERVICE` – Webservice * `CLIENT_SERVER` – Client-Server * `WEB50` – Web 5.0 * `BUSINESS` – Negócio queryExecutionStatus: type: string enum: – PENDING – PROCESSING – CANCELLED – FINISHED description: Status agregado de uma query execution (persistência): * `PENDING` – Aguardando coleta/execução pelo agente (ainda sem fase reportada) * `PROCESSING` – Em processamento — ao menos uma fase já foi reportada * `CANCELLED` – Cancelada antes do início do processamento * `FINISHED` – Encerrada (sucesso ou falha em alguma fase) queryExecutionPhase: type: string enum: – RECEIPT – EXECUTION – UPLOAD description: Fase de execução de uma query execution: * `RECEIPT` – Acuse de recebimento da execução pelo agente * `EXECUTION` – Execução da query SQL * `UPLOAD` – Upload do arquivo ZIP do resultado ao destino (BlobService ou S3) queryExecutionPhaseStatus: type: string enum: – SUCCESS – FAILED description: Status de uma fase de execução: * `SUCCESS` – Fase concluída com sucesso * `FAILED` – Fase falhou processedBatchStatus: type: string enum: – STAGING – COMMITTED – ORPHAN – FAILED – RESOLVED_BY_SYNC description: Ciclo de vida de um lote multipart do webhook SHBS client.resources.updated: * `STAGING` – Aguardando o recebimento de todas as partes do lote * `COMMITTED` – Lote completo e projetado em blocking_rule/external_policy_link * `ORPHAN` – Lote incompleto após o TTL (partes faltando) * `FAILED` – Lote completo cuja projeção/commit falhou * `RESOLVED_BY_SYNC` – Lote elegível reconciliado via sync GET (discovery); partes atrasadas são no-op restoreExecutionStatus: type: string enum: – PENDING – PROCESSING – SUCCESS – FAILED description: Status de execução da restauração histórica: * `PENDING` – Solicitação criada, aguardando início do processamento assíncrono * `PROCESSING` – Download e agregação de arquivos em andamento * `SUCCESS` – Restauração concluída com sucesso (ZIP gerado) * `FAILED` – Falha irrecuperável durante a restauração restoreHistoricalFileStatus: type: string enum: – INCLUDED – EXPIRED – FAILED description: Status individual de um arquivo no restore histórico: * `INCLUDED` – Arquivo incluído no ZIP agregado * `EXPIRED` – Arquivo fora do TTL do blob * `FAILED` – Falha ao recuperar o arquivo userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error healthcheckDTO: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Saudável * `DOWN` – Ruim environmentDTO: description: DTO que representa informações do ambiente type: object required: – id – customerId – system – systemVersion – agentVersion properties: id: type: string description: ID do ambiente customerId: type: string description: ID do cliente (codcli) system: type: string allOf: – #/definitions/systemType description: Sistema systemVersion: type: string description: Versão do Sistema agentVersion: type: string description: Versão do agente databaseType: type: string allOf: – #/definitions/databaseType description: Tipo do banco de dados do cliente. Nulo: agente anterior à 2.8.0, que não informa databaseVersion: type: string description: Versão do banco de dados do cliente (DatabaseMetaData.getDatabaseProductVersion). Nulo: agente anterior à 2.8.0, que não informa uploadRequestInputDTO: description: DTO de entrada para solicitação de upload type: object properties: dataFormatVersion: type: string allOf: – #/definitions/dataFormatVersion description: Versão do formato de dados a ser enviado uploadRequestResultDTO: description: DTO de resultado para solicitação de upload type: object required: – fileId – uploadUrl – fileName – fileVersion properties: fileId: type: string description: ID único do arquivo no serviço de armazenamento uploadUrl: type: string description: URL pré-assinada para upload do arquivo fileName: type: string description: Nome do arquivo gerado pelo sistema fileVersion: type: string description: Versão do arquivo criado no sistema fileCommitInputDTO: description: DTO de entrada para confirmação de arquivo type: object required: – fileId – fileName – fileVersion properties: fileId: type: string description: ID único do arquivo no serviço de armazenamento fileName: type: string description: Nome do arquivo gerado pelo sistema fileVersion: type: string description: Versão do arquivo criado no sistema webserviceDataLayoutVersion: type: string allOf: – #/definitions/webserviceDataLayoutVersion description: Versão do layout dos campos do CSV (webservice) sbsClientUploadInput: description: DTO de input para processamento SBS de um cliente específico type: object required: – customerId – referenceDate properties: customerId: type: string description: ID do cliente (codcli / valor em string_pool) referenceDate: type: string format: date description: Data de referência ISO_LOCAL_DATE reprocessRequestId: type: string description: Solicitação de reenvio (requestSbsResend) que despachou o envio, para a baixa do item; vazio no envio diário e no disparo avulso activeBlockingRulePatternDTO: description: DTO para padrão ativo de regra de bloqueio type: object required: – id – pattern properties: id: type: string description: ID do padrão pattern: type: string description: Padrão do recurso activeBlockingRuleContextDTO: description: DTO para contexto ativo de regra de bloqueio type: object required: – id – contextType properties: id: type: string description: ID do contexto contextType: type: string allOf: – #/definitions/blockingRuleContextType description: Tipo de contexto partnerId: type: string description: ID do parceiro partnerScope: type: string allOf: – #/definitions/partnerScope description: Escopo do parceiro activeBlockingRuleLimitDTO: description: DTO para limite ativo de regra de bloqueio type: object required: – id – limitType – limitMaxValue – timeInterval – httpError – systemError – errorMessage properties: id: type: string description: ID do limite limitType: type: string allOf: – #/definitions/blockingRuleLimitType description: Tipo de limite limitMaxValue: type: integer format: int64 description: Valor máximo do limite timeInterval: type: string allOf: – #/definitions/timeInterval description: Intervalo de tempo httpError: type: integer format: int64 description: Codigo HTTP do erro systemError: type: integer format: int64 description: Codigo de erro do sistema errorMessage: type: string description: Mensagem de erro activeBlockingRuleDTO: description: DTO para regra de bloqueio ativa type: object required: – id – name – type – startDate properties: id: type: string description: ID da regra name: type: string description: Nome da regra type: type: string allOf: – #/definitions/blockingRuleType description: Tipo da regra startDate: type: string format: YYYY-MM-DDTHH:mm:ss.SSS pattern: ^[0-9]{4}-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])T(1[0-9]|0[1-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])[.][0-9]{3}$ description: Data de início endDate: type: string format: YYYY-MM-DDTHH:mm:ss.SSS pattern: ^[0-9]{4}-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])T(1[0-9]|0[1-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])[.][0-9]{3}$ description: Data de término patterns: type: array items: type: object allOf: – #/definitions/activeBlockingRulePatternDTO description: Padrões de recursos contexts: type: array items: type: object allOf: – #/definitions/activeBlockingRuleContextDTO description: Contextos de recursos limits: type: array items: type: object allOf: – #/definitions/activeBlockingRuleLimitDTO description: Limites de uso inactiveBlockingRuleDTO: description: DTO para regra de bloqueio inativa type: object required: – id – name properties: id: type: string description: ID da regra name: type: string description: Nome da regra wsUploadRequestInputDTO__2: description: DTO de entrada para solicitação de upload de webservice type: object required: – environment – dataFormatVersion properties: environment: type: object allOf: – #/definitions/environmentDTO description: Informações do ambiente dataFormatVersion: type: string allOf: – #/definitions/dataFormatVersion description: Versão do formato de dados a ser enviado wsDataLayoutVersion: type: string allOf: – #/definitions/webserviceDataLayoutVersion description: Versão do layout dos dados de webservice businessDataLayoutVersion: type: string allOf: – #/definitions/businessDataLayoutVersion description: Versão do layout dos dados de negócio csUploadRequestInputDTO__2: description: DTO de entrada para solicitação de upload de client-server type: object required: – environment – dataFormatVersion properties: environment: type: object allOf: – #/definitions/environmentDTO description: Informações do ambiente dataFormatVersion: type: string allOf: – #/definitions/dataFormatVersion description: Versão do formato de dados a ser enviado csDataLayoutVersion: type: string allOf: – #/definitions/clientServerDataLayoutVersion description: Versão do layout dos dados de client-server businessDataLayoutVersion: type: string allOf: – #/definitions/businessDataLayoutVersion description: Versão do layout dos dados de negócio w50UploadRequestInputDTO__2: description: DTO de entrada para solicitação de upload de web 5.0 type: object required: – environment – dataFormatVersion properties: environment: type: object allOf: – #/definitions/environmentDTO description: Informações do ambiente dataFormatVersion: type: string allOf: – #/definitions/dataFormatVersion description: Versão do formato de dados a ser enviado w50DataLayoutVersion: type: string allOf: – #/definitions/web50DataLayoutVersion description: Versão do layout dos dados de web 5.0 businessDataLayoutVersion: type: string allOf: – #/definitions/businessDataLayoutVersion description: Versão do layout dos dados de negócio uploadRequestResultDTO__2: description: DTO de resultado para solicitação de upload (comum a todos os tipos) type: object required: – fileId – uploadUrl properties: fileId: type: string description: ID único do arquivo no serviço de armazenamento uploadUrl: type: string description: URL pré-assinada para upload do arquivo commitFileInputDTO: description: DTO de entrada para confirmação de arquivo (genérico) type: object required: – fileId properties: fileId: type: string description: ID único do arquivo no serviço de armazenamento createReportAnomalyInputDTO: description: DTO de entrada para criação de anomalia reportada type: object required: – environment – reportDate – kind – description – occurrences properties: environment: type: object allOf: – #/definitions/environmentDTO description: Ambiente no qual a anomalia foi detectada reportDate: type: string format: date-time description: Data e hora do registro da anomalia kind: type: string description: Tipo de anomalia description: type: string description: Descrição detalhada da anomalia occurrences: type: integer format: int64 description: Quantidade de ocorrências createReportAnomalyOutputDTO: description: DTO de saída para criação de anomalia reportada type: object required: – id properties: id: type: string description: ID da anomalia criada cancelQueryExecutionInputDTO: description: DTO de entrada para cancelamento de query execution type: object required: – executionId properties: executionId: type: string description: ID da execução a cancelar cancelQueryExecutionOutputDTO: description: DTO de saída do cancelamento de query execution type: object required: – executionId – cancelledAt – cancelledBy properties: executionId: type: string description: ID da execução cancelada cancelledAt: type: string format: date-time description: Data/hora do cancelamento cancelledBy: type: string description: Usuário que solicitou o cancelamento requestRestoreHistoricalDataInputDTO: description: DTO de entrada para solicitação de restauração histórica type: object required: – client properties: client: type: string description: Código do cliente (codcli) startDate: type: string format: date description: Todos os arquivos do período: data inicial (inclusiva); informe com endDate e sem fileIds endDate: type: string format: date description: Todos os arquivos do período: data final (inclusiva) fileIds: type: array items: type: string description: Arquivos escolhidos (fileId), de 1 a 100, do cliente; informe sem startDate e endDate requestRestoreHistoricalDataOutputDTO: description: DTO de saída da solicitação de restauração histórica type: object required: – executionId – status properties: executionId: type: string description: Identificador único da execução de restauração (UUID) status: type: string allOf: – #/definitions/restoreExecutionStatus description: Status inicial da execução getRestoreExecutionInputDTO: description: DTO de entrada para consulta de status da execução de restauração type: object required: – executionId properties: executionId: type: string description: Identificador da execução de restauração (UUID) restoreHistoricalFileStatusDTO: description: Status de um arquivo considerado no restore type: object required: – fileId – status properties: fileId: type: string description: Identificador do arquivo no BlobService fileName: type: string description: Nome original do arquivo telemetryType: type: string allOf: – #/definitions/telemetryType description: Tipo de telemetria createdAt: type: string format: date-time description: Data de criação do upload status: type: string allOf: – #/definitions/restoreHistoricalFileStatus description: Resultado da inclusão errorMessage: type: string description: Mensagem quando status = FAILED ou EXPIRED restoreHistoricalSummaryDTO: description: Resumo quantitativo do restore type: object required: – totalFound – totalIncluded – totalFailed – totalExpired properties: totalFound: type: integer format: int64 description: Quantidade de arquivos encontrados no período totalIncluded: type: integer format: int64 description: Quantidade incluída no ZIP totalFailed: type: integer format: int64 description: Quantidade com falha real de recuperação totalExpired: type: integer format: int64 description: Quantidade fora do TTL do blob getRestoreExecutionOutputDTO: description: DTO de saída da consulta de execução de restauração type: object required: – executionId – client – startDate – endDate – status – createdAt properties: executionId: type: string description: Identificador da execução client: type: string description: Cliente solicitante startDate: type: string format: date description: Data inicial do período endDate: type: string format: date description: Data final do período status: type: string allOf: – #/definitions/restoreExecutionStatus description: Status atual da execução downloadUrl: type: string description: URL pré-assinada para download do ZIP agregado targetObjectId: type: string description: Identificador do ZIP no BlobService expiresAt: type: string format: date-time description: Expiração da URL de download summary: type: object allOf: – #/definitions/restoreHistoricalSummaryDTO description: Totais do restore errorMessage: type: string description: Mensagem de erro caso status seja FAILED createdAt: type: string format: date-time description: Data de criação da solicitação finishedAt: type: string format: date-time description: Data de conclusão da solicitação processRestoreExecutionInputDTO: description: DTO de entrada para processamento assíncrono da restauração type: object required: – executionId properties: executionId: type: string description: Identificador da execução a ser processada listQueryExecutionsInputDTO: description: DTO de entrada para listagem de query executions type: object properties: executionId: type: string description: Filtrar por execução específica customerId: type: string description: Filtrar por cliente environmentId: type: string description: Filtrar por ambiente createdFrom: type: string format: date-time description: Início do período de solicitação createdTo: type: string format: date-time description: Fim do período de solicitação createdBy: type: string description: Filtrar por autor da solicitação updatedFrom: type: string format: date-time description: Início do período de atualização updatedTo: type: string format: date-time description: Fim do período de atualização sqlCommand: type: string description: Filtrar por trecho do comando SQL (busca parcial, case-insensitive) status: type: string allOf: – #/definitions/queryExecutionStatus description: Filtrar por status agregado da execução (PENDING, PROCESSING ou FINISHED) phase: type: string allOf: – #/definitions/queryExecutionPhase description: Filtrar por fase (RECEIPT, EXECUTION ou UPLOAD) phaseStatus: type: string allOf: – #/definitions/queryExecutionPhaseStatus description: Filtrar por status da fase (SUCCESS ou FAILED) pageNumber: type: integer format: int64 description: Número da página (base 0); padrão 0 pageSize: type: integer format: int64 description: Tamanho da página; padrão 20 listQueryExecutionCreatedByValuesInputDTO: description: DTO de entrada da listagem de autores distintos (sem filtros) type: object listQueryExecutionCreatedByValuesOutputDTO: description: DTO de saída com createdBy distintos type: object properties: createdByValues: type: array items: type: string description: Autores distintos presentes em query executions não canceladas, ordenados listEnvironmentsByCustomerInputDTO: description: DTO de entrada da listagem de ambientes por cliente/produto type: object required: – customerId properties: customerId: type: string description: Código do cliente (codcli); obrigatório productName: type: string description: Filtro opcional pelo nome do produto (product_config.product_name, ex.: HCM_XT) listEnvironmentsByCustomerOutputDTO: description: DTO de saída da listagem de ambientes por cliente/produto type: object properties: items: type: array items: type: object allOf: – #/definitions/customerProductEnvironmentsDTO description: Grupos cliente x produto com seus ambientes; vazio se o cliente não tiver ambiente no catálogo customerProductEnvironmentsDTO: description: Grupo de ambientes de um cliente para um produto type: object required: – customerId – productName – environments properties: customerId: type: string description: Código do cliente productName: type: string description: Nome do produto (product_config.product_name) environments: type: array items: type: object allOf: – #/definitions/customerEnvironmentItemDTO minimum: 1 description: Ambientes do par cliente/produto (sempre lista): ACTIVE primeiro e depois SILENT, cada grupo do contato mais recente para o mais antigo customerEnvironmentItemDTO: description: Ambiente do cliente type: object required: – environmentId – situation – lastContactAt properties: environmentId: type: string description: Identificador do ambiente (dbId), como o agente envia situation: type: string allOf: – #/definitions/environmentSituation description: Situação pelo contato do agente: ACTIVE (contato dentro do limite de silêncio) ou SILENT (sem contato e sem substituto); REPLACED nunca vem lastContactAt: type: string format: date-time description: Último contato do agente desse ambiente com o Hub (UTC) lastTelemetryAt: type: string format: date-time description: Último arquivo de telemetria processado do ambiente (upload_process) (UTC); nulo sem arquivo processado na retenção databaseType: type: string allOf: – #/definitions/databaseType description: Tipo do banco do ambiente; nulo para agente anterior à 2.8.0 databaseVersion: type: string description: Versão do banco, numa linha só e com até 100 caracteres; nula como o tipo uploadProcessItemDTO: description: Um upload na lista do monitoramento type: object required: – id – fileId – telemetryType – status – createdAt – rawAvailable properties: id: type: integer format: int64 description: ID do upload fileId: type: string description: Identificador do arquivo no BlobService customerId: type: string description: Código do cliente (codcli) environment: type: string description: Ambiente que enviou o arquivo system: type: string description: Sistema que enviou o arquivo telemetryType: type: string allOf: – #/definitions/telemetryType description: Tipo de telemetria status: type: string allOf: – #/definitions/uploadMonitoringStatus description: Status no monitoramento createdAt: type: string format: date-time description: Pedido do upload persistedAt: type: string format: date-time description: Gravação das linhas (início da transação); só nos processados errorMessage: type: string description: Motivo do erro: mensagens da exceção e das causas agentVersion: type: string description: Versão do agente que enviou o arquivo systemVersion: type: string description: Versão do sistema que enviou o arquivo rowsTotal: type: integer format: int64 description: Linhas lidas do arquivo principal rowsInserted: type: integer format: int64 description: Linhas inseridas na telemetria (a diferença para as lidas são duplicatas) blobExpiresAt: type: string format: date-time description: Vencimento do arquivo bruto no BlobService rawAvailable: type: boolean description: O arquivo bruto ainda está disponível para reprocessar ou baixar sbsPendingDayDTO: description: Um dia (UTC) de um cliente na aba Envios SBS: pendente (dado processado e sem envio aceito pelo SBS) ou concluído (envio SENT ou NO_DATA) type: object required: – customerId – day properties: customerId: type: string description: Código do cliente (codcli) day: type: string format: date description: Dia de referência do envio classification: type: string allOf: – #/definitions/sbsPendingClassification description: Classificação da pendência; vazia nos concluídos sbsStatus: type: string allOf: – #/definitions/sbsSendStatus description: Status do envio do dia ao SBS. Vazio sem registro de despacho sbsAttempts: type: integer format: int64 description: Tentativas de envio do dia ao SBS sbsFirstAcceptedAt: type: string format: date-time description: Primeira tentativa com algum chunk aceito pelo SBS sbsLastAttemptAt: type: string format: date-time description: Última tentativa de envio ao SBS sbsLastError: type: string description: Último erro do envio ao SBS resendDeadline: type: string format: date-time description: Último instante em que o reenvio do dia passa pela guarda da janela de deduplicação: primeiro aceite (ou, sem registro de despacho, o dia seguinte ao de referência) mais sbs.upload.dedupwindowdays menos sbs.upload.dedupsafetymargindays. Vazio quando nenhum chunk foi aceito, porque aí o reenvio é o primeiro envio sbsPendingCountDTO: description: Total de dias pendentes de uma classificação type: object required: – classification – total properties: classification: type: string allOf: – #/definitions/sbsPendingClassification description: Classificação total: type: integer format: int64 description: Pares (cliente, dia) pendentes com a classificação agentEnvironmentDTO: description: Um ambiente do catálogo de contato dos agentes type: object required: – customerId – environment – system – situation – firstSeenAt – lastSeenAt – uploads properties: customerId: type: string description: Código do cliente (codcli) environment: type: string description: Ambiente system: type: string description: Sistema situation: type: string allOf: – #/definitions/environmentSituation description: Situação do ambiente agentVersion: type: string description: Versão do agente no último contato systemVersion: type: string description: Versão do sistema no último contato databaseType: type: string allOf: – #/definitions/databaseType description: Tipo do banco no último contato; vazio para agente anterior à 2.8.0 databaseVersion: type: string description: Versão do banco no último contato; vazio para agente anterior à 2.8.0 firstSeenAt: type: string format: date-time description: Primeiro contato do agente lastSeenAt: type: string format: date-time description: Último contato do agente uploads: type: array items: type: object allOf: – #/definitions/agentUploadDTO minimum: 1 description: Último upload por tipo de telemetria, dentro da retenção do upload_process status: type: object allOf: – #/definitions/agentStatusDTO description: Último estado reportado pelo agente (reportAgentStatus); vazio para agente anterior à 2.8.0 agentStatusDTO: description: Último estado reportado pelo agente de um ambiente type: object required: – pendingRows – failedRows – inProcessRows – maintenanceMode – withoutCryptographyKey – startedAt – reportedAt – problems properties: pendingRows: type: integer format: int64 description: Linhas pendentes de envio na R904URS failedRows: type: integer format: int64 description: Linhas descartadas na R904URS, por falha de decrypt ou parse inProcessRows: type: integer format: int64 description: Linhas presas em envio na R904URS lastSuccessfulUploadAt: type: string format: date-time description: Último upload de telemetria concluído pelo agente; vazio se ainda não houve desde a 2.8.0 maintenanceMode: type: boolean description: Base em manutenção withoutCryptographyKey: type: boolean description: Agente sem a chave de criptografia da instalação (modo degradado) startedAt: type: string format: date-time description: Início do processo do agente reportedAt: type: string format: date-time description: Quando o Hub registrou o estado problems: type: array items: type: string allOf: – #/definitions/agentProblem minimum: 1 description: Problemas do estado; vazio sem problema e para ambiente substituído uploadProcessStatusItemDTO: description: Status de um upload pedido pelo agente type: object required: – fileId properties: fileId: type: string description: ID do arquivo status: type: string allOf: – #/definitions/uploadProcessStatus description: Status do upload; vazio se ele não existe para o cliente (nunca pedido ou já apagado pela retenção) agentUploadDTO: description: Último upload de um tipo de telemetria de um ambiente type: object required: – telemetryType – lastReceivedAt properties: telemetryType: type: string allOf: – #/definitions/telemetryType description: Tipo de telemetria lastReceivedAt: type: string format: date-time description: Último upload recebido, em qualquer status lastProcessedAt: type: string format: date-time description: Gravação do último upload processado; vazio se nenhum foi processado agentVersionCountDTO: description: Ambientes de uma versão do agente, por situação type: object required: – active – silent – replaced properties: agentVersion: type: string description: Versão do agente; vazia para ambiente sem a versão informada active: type: integer format: int64 description: Ambientes ativos silent: type: integer format: int64 description: Ambientes silenciosos replaced: type: integer format: int64 description: Ambientes substituídos reportAnomalyItemDTO: description: Uma anomalia reportada por um agente type: object required: – id – customerId – environment – system – systemVersion – agentVersion – reportDate – kind – description – occurrences properties: id: type: string description: ID da anomalia customerId: type: string description: Código do cliente (codcli) environment: type: string description: Ambiente system: type: string description: Sistema systemVersion: type: string description: Versão do sistema no reporte agentVersion: type: string description: Versão do agente no reporte reportDate: type: string format: date-time description: Data e hora do registro da anomalia kind: type: string description: Tipo da anomalia description: type: string description: Descrição da anomalia occurrences: type: integer format: int64 description: Quantidade de ocorrências dismissedAt: type: string format: date-time description: Descarte como falso positivo; vazio se a anomalia está ativa dismissedBy: type: string description: Usuário que descartou a anomalia dismissReason: type: string description: Motivo do descarte reportAnomalyDailyDTO: description: Anomalias de um tipo num dia type: object required: – day – kind – anomalies – occurrences properties: day: type: string format: date description: Dia do registro, no fuso timeZone da consulta kind: type: string description: Tipo da anomalia anomalies: type: integer format: int64 description: Anomalias registradas occurrences: type: integer format: int64 description: Soma das ocorrências sbsResendItemDTO: description: Um par (cliente, dia) considerado num reenvio ao SBS type: object required: – customerId – day – accepted properties: customerId: type: string description: Código do cliente (codcli) day: type: string format: date description: Dia de referência accepted: type: boolean description: Aceito e despachado blockReason: type: string allOf: – #/definitions/sbsResendBlockReason description: Guarda que bloqueou o par detail: type: string description: Detalhe do bloqueio fileReprocessItemDTO: description: Um arquivo considerado num reprocessamento a partir do bruto type: object required: – fileId – accepted properties: fileId: type: string description: Arquivo no BlobService customerId: type: string description: Código do cliente (codcli); nulo no upload legado (v0) ou com o arquivo não encontrado day: type: string format: date description: Dia do dado (UTC): o do persistedAt original, ou o do createdAt em ERROR status: type: string allOf: – #/definitions/uploadProcessStatus description: Situação do arquivo antes do reprocessamento accepted: type: boolean description: Aceito e despachado blockReason: type: string allOf: – #/definitions/fileReprocessBlockReason description: Guarda que bloqueou o arquivo detail: type: string description: Detalhe do bloqueio restoreExecutionItemDTO: description: Uma restauração de arquivos brutos na lista do monitoramento type: object required: – executionId – customerId – startDate – endDate – status – downloadAvailable – createdAt properties: executionId: type: string description: Identificador da execução (UUID) customerId: type: string description: Código do cliente (codcli) startDate: type: string format: date description: Primeiro dia restaurado endDate: type: string format: date description: Último dia restaurado, inclusive status: type: string allOf: – #/definitions/restoreExecutionStatus description: Situação da restauração totalFound: type: integer format: int64 description: Arquivos encontrados no período totalIncluded: type: integer format: int64 description: Arquivos incluídos no ZIP totalFailed: type: integer format: int64 description: Arquivos com falha de recuperação totalExpired: type: integer format: int64 description: Arquivos fora do TTL do blob downloadAvailable: type: boolean description: O ZIP ainda pode ser baixado (pela getRestoreExecution) urlExpiresAt: type: string format: date-time description: Vencimento do link do ZIP errorMessage: type: string description: Erro, quando a restauração falhou requestedBy: type: string description: Usuário que pediu, quando registrado createdAt: type: string format: date-time description: Pedido da restauração finishedAt: type: string format: date-time description: Conclusão da restauração reprocessRequestDTO: description: Uma solicitação de reenvio ao SBS ou de reprocessamento type: object required: – id – kind – reason – filters – requestedBy – requestedAt – status – accepted – blocked – completed – failed – updatedAt properties: id: type: string description: Identificador da solicitação (UUID) kind: type: string allOf: – #/definitions/reprocessRequestKind description: Tipo da solicitação reason: type: string allOf: – #/definitions/reprocessReason description: Categoria do motivo reasonText: type: string description: Texto do motivo filters: type: string description: Entrada da action, em JSON requestedBy: type: string description: Usuário que pediu requestedAt: type: string format: date-time description: Pedido da solicitação status: type: string allOf: – #/definitions/reprocessRequestStatus description: Situação da solicitação accepted: type: integer format: int64 description: Itens aceitos pelas guardas blocked: type: integer format: int64 description: Itens bloqueados pelas guardas completed: type: integer format: int64 description: Itens aceitos concluídos failed: type: integer format: int64 description: Itens aceitos terminados com falha updatedAt: type: string format: date-time description: Última atualização reprocessRequestItemDTO: description: Um item de uma solicitação: par (cliente, dia) no reenvio ou arquivo no reprocessamento type: object required: – status – updatedAt properties: customerId: type: string description: Código do cliente (codcli); nulo no reprocessamento de um arquivo não encontrado ou de upload legado (v0) referenceDate: type: string format: date description: Dia de referência, no reenvio fileId: type: string description: Arquivo no BlobService, no reprocessamento status: type: string allOf: – #/definitions/reprocessItemStatus description: Situação do item blockReason: type: string description: Guarda que bloqueou o item detail: type: string description: Detalhe do bloqueio ou da falha updatedAt: type: string format: date-time description: Última atualização customerUploadCountsDTO: description: Arquivos de um tipo de telemetria recebidos no dia type: object required: – telemetryType – filesReceived – filesProcessed – filesError – filesInProgress – filesOrphan properties: telemetryType: type: string allOf: – #/definitions/telemetryType description: Tipo de telemetria filesReceived: type: integer format: int64 description: Arquivos recebidos no dia, em qualquer status filesProcessed: type: integer format: int64 description: Arquivos recebidos no dia e processados filesError: type: integer format: int64 description: Arquivos recebidos no dia com erro no processamento filesInProgress: type: integer format: int64 description: Arquivos aguardando processamento há até 24 h filesOrphan: type: integer format: int64 description: Arquivos órfãos: aguardando processamento há mais de 24 h customerTelemetryDayDTO: description: Um dia da linha do tempo de um cliente. Os uploads e os brutos contam pelo dia em que chegaram (created_at, no fuso timeZone); o envio, a telemetria e a pendência, pelo dia de referência do envio (UTC) type: object required: – day – uploads – dataInHub – rawFilesAvailable – rawFilesExpired – pending properties: day: type: string format: date description: Dia: o de chegada no fuso timeZone para os arquivos e o de referência (UTC) para o envio ao SBS uploads: type: array items: type: object allOf: – #/definitions/customerUploadCountsDTO minimum: 1 description: Arquivos recebidos no dia, um item por tipo de telemetria com arquivo sbsStatus: type: string allOf: – #/definitions/sbsSendStatus description: Status do envio do dia ao SBS. Vazio se o dia não foi despachado sbsAttempts: type: integer format: int64 description: Tentativas de envio do dia ao SBS sbsFirstAcceptedAt: type: string format: date-time description: Primeira tentativa com algum chunk aceito pelo SBS sbsLastAttemptAt: type: string format: date-time description: Última tentativa de envio ao SBS sbsLastError: type: string description: Último erro do envio ao SBS dataInHub: type: boolean description: Ainda há telemetria do cliente no dia de referência, na base do Hub rawFilesAvailable: type: integer format: int64 description: Arquivos do dia com o bruto ainda disponível no BlobService rawFilesExpired: type: integer format: int64 description: Arquivos do dia com o bruto vencido ou sem registro no BlobService pending: type: boolean description: Dado processado no dia de referência, sem envio aceito e ainda na base. Falso no dia de hoje, cujo envio roda no dia seguinte telemetryDailyOverviewDTO: description: Visão geral de um dia. Os arquivos contam pelo dia em que chegaram (created_at, no fuso timeZone); os clientes e o envio ao SBS, pelo dia de referência do envio (UTC) type: object required: – day – filesReceived – filesProcessed – filesError – filesInProgress – filesOrphan – customersWithData – customersDispatched – customersSent – customersNoData – customersError – customersPending properties: day: type: string format: date description: Dia: o de chegada no fuso timeZone para os arquivos e o de referência (UTC) para o envio ao SBS filesReceived: type: integer format: int64 description: Arquivos recebidos no dia, em qualquer status filesProcessed: type: integer format: int64 description: Arquivos recebidos no dia e processados filesError: type: integer format: int64 description: Arquivos recebidos no dia com erro no processamento filesInProgress: type: integer format: int64 description: Arquivos aguardando processamento há até 24 h filesOrphan: type: integer format: int64 description: Arquivos órfãos: aguardando processamento há mais de 24 h customersWithData: type: integer format: int64 description: Clientes com arquivo processado no dia de referência customersDispatched: type: integer format: int64 description: Clientes despachados ao SBS para o dia, em qualquer status de envio customersSent: type: integer format: int64 description: Clientes com o dia enviado ao SBS (SENT) customersNoData: type: integer format: int64 description: Clientes sem dado a enviar no dia (NO_DATA) customersError: type: integer format: int64 description: Clientes com erro no envio do dia (ERROR) customersPending: type: integer format: int64 description: Clientes com dado processado no dia, sem envio aceito e ainda com telemetria na base. Zero no dia de hoje, cujo envio roda no dia seguinte listQueryExecutionsOutputDTO: description: DTO de saída da listagem de query executions type: object required: – total properties: items: type: array items: type: object allOf: – #/definitions/queryExecutionItemDTO description: Itens da página solicitada total: type: integer format: int64 description: Total de registros (sem paginação) queryExecutionBlobServiceSummaryDTO: description: Resumo do BlobService de destino (presente quando a execução usa BlobService) type: object required: – id – name properties: id: type: string description: ID do serviço de armazenamento name: type: string description: Nome do serviço de armazenamento description: type: string description: Descrição do serviço de armazenamento queryExecutionItemDTO: description: Item da listagem de query executions type: object required: – executionId – name – customerId – environmentId – createdDate – createdBy – status properties: executionId: type: string description: Identificador da execução name: type: string description: Nome da extração description: type: string description: Descrição opcional da extração sqlCommand: type: string description: Comando SQL de extração blobService: type: object allOf: – #/definitions/queryExecutionBlobServiceSummaryDTO description: Serviço de armazenamento de destino (quando aplicável) s3PresignedUploadUrl: type: string description: URL pré-assinada S3 de destino (quando aplicável) customerId: type: string description: Cliente environmentId: type: string description: Ambiente createdDate: type: string format: date-time description: Data/hora da solicitação lastModifiedDate: type: string format: date-time description: Data/hora da última atualização createdBy: type: string description: Usuário que solicitou a extração status: type: string allOf: – #/definitions/queryExecutionStatus description: Status agregado da execução (PENDING, PROCESSING ou FINISHED — canceladas não aparecem na listagem) resultReference: type: object allOf: – #/definitions/queryExecutionResultReferenceDTO description: Referência ao resultado (somente quando upload.status = SUCCESS) phases: type: object allOf: – #/definitions/queryExecutionPhasesDTO description: Fases reportadas (omitido se nenhuma fase foi reportada) queryExecutionPhasesDTO: description: Fases de uma query execution (apenas as já reportadas aparecem no JSON) type: object properties: receipt: type: object allOf: – #/definitions/queryExecutionPhaseResultDTO description: Status da fase RECEIPT execution: type: object allOf: – #/definitions/queryExecutionPhaseResultDTO description: Status da fase EXECUTION upload: type: object allOf: – #/definitions/queryExecutionPhaseResultDTO description: Status da fase UPLOAD queryExecutionPhaseResultDTO: description: Resultado consolidado de uma fase de execução type: object properties: status: type: string allOf: – #/definitions/queryExecutionPhaseStatus description: Status da fase (null se ainda não concluída) startedAt: type: string format: date-time description: Início da fase finishedAt: type: string format: date-time description: Término da fase durationSeconds: type: integer format: int64 description: Duração da fase em segundos (derivada de startedAt/finishedAt) errorMessage: type: string description: Mensagem de erro quando status = FAILED rowCount: type: integer format: int64 description: Quantidade de linhas (quando aplicável, em EXECUTION) queryExecutionResultReferenceDTO: description: Referência uniforme ao arquivo de resultado (BlobService ou S3) type: object required: – fileName – objectKey properties: fileName: type: string description: Nome do arquivo de resultado (último segmento do objectKey) objectKey: type: string description: BlobService: targetObjectId/fileReference; S3: chave do objeto no bucket requestQueryExecutionResultUrlInputDTO: description: DTO de entrada para solicitar URL de download do resultado type: object required: – executionId properties: executionId: type: string description: ID da execução concluída com upload.status = SUCCESS requestQueryExecutionResultUrlOutputDTO: description: DTO de saída com URL de download temporária type: object required: – downloadUrl – fileName properties: downloadUrl: type: string description: URL temporária para download do arquivo de resultado (ZIP) fileName: type: string description: Nome do arquivo de resultado expiresAt: type: string format: date-time description: Data/hora de expiração da URL getPendingQueryExecutionsInputDTO: description: DTO de entrada para polling de execuções pendentes (agente) type: object required: – environment properties: environment: type: object allOf: – #/definitions/environmentDTO description: Ambiente de execução do agente pendingQueryExecutionDTO: description: DTO de uma execução pendente para o agente type: object required: – executionId – sqlCommand properties: executionId: type: string description: ID da execução (gerado pelo backend na criação) name: type: string description: Nome da extração sqlCommand: type: string description: Comando SQL a ser executado blobServiceId: type: string description: ID do BlobService (presente quando destino é BlobService) s3PresignedUploadUrl: type: string description: URL pré-assinada S3 (presente quando destino é S3) getPendingQueryExecutionsOutputDTO: description: DTO de saída do polling de execuções pendentes type: object properties: executions: type: array items: type: object allOf: – #/definitions/pendingQueryExecutionDTO description: Execuções PENDING do ambiente (podem repetir em polls seguintes até a 1ª fase ser reportada) reportQueryExecutionPhaseInputDTO: description: DTO de entrada para reporte de fase de query execution type: object required: – executionId – phase – status – startedAt – finishedAt properties: executionId: type: string description: ID da execução phase: type: string allOf: – #/definitions/queryExecutionPhase description: Fase de execução status: type: string allOf: – #/definitions/queryExecutionPhaseStatus description: Status da fase startedAt: type: string format: date-time description: Data/hora de início da fase finishedAt: type: string format: date-time description: Data/hora de término da fase (obrigatório — modelo completion-only) rowCount: type: integer format: int64 description: Quantidade de linhas processadas (obrigatório em EXECUTION/SUCCESS) fileReference: type: string description: Referência ao arquivo gerado no BlobService (targetObjectId) uploadVersion: type: string description: Versão do upload BlobService para confirmar via commitFile resultObjectKey: type: string description: Chave do objeto no bucket S3 (obrigatório em UPLOAD/SUCCESS via S3) errorMessage: type: string description: Mensagem de erro em caso de falha requestQueryExecutionUploadUrlInputDTO: description: DTO de entrada para solicitar URL de upload BlobService type: object required: – executionId properties: executionId: type: string description: ID da execução em PROCESSING requestQueryExecutionUploadUrlOutputDTO: description: DTO de saída com URL pré-assinada de upload BlobService type: object required: – targetObjectId – fileName – uploadUrl – version properties: targetObjectId: type: string description: Caminho do objeto no blob storage fileName: type: string description: Nome do arquivo uploadUrl: type: string description: URL pré-assinada para upload type: string description: Versão do arquivo para uso no commitFile expiresAt: type: string format: date-time description: Data/hora de expiração da URL shbsClientResourcesEnvelopeDTO: description: Envelope do webhook SHBS client.resources.updated — usado como in da action shbsClientResourcesUpdated type: object required: – id – event – timestamp – data properties: id: type: string description: ID do evento do webhook (idempotência) event: type: string description: Nome do evento — sempre client.resources.updated nesta action timestamp: type: string format: date-time description: Data/hora do evento data: type: object allOf: – #/definitions/shbsClientResourcesDataDTO description: Dados do lote de recursos atualizados shbsClientResourcesUpdatedAckDTO: description: ACK mínimo de shbsClientResourcesUpdated — não ecoa o envelope de entrada type: object required: – accepted properties: accepted: type: boolean description: Se a mensagem foi aceita para processamento message: type: string description: Mensagem opcional (ex.: motivo de no-op em retry de id/batch já processado) shbsWebhookAckDTO: description: ACK mínimo das actions de webhook SHBS — não ecoa o envelope de entrada type: object required: – accepted properties: accepted: type: boolean description: Se a mensagem foi aceita para processamento message: type: string description: Mensagem opcional (ex.: motivo de no-op em retry de id já processado) shbsClientThrottledEnvelopeDTO: description: Envelope do webhook SHBS client.throttled type: object required: – id – event – timestamp – data properties: id: type: string description: ID do evento do webhook (idempotência) event: type: string description: Nome do evento — sempre client.throttled nesta action timestamp: type: string format: date-time description: Data/hora do evento data: type: object allOf: – #/definitions/shbsClientThrottledDataDTO description: Dados do throttling do cliente shbsClientThrottledDataDTO: description: Dados do webhook SHBS client.throttled type: object required: – clientId – seniorId – maxRequests – granularity properties: clientId: type: string description: GUID do cliente no SHBS — não usar como customerId/codcli clientName: type: string description: Nome do cliente no SHBS (auditoria) seniorId: type: integer format: int64 description: Código do cliente na Senior X (codcli/customerId) maxRequests: type: integer format: int64 description: Valor máximo do limite de execuções granularity: type: string description: Granularidade do limite (second, minute, hour, day, week, month) shbsClientUnthrottledEnvelopeDTO: description: Envelope do webhook SHBS client.unthrottled type: object required: – id – event – timestamp – data properties: id: type: string description: ID do evento do webhook (idempotência) event: type: string description: Nome do evento — sempre client.unthrottled nesta action timestamp: type: string format: date-time description: Data/hora do evento data: type: object allOf: – #/definitions/shbsClientUnthrottledDataDTO description: Dados da desativação do throttling do cliente shbsClientUnthrottledDataDTO: description: Dados do webhook SHBS client.unthrottled type: object required: – clientId – seniorId properties: clientId: type: string description: GUID do cliente no SHBS — não usar como customerId/codcli clientName: type: string description: Nome do cliente no SHBS (auditoria) seniorId: type: integer format: int64 description: Código do cliente na Senior X (codcli/customerId) syncShbsClientResourcesProcessedItemDTO: description: Item de sincronização bem-sucedida de um par cliente×produto SHBS type: object required: – seniorId – productId – blockingRuleId properties: seniorId: type: integer format: int64 description: Código do cliente productId: type: string description: Produto SHBS blockingRuleId: type: string description: Id da blocking_rule após o rebuild syncShbsClientResourcesFailedItemDTO: description: Item de falha de sincronização de um par cliente×produto SHBS type: object required: – seniorId – productId – reason properties: seniorId: type: integer format: int64 description: Código do cliente productId: type: string description: Produto SHBS reason: type: string description: Motivo resumido da falha (ex.: GET timeout, productId inválido) shbsClientResourcesDataDTO: description: Dados do lote de recursos atualizados de um cliente SHBS type: object required: – batchId – clientId – seniorId – productId – part – totalParts properties: batchId: type: string description: ID do lote (agregação de envelopes multipart) clientId: type: string description: GUID do cliente no SHBS — não usar como customerId/codcli seniorId: type: integer format: int64 description: Código do cliente na Senior X (codcli/customerId) productId: type: string description: ID do produto (HCM_XT, ERP_XT ou GRS_XT) part: type: integer format: int64 description: Parte atual do envelope multipart totalParts: type: integer format: int64 description: Total de partes do envelope multipart resources: type: array items: type: object allOf: – #/definitions/shbsClientResourceItemDTO description: Recursos atualizados neste lote shbsClientResourceItemDTO: description: Recurso do cliente com seu novo status type: object required: – path – status properties: path: type: string description: Path do recurso (ex.: /api/v1/nfe/{chave}) status: type: string description: Novo status do recurso (ex.: enabled, disabled) blockingRule: description: Regra de bloqueio para recursos type: object required: – name – ruleType – startDate – active properties: id: type: string format: uuid description: ID da regra name: type: string description: Nome da regra description: type: string description: Descrição da regra ruleType: type: string allOf: – #/definitions/blockingRuleType description: Tipo da regra origin: type: string allOf: – #/definitions/blockingRuleOrigin description: Origem da regra startDate: type: string format: YYYY-MM-DDTHH:mm:ss.SSS pattern: ^[0-9]{4}-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])T(1[0-9]|0[1-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])[.][0-9]{3}$ description: Data de início endDate: type: string format: YYYY-MM-DDTHH:mm:ss.SSS pattern: ^[0-9]{4}-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])T(1[0-9]|0[1-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])[.][0-9]{3}$ description: Data de término active: type: boolean description: Ativo patterns: type: array items: type: object allOf: – #/definitions/blockingRulePattern description: Padrões de recursos associados à regra contexts: type: array items: type: object allOf: – #/definitions/blockingRuleContext description: Contextos de recursos associados à regra limits: type: array items: type: object allOf: – #/definitions/blockingRuleLimit description: Limites de uso associados à regra customers: type: array items: type: object allOf: – #/definitions/blockingRuleCustomer description: Clientes associados à regra environments: type: array items: type: object allOf: – #/definitions/blockingRuleEnvironment description: Ambientes associados à regra createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editBlockingRule: type: object required: – id allOf: – #/definitions/blockingRule blockingRulePattern: description: Padrão de recurso para regra de bloqueio type: object required: – pattern – active properties: id: type: string format: uuid description: ID do padrão pattern: type: string description: Padrão do recurso active: type: boolean description: Ativo blockingRule: type: object allOf: – #/definitions/blockingRule description: Regra de bloqueio associada createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editBlockingRulePattern: type: object required: – id allOf: – #/definitions/blockingRulePattern blockingRuleContext: description: Contexto de recurso para regra de bloqueio type: object required: – contextType – active properties: id: type: string format: uuid description: ID do contexto contextType: type: string allOf: – #/definitions/blockingRuleContextType description: Tipo de contexto partnerId: type: string description: ID do parceiro partnerScope: type: string allOf: – #/definitions/partnerScope description: Escopo do parceiro active: type: boolean description: Ativo blockingRule: type: object allOf: – #/definitions/blockingRule description: Regra de bloqueio associada createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editBlockingRuleContext: type: object required: – id allOf: – #/definitions/blockingRuleContext blockingRuleLimit: description: Limite de uso para regra de bloqueio type: object required: – limitType – limitMaxValue – timeInterval – active properties: id: type: string format: uuid description: ID do limite limitType: type: string allOf: – #/definitions/blockingRuleLimitType description: Tipo de limite limitMaxValue: type: integer format: int64 description: Valor máximo do limite timeInterval: type: string allOf: – #/definitions/timeInterval description: Intervalo de tempo httpError: type: integer format: int64 description: Codigo HTTP do erro systemError: type: integer format: int64 description: Codigo de erro do sistema errorMessage: type: string description: Mensagem de erro active: type: boolean description: Ativo blockingRule: type: object allOf: – #/definitions/blockingRule description: Regra de bloqueio associada createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editBlockingRuleLimit: type: object required: – id allOf: – #/definitions/blockingRuleLimit blockingRuleCustomer: description: Associação entre cliente e regra de bloqueio type: object required: – customerId – active properties: id: type: string format: uuid description: ID da associação customerId: type: string description: ID do cliente (codcli) active: type: boolean description: Ativo blockingRule: type: object allOf: – #/definitions/blockingRule description: Regra de bloqueio associada createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editBlockingRuleCustomer: type: object required: – id allOf: – #/definitions/blockingRuleCustomer blockingRuleEnvironment: description: Associação entre ambiente e regra de bloqueio type: object required: – environmentId – active properties: id: type: string format: uuid description: ID da associação environmentId: type: string description: ID do ambiente active: type: boolean description: Ativo blockingRule: type: object allOf: – #/definitions/blockingRule description: Regra de bloqueio associada createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editBlockingRuleEnvironment: type: object required: – id allOf: – #/definitions/blockingRuleEnvironment stringPool: description: Pool de strings – deduplicação type: object required: – value properties: id: type: integer format: int64 description: ID do pool value: type: string description: Valor da string telemetry: description: Registro base de telemetria type: object required: – client – startTime – externalId – telemetryType properties: id: type: integer format: int64 description: ID do registro de telemetria client: type: object allOf: – #/definitions/stringPool description: Cliente associado (referência ao string pool) environment: type: object allOf: – #/definitions/stringPool description: Ambiente associado (referência ao string pool) startTime: type: string format: date-time description: Tempo de início finishTime: type: string format: date-time description: Tempo de finalização externalId: type: integer format: int64 description: ID externo telemetryType: type: string allOf: – #/definitions/telemetryType description: Tipo de telemetria host: type: object allOf: – #/definitions/stringPool description: Host associado (referência ao string pool) pid: type: integer format: int64 description: Identificador do processo (PID) module: type: object allOf: – #/definitions/stringPool description: Modulo associado (referência ao string pool) memory: type: integer format: int64 description: Memória (KB) cpuTime: type: integer format: int64 description: Tempo CPU (ms) cpuTimeLsp: type: integer format: int64 description: Tempo CPU processamento LSP (ms) telemetryWebservice: type: object allOf: – #/definitions/telemetryWebservice description: Detalhes de telemetria de webservice telemetryWeb50: type: object allOf: – #/definitions/telemetryWeb50 description: Detalhes de telemetria de web 5.0 telemetryBusiness: type: array items: type: object allOf: – #/definitions/telemetryBusiness description: Registros de telemetria de negócio createdDate: type: string format: date-time description: Data de criação do registro telemetryWebservice: description: Telemetria especializada para webservice type: object required: – port – contextType properties: id: type: integer format: int64 description: ID da telemetria de webservice port: type: object allOf: – #/definitions/stringPool description: Porta associada (referência ao string pool) contextType: type: object allOf: – #/definitions/stringPool description: Contexto associado (referência ao string pool) inputBytes: type: integer format: int64 description: Tamanho do payload de entrada (bytes) outputBytes: type: integer format: int64 description: Tamanho do payload de saída (bytes) partnerId: type: string description: ID do parceiro (developer) isTrusted: type: boolean description: Indica se a chamada veio de parceiro confiável (token IDP) telemetry: type: object allOf: – #/definitions/telemetry description: Registro de telemetria associado editTelemetryWebservice: type: object required: – id allOf: – #/definitions/telemetryWebservice telemetryWeb50: description: Telemetria especializada para web 5.0 type: object required: – actionName properties: id: type: integer format: int64 description: ID da telemetria de web 5.0 actionName: type: object allOf: – #/definitions/stringPool description: Nome da ação associada (referência ao string pool) inputBytes: type: integer format: int64 description: Tamanho do payload de entrada (bytes) outputBytes: type: integer format: int64 description: Tamanho do payload de saída (bytes) telemetry: type: object allOf: – #/definitions/telemetry description: Registro de telemetria associado editTelemetryWeb50: type: object required: – id allOf: – #/definitions/telemetryWeb50 telemetryBusiness: description: Telemetria especializada para negócio type: object required: – business properties: id: type: integer format: int64 description: ID do registro de telemetria de negócio business: type: object allOf: – #/definitions/stringPool description: Negócio associado (referência ao string pool) count: type: integer format: int64 description: Quantidade de execuções telemetry: type: object allOf: – #/definitions/telemetry description: Registro de telemetria associado editTelemetryBusiness: type: object required: – id allOf: – #/definitions/telemetryBusiness uploadProcess: description: Controle do processo de upload de telemetria type: object required: – fileId – telemetryType – dataFormatVersion – layoutVersion – status – createdAt properties: id: type: integer format: int64 description: ID do processo fileId: type: string description: Identificador do arquivo no blob service (ex: webservice/uuid.zip) telemetryType: type: string allOf: – #/definitions/telemetryType description: Tipo de telemetria principal fileName: type: string description: Nome do arquivo gerado pelo blob service fileVersion: type: string description: Versão do arquivo gerado pelo blob service dataFormatVersion: type: string allOf: – #/definitions/dataFormatVersion description: Versão do formato de dados — determina o DataFormatProcessor layoutVersion: type: string description: Versão do layout do tipo principal businessLayoutVersion: type: string description: Versão do layout de negócio (apenas para ZIP V_01 com business.csv) client: type: string description: Identificador do cliente (customerId / codcli) environment: type: string description: Identificador do ambiente system: type: string description: Tipo do sistema blobExpiresAt: type: string format: date-time description: Expiração efetiva do blob no BlobService (gravada no commit com o TTL vigente) status: type: string allOf: – #/definitions/uploadProcessStatus description: Status do processo de upload createdAt: type: string format: date-time description: Data de criação (UTC) updatedAt: type: string format: date-time description: Data de atualização (UTC) persistedAt: type: string format: date-time description: UTC em que a telemetria deste arquivo foi persistida (PROCESSED); nulo se ainda não persistiu ou se ERROR errorMessage: type: string description: Motivo do erro (ERROR): mensagens da exceção e das causas, até 1.000 caracteres agentVersion: type: string description: Versão do agente que enviou o arquivo; nula no upload legado (v0) systemVersion: type: string description: Versão do sistema do ambiente que enviou o arquivo; nula no upload legado (v0) rowsTotal: type: integer format: int64 description: Linhas do arquivo principal lidas na persistência (PROCESSED) rowsInserted: type: integer format: int64 description: Linhas do arquivo principal inseridas em telemetry; menos que rowsTotal quando há duplicatas (PROCESSED) reprocessedAt: type: string format: date-time description: UTC do último reprocessamento a partir do bruto (requestFileReprocess); nulo se nunca reprocessado reprocessCount: type: integer format: int64 description: Reprocessamentos a partir do bruto concluídos; nulo se nunca reprocessado environment: description: Ambiente type: object required: – name – customerId – system – systemVersion – agentVersion properties: id: type: string format: uuid description: ID name: type: string description: Nome do ambiente customerId: type: string description: ID do cliente system: type: string allOf: – #/definitions/systemType description: Sistema systemVersion: type: string description: Versão do Sistema agentVersion: type: string description: Versão do agente reportAnomaly: description: Registro de anomalia detectada pelo agente type: object required: – environment – reportDate – kind – description – occurrences properties: id: type: string format: uuid description: ID da anomalia environment: type: object allOf: – #/definitions/environment description: Ambiente reportDate: type: string format: date-time description: Data do registro da anomalia kind: type: string description: Tipo de anomalia description: type: string description: Descrição da anomalia occurrences: type: integer format: int64 description: Quantidade ocorrências dismissedAt: type: string format: date-time description: Descarte como falso positivo; nulo se a anomalia está ativa dismissedBy: type: string description: Usuário que descartou a anomalia dismissReason: type: string description: Motivo do descarte, até 1.000 caracteres productConfig: description: Configurações do produto type: object required: – system – productName – productId properties: id: type: string format: uuid description: ID system: type: string allOf: – #/definitions/systemType description: Sistema productName: type: string description: Nome do produto SHBS productId: type: string description: ID do produto queryExecutionBlobService: description: Configuração de serviço de armazenamento para resultados de query execution type: object required: – name – domainName – serviceName – areaSecret – objectPrefix – ttlDays – active properties: id: type: string format: uuid description: ID name: type: string description: Nome da configuração description: type: string description: Descrição domainName: type: string description: Nome do domínio do BlobService serviceName: type: string description: Nome do serviço do BlobService areaSecret: type: string description: Chave secreta de área do BlobService objectPrefix: type: string description: Prefixo do caminho do objeto no blob (ex: query-execution/) ttlDays: type: integer format: int64 description: TTL em dias para expiração dos arquivos armazenados active: type: boolean description: Ativo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editQueryExecutionBlobService: type: object required: – id allOf: – #/definitions/queryExecutionBlobService queryExecution: description: Solicitação de extração de dados imutável executada pelo agente type: object required: – name – customerId – environmentId – sqlCommand properties: id: type: string format: uuid description: ID (exposto externamente como executionId) name: type: string description: Nome identificador da extração description: type: string description: Descrição opcional customerId: type: string description: ID do cliente alvo environmentId: type: string description: ID do ambiente alvo sqlCommand: type: string description: Comando SQL de extração (somente leitura) blobServiceId: type: string format: uuid description: ID do BlobService de destino — alternativa a blobService.id no create (não persistido) blobService: type: object allOf: – #/definitions/queryExecutionBlobService description: Configuração do BlobService para armazenar o resultado (XOR com s3PresignedUploadUrl) s3PresignedUploadUrl: type: string description: URL pré-assinada S3 com permissão de PUT (XOR com blobService) status: type: string allOf: – #/definitions/queryExecutionStatus description: Status agregado da execução (definido pelo servidor no create como PENDING) resultFileReference: type: string description: Referência do arquivo no BlobService (fileReference / targetObjectId) resultUploadVersion: type: string description: Versão do upload BlobService resultObjectKey: type: string description: Chave do objeto no bucket S3 reportada pelo agente cancelledAt: type: string format: date-time description: Data/hora do cancelamento cancelledBy: type: string description: Usuário que cancelou phaseLogs: type: array items: type: object allOf: – #/definitions/queryExecutionPhaseLog description: Logs de fase (RECEIPT / EXECUTION / UPLOAD) createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editQueryExecution: type: object required: – id allOf: – #/definitions/queryExecution queryExecutionPhaseLog: description: Log de execução por fase de uma query execution type: object required: – phase – status – startedAt – finishedAt properties: id: type: string format: uuid description: ID queryExecution: type: object allOf: – #/definitions/queryExecution description: Execução associada phase: type: string allOf: – #/definitions/queryExecutionPhase description: Fase da execução status: type: string allOf: – #/definitions/queryExecutionPhaseStatus description: Status da fase startedAt: type: string format: date-time description: Início da fase finishedAt: type: string format: date-time description: Fim da fase durationSeconds: type: integer format: int64 description: Duração da fase em segundos (coluna gerada no banco; somente leitura) errorMessage: type: string description: Mensagem de erro em caso de falha rowCount: type: integer format: int64 description: Número de linhas retornadas (preenchido em EXECUTION) createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editQueryExecutionPhaseLog: type: object required: – id allOf: – #/definitions/queryExecutionPhaseLog processedEvent: description: Dedupe de mensagens do webhook SHBS client.resources.updated (por id do envelope) type: object required: – messageId – batchId – part – eventType – receivedAt properties: id: type: string format: uuid description: ID messageId: type: string description: ID da mensagem (id do envelope) — chave de dedupe batchId: type: string description: Lote multipart ao qual a mensagem pertence (data.batchId) part: type: integer format: int64 description: Número da parte nesta mensagem (data.part) eventType: type: string description: Tipo do evento no envelope (ex.: client.resources.updated) receivedAt: type: string format: date-time description: Momento em que a mensagem foi aceita/registrada pelo Hub processedBatch: description: Fonte de verdade do ciclo de vida de um lote multipart do webhook SHBS type: object required: – batchId – status – seniorId – productId – totalParts – processedAt properties: id: type: string format: uuid description: ID batchId: type: string description: Identificador do lote multipart (data.batchId) — chave de negócio status: type: string allOf: – #/definitions/processedBatchStatus description: Status do ciclo de vida do lote seniorId: type: integer format: int64 description: Código do cliente (data.seniorId = codcli/customer_id) productId: type: string description: Produto do lote (data.productId) totalParts: type: integer format: int64 description: Quantidade total de partes esperadas (data.totalParts) processedAt: type: string format: date-time description: Última atualização relevante do lote (recebimento/commit/ORPHAN/FAILED/sync) eventPartStaging: description: Buffer temporário do conteúdo de cada parte de um lote multipart até completar type: object required: – batchId – part – messageId – totalParts – seniorId – productId – payload – receivedAt properties: id: type: string format: uuid description: ID batchId: type: string description: Lote multipart (data.batchId) part: type: integer format: int64 description: Número da parte nesta linha (data.part) messageId: type: string description: id do envelope que trouxe esta parte (rastreio/correlação com processedEvent) totalParts: type: integer format: int64 description: Total de partes do lote (data.totalParts), espelhado para validar consistência seniorId: type: integer format: int64 description: Código do cliente (data.seniorId), redundante por parte para o commit productId: type: string description: Produto (data.productId) associado aos resources desta parte payload: type: string description: JSON de data.resources[] desta parte receivedAt: type: string format: date-time description: Momento em que esta parte foi gravada no staging externalPolicyLink: description: De-para path-a-path entre a política externa (SHBS) e a blocking_rule agregada type: object required: – source – clientId – resourcePath – productId – blockingRule – active – updatedAt properties: id: type: string format: uuid description: ID source: type: string description: Origem semântica do vínculo (ex.: SHBS_RESOURCE_BLOCK) externalKey: type: string description: Chave externa opcional para correlação com o emissor clientId: type: integer format: int64 description: Código do cliente (data.seniorId = codcli/customer_id) resourcePath: type: string description: Path do recurso, conforme recebido do emissor — chave lógica do recurso bloqueado/liberado productId: type: string description: Produto ao qual o path pertence (data.productId) blockingRule: type: object allOf: – #/definitions/blockingRule description: Regra agregada no Hub que materializa este path (cliente×produto / origin) active: type: boolean description: Se o vínculo está vigente (true) ou foi desativado por enabled/rebuild (false) lastEventId: type: string description: Último id de evento que alterou este vínculo (rastreio/auditoria) updatedAt: type: string format: date-time description: Momento da última alteração do vínculo restoreExecution: description: Execução de restauração histórica de telemetria type: object required: – client – startDate – endDate – status – createdAt properties: id: type: string format: uuid description: ID único da execução client: type: string description: Código do cliente (codcli) startDate: type: string format: date description: Data inicial do período (inclusiva) endDate: type: string format: date description: Data final do período (inclusiva) status: type: string allOf: – #/definitions/restoreExecutionStatus description: Status da execução targetObjectId: type: string description: Identificador do ZIP no BlobService downloadUrl: type: string description: URL pré-assinada para download do ZIP agregado urlExpiresAt: type: string format: date-time description: Expiração da URL de download totalFound: type: integer format: int64 description: Quantidade de arquivos encontrados no período totalIncluded: type: integer format: int64 description: Quantidade incluída no ZIP totalFailed: type: integer format: int64 description: Quantidade com falha real de recuperação totalExpired: type: integer format: int64 description: Quantidade fora do TTL do blob errorMessage: type: string description: Mensagem de erro em caso de falha createdAt: type: string format: date-time description: Data de criação da solicitação finishedAt: type: string format: date-time description: Data de conclusão da solicitação fileIds: type: string description: Arquivos escolhidos (fileId), separados por vírgula; nulo na restauração de todos os arquivos do período createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service checkDTO: description: Retorno status usados de retorno type: object required: – status – name properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status name: type: string description: Status genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage