Nunciatura Provista

API Documentation V1

Exportar Lista de Processos em CSV

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

Este endpoint é do tipo: Protected

Descrição

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

  • Formato CSV compatível com Excel e Google Sheets
  • Codificação UTF-8 com BOM para suporte completo a caracteres especiais
  • Dados completos de todos os processos (sem paginação)
  • Colunas organizadas: Nome, Protocolo, Descrição, Iniciais, Total Informadores, Respostas Recebidas, Total Esperado, Status, Data Criação e Data Atualização
  • 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/csv

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 text/csv

Estrutura do CSV

Colunas do Arquivo CSV:

Nome: Nome do processo
Protocolo: Protocolo único do processo
Descrição: Descrição do processo
Iniciais: Iniciais do processo
Total Informadores: Total de informadores vinculados
Respostas Recebidas: Número de respostas recebidas
Total Esperado: Número total de respostas esperadas
Status: Status do processo (A iniciar, Em andamento, Concluído)
Data Criação: Data de criação (dd/mm/aaaa hh:mm:ss)
Data Atualização: Data de atualização (dd/mm/aaaa hh:mm:ss)

Respostas

Sucesso - 200

Content-Type: text/csv; charset=UTF-8
Content-Disposition: attachment; filename="lista_processos_2025-01-21_15-30-45.csv"

"Nome","Protocolo","Descrição","Iniciais","Total Informadores","Respostas Recebidas","Total Esperado","Status","Data Criação","Data Atualização"
"Provisão Arcebispado","PROV-2025-001","Processo de provisão","PA","10","5","10","Em andamento","21/01/2025 10:00:00","21/01/2025 15:30:45"

Nota: O endpoint retorna um arquivo CSV diretamente. O nome do arquivo segue o padrão "lista_processos_YYYY-MM-DD_HH-mm-ss.csv" 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 CSV gerado e baixado com sucesso
401 Token inválido ou expirado