Arquivos do equipamento
Documentos ligados a um equipamento, como laudos, certificados e manuais. Corresponde à aba Arquivos da página do equipamento, na tela Equipamentos. Cada arquivo tem descrição e, se necessário, data de vencimento.
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
| GET | /equipment-management/equipments/{equipment_uuid}/files | Lista os arquivos do equipamento |
| POST | /equipment-management/equipments/{equipment_uuid}/files | Envia um arquivo |
| GET | /equipment-management/equipments/{equipment_uuid}/files/{id} | Abre o arquivo (download) |
| POST | /equipment-management/equipments/{equipment_uuid}/files/{id} | Altera a descrição, a validade ou o arquivo |
| PATCH | /equipment-management/equipments/{equipment_uuid}/files/{id}/obsolete | Marca ou desmarca o arquivo como obsoleto |
| DELETE | /equipment-management/equipments/{equipment_uuid}/files/{id} | Apaga o arquivo |
GET /equipment-management/equipments/{equipment_uuid}/files
Lista os arquivos do equipamento. Por padrão, os obsoletos vêm por último.
Parâmetros de URL
| Parâmetro | Descrição |
|---|---|
| search | Texto para buscar pela descrição do arquivo, pelo grupo ou pelos dados do equipamento |
| 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, serial_number,
group_name e os nomes de quem criou e de quem alterou por último.
POST /equipment-management/equipments/{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 /equipment-management/equipments/{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 /equipment-management/equipments/{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).
PATCH /equipment-management/equipments/{equipment_uuid}/files/{id}/obsolete
Marca ou desmarca o arquivo como obsoleto: inverte o valor atual. Um arquivo
obsoleto continua guardado no equipamento. Sem corpo. Resposta (200), com corpo null.
DELETE /equipment-management/equipments/{equipment_uuid}/files/{id}
Apaga o arquivo (exclusão lógica), e o arquivo guardado é removido. Resposta (200): lista de arquivos da empresa cliente.