Equipamentos
Equipamentos são os bens operacionais da empresa que precisam de inspeção. Cada equipamento pertence a um grupo e recebe as inspeções obrigatórias desse grupo. Corresponde à tela Equipamentos, do módulo Gestão de equipamentos. Os arquivos ficam em Arquivos do equipamento, e as inspeções do equipamento em Inspeções do equipamento.
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
| GET | /equipment-management/equipments | Lista os equipamentos |
| POST | /equipment-management/equipments | Cadastra um equipamento |
| GET | /equipment-management/equipments/groups | Lista os grupos para o campo Grupo |
| GET | /equipment-management/equipments/{uuid} | Consulta um equipamento |
| PUT | /equipment-management/equipments/{uuid} | Altera um equipamento |
| DELETE | /equipment-management/equipments/{uuid} | Apaga um equipamento |
GET /equipment-management/equipments
Lista os equipamentos da empresa cliente, ordenados pelo grupo e pela descrição.
Parâmetros de URL
| Parâmetro | Descrição |
|---|---|
| search | Texto para buscar pela descrição, pelo número de série, pelo fabricante, pela localização, pelo ano de fabricação ou pelo nome do grupo |
| group_id | Lista somente os equipamentos do grupo de id informado |
| not_equipment_id | Exclui o equipamento de id informado |
| 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 equipamentos com os campos do cadastro, group_name
(grupo), equipment_type, status_name (status), expiration_date (data de
validade) e os nomes de quem criou e de quem alterou por último.
POST /equipment-management/equipments
Cadastra um equipamento. Se já existir um cadastro do mesmo tipo com o mesmo número de série, esse cadastro é atualizado com os dados enviados (e reativado, se estiver excluído), em vez de criar outro. Ao ser cadastrado, o equipamento recebe as inspeções vinculadas ao grupo.
Corpo
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| group_id | Sim | Número inteiro | id do grupo, obtido em GET /equipment-management/equipments/groups |
| details | Sim | Texto | Descrição do equipamento |
| serial_number | Sim | Texto | Número de série |
| manufacturer | Não | Texto | Nome do fabricante |
| manufacturer_code | Não | Texto | Código do equipamento no fabricante |
| batch | Não | Texto | Número do lote |
| year_of_manufacture | Não | Número inteiro | Ano de fabricação |
| dimensions | Não | Texto | Dimensões do equipamento |
| weight | Não | Número | Peso |
| cost_price | Não | Número | Valor de custo |
| cost_daily | Não | Número | Valor da diária, quando o equipamento é locado |
| quantity | Não | Número | Quantidade de unidades |
| location | Não | Texto | Localização do equipamento |
| purchase_date | Não | Data (AAAA-MM-DD) | Data da compra |
| expiration_date | Não | Data (AAAA-MM-DD) | Data de validade do equipamento |
| invoice_number | Não | Texto | Número da nota fiscal de compra |
| norm | Não | Texto | Norma técnica aplicável |
| observation | Não | Texto | Observações livres |
Resposta (201): o equipamento criado, com uuid.
curl -X POST https://api.pedagogo.app/equipment-management/equipments \
-H "Authorization: Bearer <token-de-sessao>" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"group_id": 3, "details": "Empilhadeira elétrica", "serial_number": "EMP-0001"}'
Consultar, alterar e apagar
- GET /equipment-management/equipments/{uuid}: devolve o equipamento, com os dados do grupo. Resposta (200).
- PUT /equipment-management/equipments/{uuid}: altera o equipamento. Os campos do corpo são os mesmos do cadastro, todos com Não, e só os informados são alterados. Ao trocar de grupo, o equipamento passa a receber as inspeções do novo grupo. Resposta (200): o equipamento alterado.
- DELETE /equipment-management/equipments/{uuid}: apaga o equipamento
(exclusão lógica). O histórico de inspeções e de arquivos é mantido. Na tela,
a exclusão pede confirmação. Resposta (200), com corpo
null.
GET /equipment-management/equipments/groups
Lista os grupos de equipamentos, para o campo Grupo. A resposta é igual à de
GET /equipment-management/groups.