Publicações

Exportar publicações em Excel ou PDF.

POST · API de Integração v2

POST/v2/publicacoes/relatorios/export

A exportação consulta as publicações do cliente autenticado por lotes. O campo Responsáveis é incluído automaticamente e o limite vem do plano contratado. Os headers X-Exportacao-Total-Encontrado, X-Exportacao-Total-Exportado e X-Exportacao-Limite informam o universo filtrado, a quantidade exportada e o limite contratado. Uma quantidade exportada menor que a encontrada indica relatório limitado pelo plano.

Autenticação

X-API-Key no cabeçalho. Como autenticar

Corpo da requisiçãoobrigatório

Filtros, campos e formato do relatório.

application/json

camposstring[]obrigatório

Colunas selecionadas; Responsáveis é incluída automaticamente.

exemplo: ["NUMERO_PROCESSO","DATA_PUBLICACAO","SIGLA_DIARIO"]

filtrosFiltroExportacaoPublicacoesRequestobrigatório

Ver propriedades

dataDisponibilizacaoFinalstring

Fim inclusivo da disponibilização (yyyy-MM-dd).

exemplo: 2026-09-30

dataDisponibilizacaoInicialstring

Início da disponibilização (yyyy-MM-dd).

exemplo: 2026-09-01

dataPublicacaoFimstring

Fim inclusivo da publicação (yyyy-MM-dd).

exemplo: 2026-09-30

dataPublicacaoIniciostring

Início da publicação (yyyy-MM-dd).

exemplo: 2026-09-01

equipeIdsinteger[]

IDs das equipes do cliente.

exemplo: [30]

lidoboolean

true: tratadas (inclui descartadas); false: pendentes; ausente/null: todas.

numeroProcessostring

Busca textual pelo número do processo.

exemplo: 0001234-56.2026.8.26.0001

processoCadastrostring

Situação de cadastro. Padrão: TODOS.

valores: CADASTRADOS · NAO_CADASTRADOS · TODOSexemplo: TODOS

responsavelIdsinteger[]

IDs dos responsáveis do cliente.

exemplo: [10,20]

siglaDiariostring

Sigla obtida nas opções de diários.

exemplo: TJSPDJN

somenteSemResponsaveisboolean

true: restringe a processos sem responsáveis; false ou ausente: não restringe.

ufstring

UF do diário.

exemplo: SP

formatostring

Formato do arquivo. Padrão: EXCEL.

valores: EXCEL · PDFexemplo: EXCEL

modoConteudostring

Forma de exibir o conteúdo quando a coluna estiver selecionada. Padrão: INTEIRO.

valores: INTEIRO · PREVIAexemplo: INTEIRO

Respostas5

Exemplos ilustrativos · nenhuma requisição é enviada

Cenário

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 ilustrativo gerado do schema · application/pdf

Exemplo · HTTP 200

{}

Contrato de respostas

200Arquivo do relatório.

Arquivo do relatório.

application/pdf

StreamingResponseBody

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

StreamingResponseBody

400Filtros, campos ou limite de exportação inválidos.

Filtros, campos ou limite de exportação inválidos.

application/pdf

codestring

exemplo: validation_error

correlationIdstring

exemplo: c4ce7307-1917-4539-b17a-9c73c972c261

detailstring

exemplo: Existem campos inválidos na requisição.

errorsErroItemApiResponse[]

Ver propriedades

codestring

Código estável do erro

exemplo: field_validation_error

fieldstring

Campo relacionado

exemplo: agenda.titulo

messagestring

Mensagem segura

exemplo: não deve estar em branco

instancestring

exemplo: /v2/agenda

requestIdstring

exemplo: e9db6635-7db3-40cb-8dd2-453c25e6a461

statusinteger

formato: int32exemplo: 400

titlestring

exemplo: Erro de validação

typestring

formato: uriexemplo: /errors/validation-error

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

codestring

exemplo: validation_error

correlationIdstring

exemplo: c4ce7307-1917-4539-b17a-9c73c972c261

detailstring

exemplo: Existem campos inválidos na requisição.

errorsErroItemApiResponse[]

Ver propriedades

codestring

Código estável do erro

exemplo: field_validation_error

fieldstring

Campo relacionado

exemplo: agenda.titulo

messagestring

Mensagem segura

exemplo: não deve estar em branco

instancestring

exemplo: /v2/agenda

requestIdstring

exemplo: e9db6635-7db3-40cb-8dd2-453c25e6a461

statusinteger

formato: int32exemplo: 400

titlestring

exemplo: Erro de validação

typestring

formato: uriexemplo: /errors/validation-error

401Nã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 exportar; a camada de segurança encerra a requisição antes do controller.

Sem permissão para exportar; a camada de segurança encerra a requisição antes do controller.

O contrato não declara um corpo para esta resposta.

500Erro ao gerar o arquivo.

Erro ao gerar o arquivo.

application/pdf

codestring

exemplo: validation_error

correlationIdstring

exemplo: c4ce7307-1917-4539-b17a-9c73c972c261

detailstring

exemplo: Existem campos inválidos na requisição.

errorsErroItemApiResponse[]

Ver propriedades

codestring

Código estável do erro

exemplo: field_validation_error

fieldstring

Campo relacionado

exemplo: agenda.titulo

messagestring

Mensagem segura

exemplo: não deve estar em branco

instancestring

exemplo: /v2/agenda

requestIdstring

exemplo: e9db6635-7db3-40cb-8dd2-453c25e6a461

statusinteger

formato: int32exemplo: 400

titlestring

exemplo: Erro de validação

typestring

formato: uriexemplo: /errors/validation-error

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

codestring

exemplo: validation_error

correlationIdstring

exemplo: c4ce7307-1917-4539-b17a-9c73c972c261

detailstring

exemplo: Existem campos inválidos na requisição.

errorsErroItemApiResponse[]

Ver propriedades

codestring

Código estável do erro

exemplo: field_validation_error

fieldstring

Campo relacionado

exemplo: agenda.titulo

messagestring

Mensagem segura

exemplo: não deve estar em branco

instancestring

exemplo: /v2/agenda

requestIdstring

exemplo: e9db6635-7db3-40cb-8dd2-453c25e6a461

statusinteger

formato: int32exemplo: 400

titlestring

exemplo: Erro de validação

typestring

formato: uriexemplo: /errors/validation-error

curl --request POST \
  --url 'https://api.expedit.com.br/v2/publicacoes/relatorios/export' \
  --header 'Accept: application/json' \
  --header 'X-API-Key: SUA_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "campos": [],
  "filtros": {}
}'

Requisição e resposta

As chamadas são enviadas diretamente à API. O domínio deste portal precisa estar autorizado no CORS.

Ver JSON gerado

Corpo gerado dos campos

{
  "campos": [],
  "filtros": {}
}

A resposta aparecerá aquiPreencha os campos e envie a requisição para consultar o retorno da API.

Explorar exemplos de resposta

Exemplos ilustrativos · nenhuma requisição é enviada

Cenário

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 ilustrativo gerado do schema · application/pdf

Exemplo · HTTP 200

{}

Exemplos e campos gerados do contrato OpenAPI. Revise os valores antes de integrar.