Histórico

• Listar
• Reconhecer

Listar

Endpoint que lista o histórico de acionamento de alarmes.

Parameters

_sort: id (string) ("id", "triggered_at", "normalized_at", "status") - "Define o campo de ordenação da lista."
_order: desc (string) ("asc", "desc") - "Define a ordem da lista com base no campo definido."
_limit: 10 (integer) - "Quantidade de itens por página."
_page: 1 (integer) - "Página a ser carregada."
status: 1 (string) - "Filtra histórico pelo status, Opções: alarm, normalized."
alarm_id: 1 (integer) - "Filtra histórico pelo ID do alarme."
equipment_id: 1 (integer) - "Filtra histórico pelo ID do equipamento."
company_id: 1 (integer) - "Filtra histórico pelo ID da empresa."

{info} Filtro de entidades é permitido apenas para uma das opções (equipamento ou empresa). Se a requisição não tiver filtro de entidade, será listado o histórico dos equipamentos e empresas que o usuário tiver permissão.

Response

{success} Response 200 (application/json)

{
  "items": [
    {
        "id": 1,
        "alarm":{
            "id": 1,
            "name": "Alarme de Equipamento Desconectado"
        },
        "company":{
            "id": 1,
            "name": "Nome da empresa"
        },
        "equipment":{
            "id": 1,
            "name": "Nome do equipamento"
        },
        "triggered_at": "2023-04-19 15:36:40",
        "triggered_values": "1",
        "normalized_at": "2023-04-19 15:59:42",
        "normalized_values": "0",
        "status": "normalized",
        "action_support": {
          "device_status_after_trigger": 2,
          "device_status_after_normalize": 1
        }
    },
    {
        "id": 2,
        "alarm":{
            "id": 2,
            "name": "Alarme de Demanda Empresa"
        },
        "company":{
            "id": 1,
            "name": "Nome da empresa",
        },
        "triggered_at": "2023-04-19 15:36:40",
        "triggered_values": "10",
        "normalized_at": "2023-04-19 15:59:42",
        "normalized_values": "5",
        "status": "normalized",
        "action_support": null
    }
  ],
  "total": 2,
  "per_page": 10,
  "current_page": 1
}

{primary} Response 204 (application/json)

Quando os critérios de parâmetros não contiver registros a serem retornados.

{warning} Response 422 (application/json)

{
    "equipment_id": [
        "Permissões insuficientes para essa conta.",
        "O campo equipment id não pode ser utilizado com o campo company_id."
    ],
    "company_id": [
        "Permissões insuficientes para essa conta.",
        "O campo empresa não pode ser utilizado com o campo equipment_id."
    ]
}

Reconhecer alarme

Endpoint que reconhece o acionamento de um alarme.

Response

{success} Response 200 (application/json)

{warning} Response 422 (application/json)

{
    ["Acionamento já foi normalizado"]
}