Condicionais do alarme

Listar

Endpoint que lista todas as condicionais de um alarme.

Method URI Headers Authorization
GET /api/v4/alarms-conditionals Content-Type:application/json Authorization: Bearer token

Parameters

_sort: id (string) ("id") - "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."
alarm_id: 1 (integer, required) - "Filtra condicionais pelo ID do alarme."
alarm_stage_id: 1 (integer) - "Filtra condicionais pelo ID do estágio de alarme."
Copy


Response

Response 200 (application/json)

{
  "items": [
    {
        "id": 1,
        "alarm_stage_id": 1,
        "value": 3.6,
        "alarm": {
            "id": 1,
            "name": "Falha de energia"
        },
        "rule": {
            "id": 2,
            "name": "Propriedade"
        },
        "operator": {
            "id": 3,
            "name": "Menor"
        },
        "property": {
            "id": 10,
            "name": "active",
            "type": "float"
        },
        "processed": null
    },
    {
        "id": 2,
        "alarm_stage_id": 2,
        "value": 3.6,
        "alarm": {
            "id": 2,
            "name": "Consumo de energia"
        },
        "rule": {
            "id": 4,
            "name": "Consumo"
        },
        "operator": {
            "id": 2,
            "name": "Maior ou igual"
        },
        "property": null,
        "processed": {
            "id": 1,
            "name": "Consumo energia"
        }
    }
  ],
  "total": 2,
  "per_page": 10,
  "current_page": 1
}
Copy

Response 204 (application/json)

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

Response 422 (application/json)

{
    "alarm_id": [
        "O campo alarm id selecionado é inválido."
    ],
    "alarm_stage_id": [
        "O campo alarm stage id selecionado é inválido."
    ]
}
Copy

Pegar

Endpoint que pega uma condicional de alarme.

Method URI Headers Authorization
GET /api/v4/alarms-conditionals/{alarmConditionalId} Content-Type:application/json Authorization: Bearer token

Parameters

alarmConditionalId: 1 - (integer, required) - "Id da condicional de um alarme."
Copy

Response

Response 200 (application/json)

{
    "id": 1,
    "alarm_stage_id": 1,
    "value": 3.6,
    "alarm": {
        "id": 1,
        "name": "Falha de energia"
    },
    "rule": {
        "id": 2,
        "name": "Propriedade"
    },
    "operator": {
        "id": 3,
        "name": "Menor"
    },
    "property": {
        "id": 10,
        "name": "active",
        "type": "float"
    },
    "processed": null
}
Copy

Response 400 (application/json)

Quando ocorre algum erro.

Criar

Endpoint que cria uma condicional de alarme.

Method URI Headers Authorization
POST /api/v4/alarms-conditionals Content-Type:application/json Authorization: Bearer token

Attributes

alarm_id: 1 (integer, required) - "ID do alarme."
alarm_rule_id: 2 (integer, required) - "ID da regra do alarme."
alarm_stage_id: 1 (integer, required) - "ID do estágio do alarme."
operator_logic_id: 3 (integer, required) - "ID do operador lógico."
value: 3.6 (string|float|bool, required) - "Valor referência para executar o estágio do alarme."
property_id: 10 (integer) - "ID da propriedade a ser monitorada no alarme."
processed_id: 1 (integer) - "ID do dado processado a ser monitorada no alarme."
Copy

O tipo do campo value varia de acordo com a regra escolhida.
É permitido o envio apenas de um dos campos (property_id, processed_id)

Response

Response 201 (application/json)

{
    "id": 1,
    "alarm_stage_id": 1,
    "value": 3.6,
    "alarm": {
        "id": 1,
        "name": "Falha de energia"
    },
    "rule": {
        "id": 2,
        "name": "Propriedade"
    },
    "operator": {
        "id": 3,
        "name": "Menor"
    },
    "property": {
        "id": 10,
        "name": "active",
        "type": "float"
    },
    "processed": null
}
Copy

Response 422 (application/json)

{
    "alarm_id": [
        "Os campos (alarm_id, alarm_rule_id, alarm_stage_id, operator_logic_id e property_id) já estão sendo utilizados"
    ],
    "operator_logic_id": [
        "Dados insuficientes para validação do operador lógico",
        "Combinação do operador lógico não é permitida"
    ]
}
Copy

Response 400 (application/json)

Quando ocorre algum erro.

Atualizar

Endpoint que atualiza uma condicional de alarme.

Method URI Headers Authorization
PUT /api/v4/alarms-conditionals/{alarmConditionalId} Content-Type:application/json Authorization: Bearer token

Attributes

alarm_id: 1 (integer, required) - "ID do alarme."
alarm_rule_id: 2 (integer, required) - "ID da regra do alarme."
alarm_stage_id: 1 (integer, required) - "ID do estágio do alarme."
operator_logic_id: 3 (integer, required) - "ID do operador lógico."
value: 3.6 (string|float|bool, required) - "Valor referência para executar o estágio do alarme."
property_id: 10 (integer) - "ID da propriedade a ser monitorada no alarme."
processed_id: 1 (integer) - "ID do dado processado a ser monitorada no alarme."
Copy

O tipo do campo value varia de acordo com a regra escolhida.
É permitido o envio apenas de um dos campos (property_id, processed_id)

Response

Response 200 (application/json)

{
    "id": 1,
    "alarm_stage_id": 1,
    "value": 3.6,
    "alarm": {
        "id": 1,
        "name": "Falha de energia"
    },
    "rule": {
        "id": 2,
        "name": "Propriedade"
    },
    "operator": {
        "id": 3,
        "name": "Menor"
    },
    "property": {
        "id": 10,
        "name": "active",
        "type": "float"
    },
    "processed": null
}
Copy

Response 400 (application/json)

Quando ocorre algum erro.

Deletar

Endpoint que deleta uma condicional de alarme.

Method URI Headers Authorization
DELETE /api/v4/alarms-conditionals/{alarmConditionalId} Content-Type:application/json Authorization: Bearer token


Response

Response 204 (application/json)

Quando o registro for excluido com sucesso.

Response 400 (application/json)

Quando ocorre algum erro.