Baixar anexo

Permite baixar, de forma isolada, um anexo de uma solicitação.

O identificador do anexo é obtido no campo idsAnexo de Consultar solicitação.

Junto da requisição é possível enviar metadados de livre preenchimento. Eles são gravados na auditoria de acesso da API, permitindo identificar quem acessou cada anexo e em que contexto.

cuidado

Diferente dos demais endpoints, a resposta deste endpoint é o conteúdo binário do arquivo, e não um JSON. O JSON só é retornado em caso de erro.

Endpoints

Método	URL
POST	https://{{url}}/cube/api/v3/anexos

Exemplo de Corpo JSON

{
	"idAnexo": "06/2026/YzY4OTkxMTU1YjYwNTE4NjY0MzVmNGQ5NjQzODlhMmE6Og.jpg",
	"metadados": {
		"quemAcessou": "Sr. Cabeça",
		"documento": "12345678900",
		"delegacia": "1ª DP Centro"
	}
}

Chave	Descrição
idAnexo*	Texto - Identificador do anexo, obtido em idsAnexo na consulta da solicitação.
metadados	Objeto - Estrutura livre. Todas as chaves enviadas são gravadas na auditoria de acesso.

dica

Os campos marcados com * são obrigatórios.

O objeto metadados não possui formato fixo: envie as chaves que fizerem sentido para a sua operação. O exemplo acima usa quemAcessou, documento e delegacia, mas qualquer conjunto de chaves é aceito.

Respostas

Em caso de sucesso, o corpo da resposta é o arquivo.

Exemplo de corpo da resposta em caso de erro

{
	"status": "erro.anexo.nao.encontrado"
}

Status da resposta

Status	status	Descrição
200	-	OK - Retorna o conteúdo do arquivo.
400	erro.id.anexo.invalido	O campo idAnexo não foi informado ou é inválido.
404	erro.anexo.nao.encontrado	Não existe arquivo para o idAnexo informado.
502	erro.buscar.anexo	Falha ao recuperar o arquivo do servidor de arquivos.

Permissões necessárias

Este endpoint não exige uma permissão específica. O idAnexo é obtido na consulta da solicitação, que exige a permissão abaixo.

Permissão	Descrição
resolucao:solicitacoes:visualizar	Permite que solicitações sejam visualizadas via API.