Nunciatura Provista

API Documentation V1

Exportar Lista de Processos em PDF

Gera e baixa um arquivo PDF com a lista de processos aplicando os mesmos filtros da listagem

Este endpoint é do tipo: Protected

Descrição

Gera e baixa um arquivo PDF com a lista de processos aplicando os mesmos filtros da listagem padrão. O PDF inclui:

  • Layout profissional otimizado para impressão (A4 paisagem)
  • Cabeçalho com informações do sistema e data de geração
  • Informações do relatório (total de processos, filtros aplicados)
  • Tabela com todos os processos (sem paginação) e dados essenciais: Iniciais, Nome, Protocolo, Descrição, Total Informadores, Respostas (Recebidas/Esperadas), Status e Data de Criação
  • Numeração automática de páginas no rodapé
  • Suporte aos mesmos filtros da listagem (search)
  • Requer autenticação JWT válida

Detalhes do Endpoint

VERBO

GET

URL BASE

http://api.provista.hmg.nabrasil.org.br/v1

ENDPOINT

/processes/export/pdf

Parâmetros de Query

Campo Tipo Obrigatório Descrição
search string Não Buscar por nome, protocolo ou descrição do processo

Cabeçalhos

Parâmetro Valor
Authorization Bearer <token>
Accept application/pdf

Respostas

Sucesso - 200

Content-Type: application/pdf
Content-Disposition: attachment; filename="lista_processos_2025-01-21_15-30-45.pdf"

[Arquivo PDF binário]

Nota: O endpoint retorna um arquivo PDF diretamente. O nome do arquivo segue o padrão "lista_processos_YYYY-MM-DD_HH-mm-ss.pdf" com a data e hora atual de geração.

Erro - 401 (Token inválido)

{
  "success": false,
  "message": "Token não fornecido"
}

Condição: Token JWT inválido, expirado ou não fornecido

Códigos de Resposta

Código Descrição
200 PDF gerado e baixado com sucesso
401 Token inválido ou expirado