Descrição
Este endpoint permite desabilitar um ou mais registros de monitoramento ativos. A desativação pode ser realizada utilizando o SubscriptionId, o QueryId da consulta original, ou um conjunto de parâmetros da chamada (Api, Datasets e Parameters). O retorno inclui um indicador booleano Unsubscribed para cada registro, confirmando o sucesso da operação.
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 para as 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
A API processa os parâmetros de entrada com a seguinte ordem de prioridade:
SubscriptionIds,QueryIdse, por último, a combinação deApi,DatasetseParameters. Ao encontrar um parâmetro preenchido, os demais de menor prioridade são ignorados. Caso a busca seja feita pela combinação de parâmetros, todos os três campos devem ser fornecidos e corresponder exatamente aos valores da inscrição original.
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"
}
]
}
}