Listar agrupamentos de publicações.
GET · API de Integração v2
/v2/publicacoes/agrupamentosListar agrupamentos para a atualização
Retorna uma linha por data, UF e diário, com quantidade total, tratadas, pendentes e percentual tratado. É a rota adequada para montar a grade principal da atualização de publicações.
Tratamento: qtd informa o total da linha. O objeto tratamento reúne qtdTratadas, qtdPendentes, percentualTratado, grupoTratado e status (PENDENTE, PARCIAL ou CONCLUIDO). Descartadas contam como tratadas; grupoTratado só é verdadeiro quando há publicações e nenhuma está pendente.
Período: use dataInicio e dataFim, no formato yyyy-MM-dd, para delimitar a consulta. Os filtros uf, siglaDiario, lido, numeroProcesso, responsavelIds, equipeIds, somenteSemResponsaveis e processoCadastro têm o mesmo significado da listagem individual.
Cenário preenchido para teste: GET /v2/publicacoes/agrupamentos?processoCadastro=TODOS&dataInicio=2026-09-28&dataFim=2026-09-28&pagina=1&tamanho=25. Ele corresponde à consulta legada de 28/09/2026. Na API nova, o intervalo legado data=28/09/2026 - 28/09/2026 vira as duas datas ISO; use somente tamanho, sem limit, perPage, per_page, itemsPerPage ou size.
Estados: lido=true inclui publicações concluídas e descartadas; lido=false retorna somente as não tratadas. somenteSemResponsaveis=true restringe aos processos sem responsáveis. Para processoCadastro, use TODOS, CADASTRADOS ou NAO_CADASTRADOS.
Paginação: pagina começa em 1; tamanho padrão é 15 e aceita no máximo 100 itens.
Autenticação
X-API-Key no cabeçalho. Como autenticar
Parâmetros de consulta14
dataDisponibilizacaoFimstringFim opcional do intervalo de disponibilização.
dataDisponibilizacaoIniciostringInício opcional do intervalo de disponibilização.
dataFimstringFim do período. O cenário preenchido usa 28/09/2026.
dataIniciostringInício do período. O cenário preenchido usa 28/09/2026.
equipeIdsarrayIDs opcionais das equipes. Repita o parâmetro para vários IDs.
lidobooleantrue para tratadas, false para não tratadas; ausente traz todas.
numeroProcessostringBusca textual opcional pelo número do processo.
paginaintegerPágina, iniciando em 1.
processoCadastrostringSituação de cadastro do processo.
responsavelIdsarrayIDs opcionais dos responsáveis. Repita o parâmetro para vários IDs.
siglaDiariostringSigla opcional do diário, obtida em /v2/publicacoes/opcoes/diarios.
somenteSemResponsaveisbooleantrue restringe a processos sem responsáveis.
tamanhointegerItens por página, entre 1 e 100. Sem parâmetro, a API usa 15; o cenário preenchido usa 25.
ufstringUF opcional do diário.
Respostas5
Exemplos ilustrativos · nenhuma requisição é enviada
200 · Sucesso
- Quando acontece
- A operação foi concluída.
- Como tratar
- Leia os dados retornados; em listagens, confira também a paginação.
Exemplo declarado no OpenAPI · application/json
{
"content": [
{
"uf": "SP",
"siglaDiario": "DIARIO-EXEMPLO",
"nomeDiario": "Diário fictício para demonstração",
"dataPublicacao": "2026-09-28",
"dataDisponibilizacao": "2026-09-25",
"qtd": 10,
"tratamento": {
"qtdTratadas": 9,
"qtdPendentes": 1,
"percentualTratado": 90,
"grupoTratado": false,
"status": "PARCIAL"
}
}
],
"page": 1,
"perPage": 25,
"total": 1,
"totalPages": 1
}Contrato de respostas
200Página de agrupamentos com resumo de tratamento.
Página de agrupamentos com resumo de tratamento.
application/json
contentAgrupamentoPublicacoesResponse[]Ver propriedades
dataDisponibilizacaostringdataPublicacaostringnomeDiariostringqtdintegersiglaDiariostringtratamentoResumoTratamentoPublicacoesResponseVer propriedades do item
grupoTratadobooleanpercentualTratadointegerqtdPendentesintegerqtdTratadasintegerstatusstringufstringpageintegerperPageintegertotalintegertotalPagesinteger400Filtro inválido, inclusive data fora de yyyy-MM-dd.
Filtro inválido, inclusive data fora de yyyy-MM-dd.
application/json
codestringcorrelationIdstringdetailstringerrorsErroItemApiResponse[]Ver propriedades
codestringCódigo estável do erro
fieldstringCampo relacionado
messagestringMensagem segura
instancestringrequestIdstringstatusintegertitlestringtypestring401Não autenticado; a camada de segurança encerra a requisição antes do controller.
Não autenticado; a camada de segurança encerra a requisição antes do controller.
O contrato não declara um corpo para esta resposta.
403Sem permissão para consultar; a camada de segurança encerra a requisição antes do controller.
Sem permissão para consultar; a camada de segurança encerra a requisição antes do controller.
O contrato não declara um corpo para esta resposta.
500Erro interno ao consultar a fonte de publicações.
Erro interno ao consultar a fonte de publicações.
application/json
codestringcorrelationIdstringdetailstringerrorsErroItemApiResponse[]Ver propriedades
codestringCódigo estável do erro
fieldstringCampo relacionado
messagestringMensagem segura
instancestringrequestIdstringstatusintegertitlestringtypestring