Baixar documento do protocolo

Permite baixar um documento do protocolo vinculado ao escritório, redirecionando para um link temporário do arquivo.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Dicionário para propriedades enviadas

fileId

Id do arquivo, informado em fileId na listagem de documentos do protocolo. Vale só para documentos do tipo 1 - Arquivo; link e recálculo não passam por esta rota.


forceDownload

  • false - o arquivo é exibido no navegador quando o formato permite (padrão)
  • true - o arquivo é baixado

Comportamento

  • A rota responde 302 com o header Location apontando para um link temporário do arquivo. Para um novo link, chame a rota de novo.
  • Envie a mesma autenticação das demais rotas.
  • O arquivo só é liberado se estiver na listagem de documentos do protocolo, com as mesmas permissões de escritório, cliente e departamento.
Path Params
string
required

Id do escritório.

string
required

Id do cliente.

string
required

Id do protocolo.

string
required

Id do arquivo, informado na listagem de documentos do protocolo.

Query Params
boolean
Defaults to false

Quando true, o arquivo é baixado em vez de exibido no navegador. Padrão: false.

Headers
string

Requer autenticação via API Key no header da requisição. Exemplo: X-API-Key: Sua chave.

string

Requer autenticação via Id do usuário no header da requisição. Exemplo: X-User-Id: Id do usuário.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*
application/json