post https://plataforma.bigdatacorp.com.br/monitoramento/listar
Descrição
Esta funcionalidade permite listar todos os registros de monitoramento ativos para um domínio. Retorna informações sobre os parâmetros, datasets, APIs, dentre outras. Os registros são exibidos em ordem de criação, do mais antigo ao mais recente. Podem ser usados filtros e paginação para analisar volumes maiores de registros.
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 |
| PageSize | Não | A quantidade máxima de registros que serão retornados por requisição (padrão de 50 registros) | Número inteiro maior que 0. |
| Cursor | Não | Este campo recebe uma identificação de monitoramento (SubscriptionId), que será usada como referência para obter os demais registros gerados a partir da data de criação desta referência. | SubscriptionId |
| FilterByParameters | Não | O filtro de busca utilizando um parâmetro específico nos registros associados | O mesmo valor do parâmetro "q" das consultas em datasets |
Retorno
A tabela a seguir descreve os campos do objeto de retorno desse método.
| Campo | Descrição |
|---|---|
| ActiveSubscriptions | Lista de objetos com as informações detalhadas de cada monitoramento |
| ActiveSubscriptions[n].SubscriptionId | Id único do monitoramento |
| ActiveSubscriptions[n].OriginalQueryId | QueryId da chamada que originou esse monitoramento |
| ActiveSubscriptions[n].Api | API usada nesse monitoramento (people, companies) |
| ActiveSubscriptions[n].Locale | Região referente ao monitoramento (pt-br, mx-es) |
| ActiveSubscriptions[n].Parameters | Parâmetros enviados na chamada que originou esse monitoramento |
| ActiveSubscriptions[n].Datasets | Datasets inscritos no monitoramento |
| ActiveSubscriptions[n].TargetHook | Configuração de hook de retorno utilizada |
Exemplos
A seguir estão alguns exemplos de uso deste endpoint.
POST: https://plataforma.bigdatacorp.com.br/monitoramento/listar
Request:
{
// Empty
}
Response:
{
"ActiveSubscriptions": [
{
"SubscriptionId": "66eb250c116bae298ca4dafe",
"OriginalQueryId": "b9886b7d-c796-43ac-b97d-c5006a33ecf5",
"Api": "people",
"Locale": "pt-br",
"Parameters": "doc{CPF}",
"Datasets": "basic_data.listen(TaxIdStatus)",
"TargetHook": "email{[email protected]}"
}
],
"QueryId": "1cfecda3-7cdf-4c9e-10e7-e66c5b2b74a5",
"ElapsedMilliseconds": 0,
"QueryDate": "2024-09-19T13:51:39.898Z",
"Status": {
"subscription": [
{
"Code": 0,
"Message": "OK"
}
]
}
}
Request:
{
"FilterByParameters": "doc{CPF}"
}
Response:
{
"ActiveSubscriptions": [
{
"SubscriptionId": "66eb250c116bae298ca4dafe",
"OriginalQueryId": "b9886b7d-c796-43ac-b97d-c5006a33ecf5",
"Api": "people",
"Locale": "pt-br",
"Parameters": "doc{CPF}",
"Datasets": "basic_data.listen(TaxIdStatus)",
"TargetHook": "email{[email protected]}"
}
],
"QueryId": "1cfecda3-7cdf-4c9e-10e7-e66c5b2b74a5",
"ElapsedMilliseconds": 0,
"QueryDate": "2024-09-19T13:51:39.898Z",
"Status": {
"subscription": [
{
"Code": 0,
"Message": "OK"
}
]
}
}
Request:
{
"Cursor": "66c33ea6793e9579617c8165",
"PageSize": 10
}
Response:
{
"ActiveSubscriptions": [
{
"SubscriptionId": "66eb250c116bae298ca4dafe",
"OriginalQueryId": "b9886b7d-c796-43ac-b97d-c5006a33ecf5",
"Api": "people",
"Locale": "pt-br",
"Parameters": "doc{CPF}",
"Datasets": "basic_data.listen(TaxIdStatus)",
"TargetHook": "email{[email protected]}"
}
],
"QueryId": "1cfecda3-7cdf-4c9e-10e7-e66c5b2b74a5",
"ElapsedMilliseconds": 0,
"QueryDate": "2024-09-19T13:51:39.898Z",
"Status": {
"subscription": [
{
"Code": 0,
"Message": "OK"
}
]
}
}