Descrição
Este endpoint é projetado para evidenciar a evolução dos dados monitorados, permitindo a visualização de todas as atualizações que ocorreram desde o início do monitoramento para identificar alterações específicas. Ao fornecer um SubscriptionId, o sistema confronta automaticamente o resultado mais recente com o registro inicial, gerando um relatório que detalha as datas das consultas comparadas, os campos que estavam sob monitoramento e o objeto DiffDetails, que descreve textualmente as modificações encontradas em cada dataset (ex: "valor mudou de X para Y"), facilitando a análise de histórico e auditoria de mudanças.
Parâmetros de Entrada
A tabela a seguir descreve os parâmetros de entrada deste método, indicando se são obrigatórios ou não.
| Campo | Obrigatório? | Valores Possíveis | Descrição |
|---|---|---|---|
| AccessToken | Sim | Token de autenticação para as APIs da Plataforma de Dados. Também pode ser informado no cabeçalho da requisição. | Token JWT |
| SubscriptionId | Não | Ids de monitoramentos | O SubscriptionId que deseja ser comparado (a diferença é feita em relação ao último resultado desse monitormento) |
| IncludeAllChanges | Não | true ou false | Quando este parâmetro for definido como true, o retorno incluirá todas as modificações ocorridas desde a ativação do monitoramento, abrangendo inclusive os dados que não fazem parte da lista de campos monitorados. Há um limite de 1000 alterações listadas por dataset. |
Retorno
A tabela a seguir descreve os campos do objeto de retorno desse método.
| Campo | Descrição |
|---|---|
| ResultStatus | Status final da operação |
| ListenedFieldsByDataset | Objeto relacionando os campos monitorados em cada dataset. Só possuirá um valor caso o SubscriptionId seja fornecido. |
| QueriesDatesByQueryId | Datas referentes às consultas que foram comparadas |
| DiffDetails | Objeto contendo as alterações encontradas para cada dataset. |
Exemplos
A seguir estão alguns exemplos de uso deste endpoint.
POST: https://plataforma.bigdatacorp.com.br/monitoramento/diferencas
Request:
{
"AccessToken": "<YOUR_ACCESS_TOKEN>",
"SubscriptionId": "66eb250c116bae298ca4daef"
}
Response:
{
"SubscriptionDiff": {
"ResultStatus": "DONE",
"ListenedFieldsByDataset": {
"basic_data": [
"TaxIdStatus"
]
},
"QueriesDatesByQueryId": {
"9766a2c8-1556-4597-8c4c-6fc0031356cc": "2024-08-05T21:13:36.868196Z",
"50c1568b-e59d-43bd-99dc-b0c64a2b7459": "2024-08-12T21:08:11.0823583Z"
},
"DiffDetails": {
"basic_data": [
"O valor do campo 'BasicData.TaxIdStatus' mudou de 'REGULAR' para 'PENDENTE DE REGULARIZACAO'."
]
}
},
"QueryId": "b782cdd4-81be-4ce4-a360-5b0487418fc2",
"ElapsedMilliseconds": 2118,
"QueryDate": "2024-08-19T18:13:39.2413226+00:00",
"Status": {
"api": [
{
"Code": 0,
"Message": "OK"
}
]
}
}