Descrição
Esta funcionalidade permite atualizar os campos monitorados ou o mecanismo de envio de um registro de monitoramento ativo. Após a atualização, são retornadas informações sobre os detalhes do registro.
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? | Descrição | Valores Possíveis |
|---|---|---|---|
| AccessToken | Sim | Token de autenticação nas APIs da Plataforma de Dados. Também pode ser informado no cabeçalho da requisição. | Token JWT |
| SubscriptionId | Não | Identificador de monitoramento | GUID |
| QueryId | Não | Identificador de monitoramento | GUID |
| Datasets | Não | Lista dos datasets monitorados, com as informações de campos monitoratos para cada um. | basic_data.listen(TaxIdStatus), kyc.listen(IsCurrentlySanctioned), etc |
| SubscriptionHooks | Não | Mecanismo de envio das informações (email, webhook ou sftp) | email{john@doe}, webhook{https://your-domain:1234}, file{sftp://user:password@dns:port}, etc |
Atenção
O SubscriptionId OU QueryId devem ser informados para localizarmos o registro de monitoramento adequado. Caso não for informado o parâmetro Datasets e nem o SubscriptionHooks, a API retornará erro de parâmetros inválidos. Certifique-se de inserir informações corretas no parâmetro Datasets, todos os datasets originais devem ser incluídos e apenas o parâmetro listen poderá ser modificado.
Retorno
A tabela a seguir descreve os campos do objeto de retorno desse método.
| Campo | Descrição |
|---|---|
| SubscriptionDetails | Lista de objetos com as informações detalhadas do monitoramento |
| SubscriptionDetails[n].SubscriptionId | Id único do monitoramento |
| SubscriptionDetails[n].OriginalQueryId | QueryId da chamada que originou esse monitoramento |
| SubscriptionDetails[n].Api | API usada nesse monitoramento (people, companies) |
| SubscriptionDetails[n].Locale | Região referente ao monitoramento (pt-br, mx-es) |
| SubscriptionDetails[n].Parameters | Parâmetros enviados na chamada que originou esse monitoramento |
| SubscriptionDetails[n].TargetHook | Configuração de hook de retorno utilizada |
| SubscriptionDetails[n].Datasets | Datasets inscritos no monitoramento |
| SubscriptionDetails[n].CreationDate | Data de ativação do monitoramento |
| SubscriptionDetails[n].LastTriggeredDate | Data em que a última alteração foi encontrada |
Exemplos
A seguir estão alguns exemplos de uso deste endpoint.
POST: https://plataforma.bigdatacorp.com.br/monitoramento/atualizar
Request:
{
"SubscriptionId": "66c33ea6793e9579617c8166",
"Datasets": "basic_data.listen(TaxIdStatus, Name),kyc.listen(IsCurrentlySanctioned)",
}
Response:
{
"SubscriptionDetails": {
"SubscriptionId": "66c33ea6793e9579617c8167",
"OriginalQueryId": "59d00ad7-8549-47ec-85fd-3afdfa34b3f3",
"Api": "people",
"Locale": "pt-br",
"Parameters": "doc**********82}",
"Datasets": "basic_data.listen(TaxIdStatus, Name),kyc.listen(IsCurrentlySanctioned)",
"TargetHook": "ema*******************************br}",
"CreationDate": "2024-08-19T12:46:30Z",
"LastTriggeredDate": "2024-11-06T21:05:40Z"
},
"QueryId": "5e3440f3-039e-46fe-8fdd-4d2fb00edabe",
"ElapsedMilliseconds": 1055,
"QueryDate": "2024-12-09T18:32:56.81015+00:00",
"Status": {
"details": [
{
"Code": 0,
"Message": "OK"
}
]
}
}
Request:
{
"SubscriptionId": "66c33ea6793e9579617c8166",
"SubscriptionHooks": "email{john@doe}"
}
Response:
{
"SubscriptionDetails": {
"SubscriptionId": "66c33ea6793e9579617c8167",
"OriginalQueryId": "59d00ad7-8549-47ec-85fd-3afdfa34b3f3",
"Api": "people",
"Locale": "pt-br",
"Parameters": "doc**********82}",
"Datasets": "basic_data.listen(TaxIdStatus),kyc",
"TargetHook": "email{john@doe}",
"CreationDate": "2024-08-19T12:46:30Z",
"LastTriggeredDate": "2024-11-06T21:05:40Z"
},
"QueryId": "5e3440f3-039e-46fe-8fdd-4d2fb00edabe",
"ElapsedMilliseconds": 1055,
"QueryDate": "2024-12-09T18:32:56.81015+00:00",
"Status": {
"details": [
{
"Code": 0,
"Message": "OK"
}
]
}
}