Essa página tem como objetivo mostrar o fluxo de Monitoramento cutomizado
Criação do monitoramento
custom
;search_key
: Este campo define o valor da entidade que será buscada, para monitoramento customizado, terá sempre o valor custom
;
cache_ttl_in_days
(opcional): Número inteiro que define até quantos dias o resultado da busca pode considerar um cache válido;
search_params
: Um objeto que contém alguns parâmetros da busca como: - lawsuit_instance
(opcional): Este parâmetro permite definir a instância em que deseja buscar o processo; - masked_response
Define se a resposta virá minificada. Este parâmetro é aplicável apenas a consultas (simples ou completas) no contexto de busca processual. - masked_response = true
: retornará uma consulta completa - masked_response = false
: retornará uma consulta simples
*Obs
Consulte as condições comerciais desses diferentes tipos de monitoramento customizado.
filter
deve ser incluído dentro de search_params
, com os seguintes filtros disponíveis:filter
(opcional): Um objeto que contém os filtros para a busca, como:
side
(opcional): Permite buscar por tipos de participantes do processo, podendo ser: ‘Passive’, ‘Active’, ‘Interested’, ‘Unknown’;
amount_gte
(opcional): Filtra processos com valor da causa maior ou igual ao especificado em amount_gte
;
amount_lte
(opcional): Filtra processos com valor da causa menor ou igual ao especificado em amount_lte
;
tribunals
(opcional): Um objeto que contém os filtros de tribunais:
keys
(opcional): Lista de códigos de tribunais disponíveis na lista de tribunais. Este filtro permite restringir a busca a processos que tenham ou não esses códigos específicos;not_equal
(opcional): Valor booleano que define se o filtro incluirá ou excluirá os valores especificados em keys
.subject_codes
(opcional): Um objeto que contém os filtros de assuntos:
contains
(opcional): Lista de códigos de assuntos. Restringe a busca a processos que incluam os códigos especificados.not_contains
(opcional): Lista de códigos de assuntos. Exclui processos que contenham os códigos especificados.classification_codes
(opcional): Um objeto que contém os filtros de classes processuais:
keys
(opcional): Lista de códigos de classes processuais. Este filtro permite restringir a busca a processos que tenham ou não esses códigos específicos;not_equal
(opcional): Valor booleano que define se o filtro incluirá ou excluirá os valores especificados em keys
.distribution_date_gte
(opcional): Permite especificar uma data mínima de distribuição. Este filtro localiza processos distribuídos após a data informada.
credential
(opcional): Objeto para o uso do cofre de credenciais:
customer_key
(opcional): Permite passar a chave do usuário cadastrada no cofre de credenciais. Caso não seja informada, a API tentará encontrar uma credencial cadastrada para uma customer_key
vazia.
last_step_date_gte
(opcional): Restringe a busca a processos cuja data da última movimentação seja maior que à data fornecida.
last_step_date_lte
(opcional): Restringe a busca a processos cuja data da última movimentação seja menor que à data fornecida.
party_names
(opcional): Lista de nomes que restringe a busca a processos que os contenham em alguma das partes.
Obs
Ao utilizar esse filtro em conjunto com o filtro de Side
, o filtro de Side
não será considerado para a restrição dessas partes, já que o filtro de Side
é utilizado para filtrar processos onde a parte principal buscada esteja no lado especificado.
party_documents
(opcional): Lista de documentos que restringe a busca a processos que os contenham em alguma das partes.
Obs
Ao utilizar esse filtro em conjunto com o filtro de Side
, o filtro de Side
não será considerado para a restrição desses documentos, já que o filtro de Side
é utilizado para filtrar processos onde a parte principal buscada esteja no lado especificado.
hour_range
, que indica o horário em que a consulta ao tribunal será realizada pela primeira vez. No exemplo acima, a primeira consulta está programada para ocorrer às 21 horas.Consultar o status do monitoramento
Consultar o conteúdo da resposta (nova ação encontrada)
Exemplo de retorno da Request
As propriedades de paginação:
Consultando histórico de um monitoramento
created_at_gte
e created_at_lte
, onde:created_at_gte
: define a data inicial da consulta.
created_at_lte
: define a data final da consulta.Aqui está um exemplo de como fazer isso usando curl:Pausando um Monitoramento
/tracking/{monitoramento}/pause
, substituindo {monitoramento}
pelo ID do monitoramento que você deseja pausar.Aqui está um exemplo de como pausar o monitoramento usando o curl:Reativando um Monitoramento
/tracking/{monitoramento}/resume
, substituindo {monitoramento}
pelo ID do monitoramento que você deseja reativar.Aqui está um exemplo de como reativar um monitoramento usando curl:Deletando um Monitoramento
/tracking/{monitoramento}
, substituindo {monitoramento}
pelo ID do monitoramento que você deseja deletar.Aqui está um exemplo de como deletar um monitoramento usando curl: