Descrição
Este método permite desabilitar um conjunto de registros de monitoramento assinados anteriormente. Isso pode ser feito através do SubscriptionId, QueryId da chamada original ou dos parâmetros de monitoramento (Api, Datasets e Parameters). É retornada uma flag chamada Unsubscribed, que indica se a requisição para desabilitar o monitoramento foi bem sucedida.
Parâmetros de Entrada
A tabela a seguir descreve os parâmetros de entrada deste método, indicando se são obrigatórios.
| Campo | Obrigatório? | Valores Possíveis | Descrição |
|---|---|---|---|
| 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 |
| SubscriptionIds | Não | Uma lista de identificadores de monitoramento | A lista dos monitoramentos que devem ser desligados. Se não for preenchido, o parâmetro QueryIds éobrigatório |
| QueryIds | Não | Uma lista de identificadores de chamada que iniciaram monitoramentos | A lista dos identificadores de chamada cujos monitoramentos devem ser desligados. Se não for preenchido, o parâmetroSubscriptionIds é obrigatório |
| Api | Não | API usada no monitoramento | people ou companies |
| Datasets | Não | Datasets inscritos no monitoramento | Datasets |
| Parameters | Não | Parâmetros enviados na chamada que originou esse monitoramento | Parâmetros de chamada |
Atenção
Existe uma prioridade de uso dos parâmetros deste endpoint. Primeiro, buscamos pela lista de SubscriptionIds. Se houver algum valor nesta lista, ignora-se os demais parâmetros, caso contrário verificamos a lista de QueryIds. Se esta lista também não possuir items, serão utilizados os campos Api, Datasets e Parameters. Neste último caso, os três parâmetros não podem ser vazios e devem corresponder exatamente ao que foi informado no momento da inscrição de monitoramento.
Retorno
A tabela a seguir descreve os campos do objeto de retorno deste método.
| Campo | Descrição |
|---|---|
| SubscriptionId | O identificador do monitoramento que foi desabilitado |
| OriginalQueryId | O identificador da consulta que ativou o monitoramento |
| Unsubscribed | Flag indicando se a operação de desativar o monitoramento foi bem sucedida |
| ErrorMessage | Mensagem de erro para causos em que a requisição não ocorreu como esperado |
Exemplos
A seguir estão alguns exemplos de uso deste endpoint.
POST: https://plataforma.bigdatacorp.com.br/monitoramento/desabilitar
Request:
{
"SubscriptionIds": ["66eb250c116bae298ca4daef"]
}
Response:
{
"UnsubscriptionsStatus": [
{
"SubscriptionId": "66eb250c116bae298ca4daef",
"Unsubscribed": true
}
],
"QueryId": "89220733-88c6-422f-ab2f-895462f78d12",
"ElapsedMilliseconds": 71,
"QueryDate": "2024-09-19T16:52:44.8704444+00:00",
"Status": {
"unsubscribe": [
{
"Code": 0,
"Message": "OK"
}
]
}
}
Request:
{
"QueryIds": ["b9886b7d-c796-43ac-b97d-c5006a33ecd6"]
}
Response:
{
"UnsubscriptionsStatus": [
{
"SubscriptionId": "66eb250c116bae298ca4daef",
"Unsubscribed": true
}
],
"QueryId": "89220733-88c6-422f-ab2f-895462f78d12",
"ElapsedMilliseconds": 71,
"QueryDate": "2024-09-19T16:52:44.8704444+00:00",
"Status": {
"unsubscribe": [
{
"Code": 0,
"Message": "OK"
}
]
}
}
Request:
{
"Api": "people",
"Datasets": "basic_data.listen(TaxIdStatus)",
"Parameters": "doc{09919503649}"
}
Response:
{
"UnsubscriptionsStatus": [
{
"SubscriptionId": "66eb250c116bae298ca4daef",
"Unsubscribed": true
}
],
"QueryId": "89220733-88c6-422f-ab2f-895462f78d12",
"ElapsedMilliseconds": 71,
"QueryDate": "2024-09-19T16:52:44.8704444+00:00",
"Status": {
"unsubscribe": [
{
"Code": 0,
"Message": "OK"
}
]
}
}