Pular para o conteúdo principal

Inspeções

Inspeções são os modelos de inspeção da empresa: nome, validade padrão em meses e checklist de itens. Corresponde à tela Inspeções, do módulo Gestão de equipamentos. Para que a inspeção seja exigida dos equipamentos, vincule-a a um grupo (veja Grupos) ou a um equipamento (veja Inspeções do equipamento).

Os itens do checklist do modelo estão em Checklist da inspeção.

Endpoints​

MétodoCaminhoDescrição
GET/equipment-management/inspectionsLista as inspeções
POST/equipment-management/inspectionsCadastra uma inspeção
GET/equipment-management/inspections/{uuid}Consulta uma inspeção
PUT/equipment-management/inspections/{uuid}Altera uma inspeção
DELETE/equipment-management/inspections/{uuid}Apaga uma inspeção

GET /equipment-management/inspections​

Lista as inspeções da empresa cliente, ordenadas pelo nome.

Parâmetros de URL

ParâmetroDescrição
searchTexto para buscar pelo nome da inspeção
equipment_idExclui as inspeções já vinculadas ao equipamento de id informado
group_idExclui as inspeções já vinculadas ao grupo de id informado
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 inspeções com id, uuid, inspection, validity, updated_at e os nomes de quem criou e de quem alterou por último.

POST /equipment-management/inspections​

Cadastra uma inspeção.

Corpo

CampoObrigatórioTipoDescrição
inspectionSimTextoNome da inspeção
validityNãoNúmero inteiroValidade padrão, em meses. A validade é copiada para os vínculos criados a partir do modelo

Resposta (201): o registro criado, com uuid, inspection e validity.

curl -X POST https://api.pedagogo.app/equipment-management/inspections \
-H "Authorization: Bearer <token-de-sessao>" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"inspection": "Inspeção de extintores", "validity": 12}'

Consultar, alterar e apagar​

  • GET /equipment-management/inspections/{uuid}: devolve a inspeção.
  • PUT /equipment-management/inspections/{uuid}: altera a inspeção. Corpo: inspection (Sim, texto) e validity (Não, número inteiro), como no cadastro. Resposta (200): o registro alterado.
  • DELETE /equipment-management/inspections/{uuid}: apaga a inspeção (exclusão lógica). Os vínculos dela com grupos são removidos, e os equipamentos deixam de receber essa inspeção. Resposta (200), com corpo null.