Pular para o conteúdo principal

Arquivos do insumo

Documentos ligados ao insumo, como fichas técnicas e certificados. Corresponde à aba Arquivos da página do insumo, na tela Insumos. Cada arquivo tem descrição.

Endpoints​

MétodoCaminhoDescrição
GET/warehouse/supplies/{equipment_uuid}/filesLista os arquivos do insumo
POST/warehouse/supplies/{equipment_uuid}/filesEnvia um arquivo
GET/warehouse/supplies/{equipment_uuid}/files/{id}Consulta os dados de um arquivo
POST/warehouse/supplies/{equipment_uuid}/files/{id}Altera a descrição ou o arquivo
DELETE/warehouse/supplies/{equipment_uuid}/files/{id}Apaga o arquivo

O parâmetro equipment_uuid é o uuid do insumo.

GET /warehouse/supplies/{equipment_uuid}/files​

Lista os arquivos do insumo.

Parâmetros de URL

ParâmetroDescrição
searchTexto para buscar pela descrição do arquivo, pelo nome do insumo ou pelo grupo
per_pageQuantidade de registros por página. Com ele, a resposta é paginada
pageNúmero da página, quando per_page é informado

Resposta (200): lista de arquivos com id, description, upload (dados do arquivo guardado), equipment_name, group_name e os nomes de quem criou e de quem alterou por último.

POST /warehouse/supplies/{equipment_uuid}/files​

Envia um arquivo. A requisição é multipart/form-data.

Corpo

CampoObrigatórioTipoDescrição
fileSimArquivoArquivo a enviar
descriptionSimTextoDescrição do arquivo

Resposta (201): o registro do arquivo criado.

POST /warehouse/supplies/{equipment_uuid}/files/{id}​

Altera um arquivo já enviado. Envie file somente quando quiser substituir o arquivo guardado. A requisição é multipart/form-data.

Corpo

CampoObrigatórioTipoDescrição
fileNãoArquivoNovo arquivo, que substitui o anterior
descriptionSimTextoDescrição do arquivo

Resposta (200): o registro alterado.

GET /warehouse/supplies/{equipment_uuid}/files/{id}​

Devolve os dados do arquivo (id, description, upload_id, expiration_date, obsolete). Esta rota não devolve o conteúdo do arquivo. Resposta (200).

DELETE /warehouse/supplies/{equipment_uuid}/files/{id}​

Apaga o arquivo (exclusão lógica), e o arquivo guardado é removido. Resposta (200): lista de arquivos da empresa cliente.