Cadastrar monitoramento

Cadastra um monitoramento na empresa do usuário; o usuário autenticado fica registrado como quem criou.

O monitoramento nasce SCHEDULED, e a primeira consulta de cada módulo fica agendada para o dia de startDate, que precisa ser a partir de amanhã; depois, cada módulo roda a cada frequencyDays dias até endDate.

O cadastro não cobra créditos: cada consulta disparada pelo monitoramento é cobrada como uma consulta comum. Em cada módulo, criterion ANY_CHANGE alerta em qualquer mudança; SPECIFIC_CHANGE alerta só quando conditions é satisfeita, com os campos e operadores devolvidos pela rota de listar módulos monitoráveis. A resposta traz só _id e status; para os dados completos, use a rota de visualizar monitoramento.

É preciso ao menos um cliente e um módulo; os clientes precisam ser pessoas físicas ou jurídicas da empresa e não estar excluídos da base de clientes, e cada módulo precisa estar disponível no perfil de permissão do usuário, como em available na rota de listar módulos monitoráveis. O nome não pode repetir o de outro monitoramento da empresa, sem diferenciar maiúsculas nem acentos. Requer autenticação via Bearer JWT ou header x-api-key e a permissão de cadastrar monitoramentos. Usuário sem perfil de permissão recebe 403 (Acesso negado); perfil inexistente, 401 (Permissão inválida!); perfil sem a permissão, 400 (Permissão não encontrada); usuário inativo, 404 (Usuário não encontrado).

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Respostas

🟢201Sucesso

application/json

Monitoramento cadastrado

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

🟠400Sem permissão para cadastrar monitoramentos

🟠403Acesso negado

🟠409Nome já usado

🟠422Corpo ou regra inválidos

curl --location '/v2/monitoring/' \ --header 'x-api-key: SUA_CHAVE_DE_API' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "name": "Carteira safra 30/31", "description": "Produtores de milho do PR", "startDate": "2030-01-02", "endDate": "2031-01-01", "modules": [ { "moduleKey": "PROTESTS", "frequencyDays": 30, "alertEnabled": true, "criterion": "ANY_CHANGE" }, { "moduleKey": "DEBT" } ], "clientIds": [ "7c9e6679-7425-40de-944b-e07fc1f90ae7", "0e7a3c58-91d4-4b6f-8c2a-5d3b9f1e6a22" ] }'

Cadastrar monitoramento

Requisição

Respostas