Alarmes de Equipamento

• Listar
• Pegar
• Criar
• Atualizar
• Remover

Listar

Endpoint que lista todos os alarmes cadastrados.

Parameters

equipmentId: 1 (integer, required) - "ID do Equipamento"
perPage: 10 (integer) - "Quantidade de itens por página."
pageNumber: 1 (integer) - "Página a ser carregada."

Response

{success} Response 200 (application/json)

{
    "data": [
        {
            "id": 1,
            "entities":[1, 2],
            "rule_id": 3,
            "rule_name": "Meta Consumo Equipamento",
            "name": "Alarme meta de consumo",
            "operator_trigger_id": 1,
            "operator_trigger_name": ">",
            "value_trigger": "100",
            "operator_normalized_id": 3,
            "operator_normalized_name": "<",
            "value_normalized": "100",
            "frequency_notify": "daily",
            "status": 1,
            "emails":[
                "zordon@zordon.com.br"
            ],
            "notify_method": "zordon"
        }
    ],
    "per_page": 10,
    "current_page": 1,
    "total": 1
}

{primary} Response 204 (application/json).

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

Pegar

Endpoint que pega um alarme específico.

Parameters

alarmId: 1 (integer, required) - "ID do Alarme"

Response

{success} Response 200 (application/json)

{
    "id": 1,
    "entities": [
        1,
        2
    ],
    "rule_id": 3,
    "rule_name": "Meta Consumo Equipamento",
    "name": "Alarme meta de consumo",
    "operator_trigger_id": 1,
    "operator_trigger_name": ">",
    "value_trigger": "100",
    "operator_normalized_id": 3,
    "operator_normalized_name": "<",
    "value_normalized": "100",
    "frequency_notify": "daily",
    "status": 1,
    "emails": [
        "zordon@zordon.com.br"
    ],
    "notify_method": "zordon"
}

{primary} Response 204 (application/json)

Quando o registro não existir ou o usuário não tiver permissão de visualização.

Criar

Endpoint que cria um alarme.

Attributes

entities: [1,2] (array, required) - "Ids dos equipamentos"
rule_id: 1 (integer, required) - "Id da regra de alarme (deve ser uma regra do grupo de equipamento)."
name: "Alarme 1" (string, required) - "Nome do alarme."
operator_trigger_id: 1 (integer, required) - "Id da operação lógica para acionar o alarme."
value_trigger: 100 (string, required) - "Valor para acionar o alarme."
operator_normalized_id: 1 (integer, required) - "Id da operação lógica para normalizar o alarme."
value_normalized: 100 (string, required) - "Valor para normalizar o alarme."
frequency_notify: always (string, required) - "Frequência de notificação dos eventos de alarmes.
Ex: always, fifteen, hourly, daily, weekly, monthly, yearly."
status: true (boolean, required) - "Status do alarme."
emails: ["zordon@zordon.com.br"] (array, required) - "E-mail para notificação do eventos de alarme."
notify_method: 'zordon' (string) - "Método de notificação dos alarmes. Default: zordon. Opções: powerview."

{info} O tipo dos campos value_trigger e value_normalized pode variar de acordo com a regra do alarme e pode ser obtido no endpoint de regras

Response

{success} Response 201 (application/json)

{
    "id": 1,
    "entities": [
        1,
        2
    ],
    "rule_id": 3,
    "rule_name": "Meta Consumo Equipamento",
    "name": "Meta Consumo Equipamento",
    "operator_trigger_id": 1,
    "operator_trigger_name": ">",
    "value_trigger": 100,
    "operator_normalized_id": 3,
    "operator_normalized_name": "<",
    "value_normalized": 100,
    "frequency_notify": "daily",
    "status": true,
    "emails": [
        "zordon@zordon.com.br"
    ],
    "notify_method": "zordon"
}

{primary} Response 204 (application/json)

Quando o registro não existir ou o usuário não tiver permissão de visualização.

Atualizar

Endpoint que atualiza um alarme específico.

{danger.fa-close} Importante: Quando não enviado o e-mail na atualização do alarme, a API excluirá os e-mails cadastrado neste alarme.

Parameters

alarmId: 1 (integer, required) - "ID do Alarme"

Attributes

entities: [1,2] (array, required) - "Ids dos equipamentos"
rule_id: 1 (integer, required) - "Id da regra de alarme (deve ser uma regra do grupo de equipamento)."
name: "Alarme 1" (string, required) - "Nome do alarme."
operator_trigger_id: 1 (integer, required) - "Id da operação lógica para acionar o alarme."
value_trigger: 100 (string, required) - "Valor para acionar o alarme."
operator_normalized_id: 1 (integer, required) - "Id da operação lógica para normalizar o alarme."
value_normalized: 100 (string, required) - "Valor para normalizar o alarme."
frequency_notify: always (string, required) - "Frequência de notificação dos eventos de alarmes.
Ex: always, fifteen, hourly, daily, weekly, monthly, yearly."
status: true (boolean, required) - "Status do alarme."
emails: ["zordon@zordon.com.br"] (array) - "E-mail para notificação do eventos de alarme."
notify_method: 'zordon' (string) - "Método de notificação dos alarmes. Default: zordon. Opções: powerview."

{info} O tipo dos campos value_trigger e value_normalized pode variar de acordo com a regra do alarme e pode ser obtido no endpoint de regras

Response

{success} Response 200 (application/json)

{
    "id": 1,
    "entities": [
        1,
        2
    ],
    "rule_id": 3,
    "rule_name": "Meta Consumo Equipamento",
    "name": "Meta Consumo Equipamento",
    "operator_trigger_id": 1,
    "operator_trigger_name": ">",
    "value_trigger": 100,
    "operator_normalized_id": 3,
    "operator_normalized_name": "<",
    "value_normalized": 100,
    "frequency_notify": "daily",
    "status": true,
    "emails": [
        "zordon@zordon.com.br"
    ],
    "notify_method": "zordon"
}

{primary} Response 204 (application/json)

Quando o registro não existir ou o usuário não tiver permissão de visualização.

Deletar

Endpoint que deleta um alarme específico.

Parameters

alarmId: 1 (integer, required) - "ID do Alarme"

Response

{primary} Response 204 (application/json)

Quando o registro for excluído com sucesso.