Arquivos do bem
Documentos ligados ao bem, como notas fiscais e manuais. Corresponde à aba Arquivos da página do bem, na tela Patrimônios. Cada arquivo tem descrição.
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
| GET | /equity-controls/assets/{equipment_uuid}/files | Lista os arquivos do bem |
| POST | /equity-controls/assets/{equipment_uuid}/files | Envia um arquivo |
| GET | /equity-controls/assets/{equipment_uuid}/files/{id} | Abre o arquivo (download) |
| POST | /equity-controls/assets/{equipment_uuid}/files/{id} | Altera a descrição, a validade ou o arquivo |
| DELETE | /equity-controls/assets/{equipment_uuid}/files/{id} | Apaga o arquivo |
| GET | /equity-controls/assets/{equipment_uuid}/show-file/{id} | Abre o arquivo (download) |
O parâmetro equipment_uuid é o uuid do bem.
GET /equity-controls/assets/{equipment_uuid}/files
Lista os arquivos do bem.
Parâmetros de URL
| Parâmetro | Descrição |
|---|---|
| search | Texto para buscar pela descrição do arquivo, pela descrição do bem ou pelo grupo |
| obsolete | true ou false. Filtra os arquivos obsoletos ou não obsoletos |
| start_date | Data inicial (AAAA-MM-DD) do intervalo de vencimento |
| end_date | Data final (AAAA-MM-DD) do intervalo de vencimento. Sem start_date, inclui os arquivos sem vencimento |
| per_page | Quantidade de registros por página. Com ele, a resposta é paginada |
| page | Número da página, quando per_page é informado |
Resposta (200): lista de arquivos com id, description, expiration_date,
obsolete, upload (dados do arquivo guardado), equipment_name, group_name e
os nomes de quem criou e de quem alterou por último.
POST /equity-controls/assets/{equipment_uuid}/files
Envia um arquivo. A requisição é multipart/form-data.
Corpo
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| file | Sim | Arquivo | Arquivo a enviar |
| description | Sim | Texto | Descrição do arquivo |
| expiration_date | Não | Data (AAAA-MM-DD) | Data de vencimento do documento |
Resposta (201): o registro do arquivo criado.
POST /equity-controls/assets/{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
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| file | Não | Arquivo | Novo arquivo, que substitui o anterior |
| description | Sim | Texto | Descrição do arquivo |
| expiration_date | Não | Data (AAAA-MM-DD) | Data de vencimento do documento |
Resposta (200): o registro alterado.
GET /equity-controls/assets/{equipment_uuid}/files/{id}
Abre o arquivo para download, com o nome original. Quando não há arquivo anexado, a resposta vem sem conteúdo (204).
GET /equity-controls/assets/{equipment_uuid}/show-file/{id}
Mesma resposta de GET /equity-controls/assets/{equipment_uuid}/files/{id}: abre o
arquivo para download.
DELETE /equity-controls/assets/{equipment_uuid}/files/{id}
Apaga o arquivo (exclusão lógica), e o arquivo guardado é removido. Resposta (200): lista de arquivos da empresa cliente.