Paginação e filtros
Consulte coleções em partes e use os parâmetros específicos de cada recurso.
Listagens de processos e pessoas
As consultas paginadas de processos e de opções de pessoas usam page e perPage. A primeira página é 1; o tamanho padrão é 15 e o teto é 100 itens. Nessas consultas, valores acima do teto são reduzidos.
O comportamento de cada rota está descrito na referência. Não presuma que toda coleção tem os mesmos parâmetros.
GET /v2/processos?page=2&perPage=50
GET /v2/pessoas/opcoes?page=1&perPage=15Entenda o envelope
O envelope PaginaResponse informa os itens e os totais. Leia os campos recebidos em vez de calcular o fim da paginação pelo tamanho do array.
| Campo | Significado |
|---|---|
content |
Itens da página atual |
page |
Página atual, iniciando em 1 |
perPage |
Quantidade por página |
total |
Total de itens encontrados |
totalPages |
Total de páginas |
{
"content": [],
"page": 1,
"perPage": 15,
"total": 0,
"totalPages": 0
}A agenda tem um contrato próprio
A consulta de agenda é POST /v2/agenda/consulta. Ela recebe filtros no corpo e usa pagina e tamanho na query. O padrão é página 1 com 15 itens. tamanho=0 solicita toda a janela consultada; use esse modo com cuidado em conjuntos grandes.
Os campos agendaAudiencias, agendaCompromissos, agendaDiligencia e agendaExpedientes selecionam os tipos de registro retornados. No explorador, eles são checkboxes: marcado envia o número 1 (incluir), desmarcado envia o número 0 (não incluir).
Consulte o schema completo em Agenda para montar os filtros aceitos.
POST /v2/agenda/consulta?pagina=1&tamanho=15Combine filtros de processos
Em GET /v2/processos, os filtros são combinados por E. Omitir um filtro não restringe o resultado por ele. encerrado e monitoramentoAtivo são independentes.
A busca q procura pelo começo do número do processo, com ou sem máscara. Ela não é uma busca arbitrária por qualquer trecho. cpfCnpjCliente faz correspondência exata do documento do cliente, com ou sem máscara.
GET /v2/processos?encerrado=false&monitoramentoAtivo=true&page=1&perPage=15