Regras

• Listar

Listar

Endpoint que lista todas as regras de alarme.

Parameters

_sort: id (string) ("id", "name", "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 (bool) - "Filtra alarme pelo status."
alarms_rules_type_id: 1 (integer) - "Filtra regras pelo ID do tipo de regra."
data_entity_id: 1 (integer) - "Filtra regras pelo ID do tipo de entidade que a regra se aplica."

Response

{success} Response 200 (application/json)

{
  "items": [
    {
        "id": 1,
        "alarms_rules_type_id": 1,
        "rule_type": {
            "required_property": false,
            "required_processed": false
        },
        "name": "Equipamento Desconectado",
        "description": "Regra que verifica ...",
        "backend_rules": "required|bool",
        "aggregate": "first",
        "processed_source": null,
        "status": true
    },
    {
        "id": 2,
        "alarms_rules_type_id": 2,
        "rule_type": {
            "required_property": true,
            "required_processed": false
        },
        "name": "Propriedade",
        "description": "Regra que verifica ...",
        "backend_rules": "required",
        "aggregate": "first",
        "processed_source": null,
        "status": true
    }
  ],
  "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)

{
    "alarms_rules_type_id": [
        "O campo alarms rules type id selecionado é inválido."
    ]
}