post https://plataforma.bigdatacorp.com.br/monitoramento/monitorar
Descrição
Este endpoint realiza a inscrição de monitoramento para um novo registro através do QueryId de uma chamada feita anteriormente.
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 na API da Plataforma de Dados. Também pode ser passado no cabeçalho da requisição. | Token JWT |
| QueryId | Não | QueryId de uma chamada realizada anteriormente. Caso fornecido, os parâmetros seguintes não devem ser informados. | QueryId |
| SubscriptionHooks | Sim | Mecanismo de envio das informações | Mecanismo a ser utilizado para o envio das atualizações dos dados. Veja a descrição da API de Monitoramento para mais detalhes. |
Retorno
Este método retorna um SubscriptionId, que é uma identificação única da assinatura de monitoramento. Recomendamos armazenar esta informação para eventual uso posterior.
Exemplos
A seguir está um exemplo de uso deste endpoint.
POST: https://plataforma.bigdatacorp.com.br/monitoramento/monitorar
Request:
{
"AccessToken": "<YOUR_ACCESS_TOKEN>",
"QueryId": "b9886b7d-c796-43ac-b97d-c5006a33ecd5",
"SubscriptionHooks": "email{[email protected]}"
}
Response:
{
"QueryId": "b9886b7d-c796-43ac-b97d-c5006a33ecd5",
"ElapsedMilliseconds": 88,
"QueryDate": "2024-09-18T19:07:56.7202733Z",
"Status": {
"subscription": [
{
"Code": 0,
"Message": "OK"
}
]
},
"Evidences": {},
"SubscriptionId": "66eb250c116bae298ca4daee"
}