Notificações

Listar

Endpoint que lista todas as configurações de notificações.

Method URI Headers Authorization
GET /api/v4/alarms-notifications 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 por ID do alarme."
frequency_id: 1 (integer) - "Filtra por ID da frequência de notificação."
alarm_notification_channel_id: 1 (integer) - "Filtra por ID do canal de notificação."


Response

{success} Response 200 (application/json)

{
  "items": [
    {
        "id": 1,
        "alarm":{
            "id": 1,
            "name": "Equipamento Desconectado"
        },
        "channel":{
            "id": 1,
            "name": "E-mail"
        },
        "frequency": {
            "id": 1,
            "name": "realtime"
        },
        "user": {
            "id": 1,
            "name": "Name"
        },
        "configs":[
            "email1@email.com",
            "email2@email.com"
        ]
    }
  ],
  "total": 1,
  "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 400 (application/json)

Quando ocorre algum erro.

Pegar

Endpoint que pega a configuração de uma notificação.

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

Parameters

notificationId: 1 - (integer, required) - "Id da configuração de uma notificação."

Response

{success} Response 200 (application/json)

{
    "id": 1,
    "alarm":{
        "id": 1,
        "name": "Equipamento Desconectado"
    },
    "channel":{
        "id": 1,
        "name": "E-mail"
    },
    "frequency": {
        "id": 1,
        "name": "realtime"
    },
    "user": {
        "id": 1,
        "name": "Name"
    },
    "configs":[
        "email1@email.com",
        "email2@email.com"
    ]
}

{warning} Response 400 (application/json)

Quando ocorre algum erro.

Criar

Endpoint que cria a configuração de uma notificação.

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

Attributes

alarm_id: 1 (integer, required) - "ID do alarme"
alarm_notification_channel_id: 1 (integer, required) - "ID do canal de notificação."
user_id: 10 (integer, required) - "ID do usuário dono da configuração de notificação."
frequency_id: 2 (integer, required) - "ID da frequência de envio da notificação."
configs: ["email@email.com"] (array, required) - "E-mails a serem notificados."
restore: 1 (bool) - "Restaurar uma configuração igual que esteja excluída"


Response

{success} Response 201 (application/json)

{
    "id": 1,
    "alarm":{
        "id": 1,
        "name": "Equipamento Desconectado"
    },
    "channel":{
        "id": 1,
        "name": "E-mail"
    },
    "frequency": {
        "id": 2,
        "name": "hourly"
    },
    "user": {
        "id": 1,
        "name": "Name"
    },
    "configs":[
        "email1@email.com",
        "email2@email.com"
    ]
}

{warning} Response 422 (application/json)

{
    "alarm_id": [
        "Os campos (alarm_id, alarm_notification_channel_id, user_id e frequency_id) já estão sendo utilizados"
    ],
    "alarm_deleted": [
        "Configuração de notificação foi utilizada em um registro excluído"
    ]
}

{warning} Response 400 (application/json)

Quando ocorre algum erro.

Atualizar

Endpoint que atualiza a configuração de uma notificação.

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

Attributes

alarm_id: 1 (integer, required) - "ID do alarme"
alarm_notification_channel_id: 1 (integer, required) - "ID do canal de notificação."
user_id: 10 (integer, required) - "ID do usuário dono da configuração de notificação."
frequency_id: 2 (integer, required) - "ID da frequência de envio da notificação."
configs: ["email@email.com"] (array) - "E-mails a serem notificados."


Response

{success} Response 200 (application/json)

{
    "id": 1,
    "alarm":{
        "id": 1,
        "name": "Equipamento Desconectado"
    },
    "channel":{
        "id": 1,
        "name": "E-mail"
    },
    "frequency": {
        "id": 2,
        "name": "hourly"
    },
    "user": {
        "id": 1,
        "name": "Name"
    },
    "configs":[
        "email1@email.com",
        "email2@email.com"
    ]
}

{warning} Response 422 (application/json)

{
    "alarm_id": [
        "Os campos (alarm_id, alarm_notification_channel_id, user_id e frequency_id) já estão sendo utilizados"
    ],
    "alarm_deleted": [
        "Configuração de notificação foi utilizada em um registro excluído"
    ]
}

{warning} Response 400 (application/json)

Quando ocorre algum erro.

Deletar

Endpoint que deleta a configuração de uma notificação.

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


Response

{primary} Response 204 (application/json)

Quando o registro for excluido com sucesso.

{warning} Response 400 (application/json)

Quando ocorre algum erro.