11.6. Inserir Documento a uma Contratação
Serviço que permite inserir/anexar um documento/arquivo a uma Contratação. O sistema permite o upload de arquivos com as extensões listadas na seção: Tabelas de domínio - Extensões de arquivo aceitos pelas APIs de Documento.
11.6.1. Detalhes da Requisição
Endpoint |
Método HTTP |
|---|---|
/v1/orgaos/{cnpj}/compras/{ano}/{sequencial}/arquivos |
POST |
11.6.1.1. Exemplo de Payload
1 Não de aplica
11.6.2. Exemplo Requisição (cURL)
1 curl -k -X POST \
2 --header "Authorization: Bearer access_token" \
3 "${BASE_URL}/v1/orgaos/10000000000003/compras/2021/1/arquivos" \
4 -H "accept: */*" \
5 -H "Titulo-Documento: Edital-2021-1" \
6 -H "Tipo-Documento-Id: 2" \
7 -F "arquivo=@Edital-2021-1.pdf;type=application/pdf"
11.6.3. Dados de Entrada
Nota
Alimentar os parâmetros cnpj, ano e sequencial na URL.
Id |
Campo |
Tipo |
Obrigatório |
Descrição |
|---|---|---|---|---|
1 |
cnpj |
Texto (14) |
Sim |
Cnpj do órgão originário da contratação informado na inclusão (proprietário da contratação ou alienação de bens) |
2 |
ano |
Inteiro |
Sim |
Ano da contratação |
3 |
sequencial |
Inteiro |
Sim |
Sequencial da Contratação no PNCP; Número sequencial gerado no momento que a contratação foi inserida no PNCP; |
4 |
tituloDocumento |
Texto (255) |
Sim |
Título do documento |
5 |
tipoDocumentoId |
Inteiro |
Sim |
Código da tabela de domínio Tipo de documento |
6 |
arquivo |
Binário |
Sim |
String binária do arquivo |
11.6.4. Dados de Retorno
Id |
Campo |
Tipo |
Descrição |
|---|---|---|---|
1 |
location |
Texto (255) |
Endereço HTTP do recurso criado |
11.6.5. Exemplo de Retorno
1 Retorno:
2 access-control-allow-credentials: true
3 access-control-allow-headers: Content-Type,Authorization,X-Requested-With,Content-Length,Accept,Origin,
4 access-control-allow-methods: GET,PUT,POST,DELETE,OPTIONS
5 access-control-allow-origin: *
6 cache-control: no-cache,no-store,max-age=0,must-revalidate
7 content-length: 0
8 date: ?
9 expires: 0
10 location: https://treina.pncp.gov.br/api/pncp/v1/orgaos/10000000000003/compras/2021/1/arquivos/1
11 nome-bucket: ?
12 pragma: no-cache
13 strict-transport-security: max-age=?
14 x-content-type-options: nosniff
15 x-firefox-spdy: ?
16 x-frame-options: DENY
17 x-xss-protection: 1; mode=block
11.6.6. Códigos de Retorno
Código HTTP |
Mensagem |
Tipo |
|---|---|---|
201 |
Created |
Sucesso |
400 |
BadRequest |
Erro |
422 |
Unprocessable Entity |
Erro |
500 |
Internal Server Error |
Erro |