Pular para o conteúdo principal

Grupos

Grupos são as categorias de equipamentos, por exemplo "Empilhadeiras" ou "Extintores". Cada equipamento pertence a um grupo, e é no grupo que se vinculam as inspeções obrigatórias. Corresponde à tela Grupos, do módulo Gestão de equipamentos. As inspeções vinculadas ao grupo estão em Inspeções do grupo.

Endpoints​

MétodoCaminhoDescrição
GET/equipment-management/groupsLista os grupos
POST/equipment-management/groupsCadastra um grupo
GET/equipment-management/groups/{id}Consulta um grupo
PUT/equipment-management/groups/{id}Altera um grupo
DELETE/equipment-management/groups/{id}Apaga um grupo

GET /equipment-management/groups​

Lista os grupos da empresa cliente, ordenados pelo nome.

Parâmetros de URL

ParâmetroDescrição
searchTexto para buscar pelo nome do 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 grupos com id, group, type, updated_at e os nomes de quem criou e de quem alterou por último.

POST /equipment-management/groups​

Cadastra um grupo.

Corpo

CampoObrigatórioTipoDescrição
groupSimTextoNome do grupo

Resposta (201): o grupo criado, com id e group.

curl -X POST https://api.pedagogo.app/equipment-management/groups \
-H "Authorization: Bearer <token-de-sessao>" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"group": "Empilhadeiras"}'

Consultar, alterar e apagar​

  • GET /equipment-management/groups/{id}: devolve o grupo.
  • PUT /equipment-management/groups/{id}: altera o grupo. Corpo: group (Sim, texto). Resposta (200): o grupo alterado.
  • DELETE /equipment-management/groups/{id}: apaga o grupo (exclusão lógica). Resposta (200): lista de grupos da empresa cliente.

Endpoints​

Consulte também, em Equipamentos, a listagem de grupos usada no campo Grupo do equipamento (GET /equipment-management/equipments/groups).